content: /*
   *  Licensed to the Apache Software Foundation (ASF) under one
   *  or more contributor license agreements.  See the NOTICE file
   *  distributed with this work for additional information
   *  regarding copyright ownership.  The ASF licenses this file
   *  to you under the Apache License, Version 2.0 (the
   *  "License"); you may not use this file except in compliance
   *  with the License.  You may obtain a copy of the License at
   *
   *        http://www.apache.org/licenses/LICENSE-2.0
   *
   *  Unless required by applicable law or agreed to in writing,
   *  software distributed under the License is distributed on an
   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   *  KIND, either express or implied.  See the License for the
   *  specific language governing permissions and limitations
   *  under the License.
   */
  package org.apache.causeway.applib.layout.component;
  
  import java.io.Serializable;
  import java.util.ArrayList;
  import java.util.List;
  
  import jakarta.xml.bind.annotation.XmlAttribute;
  import jakarta.xml.bind.annotation.XmlElement;
  import jakarta.xml.bind.annotation.XmlRootElement;
  import jakarta.xml.bind.annotation.XmlTransient;
  import jakarta.xml.bind.annotation.XmlType;
  
  import org.apache.causeway.applib.annotation.LabelPosition;
  import org.apache.causeway.applib.annotation.PromptStyle;
  import org.apache.causeway.applib.annotation.Repainting;
  import org.apache.causeway.applib.annotation.Where;
  import org.apache.causeway.applib.layout.links.Link;
  
  /**
   * Describes the layout of a single property, broadly corresponds to the {@link org.apache.causeway.applib.annotation.PropertyLayout} annotation.
   *
   * @since 1.x {@index}
   */
  @XmlRootElement(
          name = "property"
          )
  @XmlType(
          name = "property"
          , propOrder = {
                  "named"
                  , "describedAs"
                  , "actions"
                  , "metadataError"
                  , "link"
          }
          )
  public class PropertyLayoutData
  implements ActionLayoutDataOwner,
  Serializable,
  Owned<FieldSet>,
  HasCssClass, HasDescribedAs, HasHidden, HasNamed  {
  
      private static final long serialVersionUID = 1L;
  
      public PropertyLayoutData() {
      }
  
      public PropertyLayoutData(final String id) {
          this.id = id;
      }
  
      private String id;
  
      /**
       * Property identifier, being the getter method without 'get' or 'is' prefix, first letter lower cased.
       */
      @XmlAttribute(required = true)
      public String getId() {
          return id;
      }
  
      public void setId(final String id) {
          this.id = id;
      }
  
      private String cssClass;
  
      @Override
      @XmlAttribute(required = false)
      public String getCssClass() {
          return cssClass;
      }
  
      @Override
      public void setCssClass(final String cssClass) {
          this.cssClass = cssClass;
      }
  
      private String describedAs;
  
      @Override
      @XmlElement(required = false)
      public String getDescribedAs() {
          return describedAs;
      }
  
      @Override
      public void setDescribedAs(final String describedAs) {
          this.describedAs = describedAs;
      }
  
      private Where hidden;
  
      @Override
      @XmlAttribute(required = false)
      public Where getHidden() {
          return hidden;
      }
  
      @Override
      public void setHidden(final Where hidden) {
          this.hidden = hidden;
      }
  
      private LabelPosition labelPosition;
  
      @XmlAttribute(required = false)
      public LabelPosition getLabelPosition() {
          return labelPosition;
      }
  
      public void setLabelPosition(final LabelPosition labelPosition) {
          this.labelPosition = labelPosition;
      }
  
      private Integer multiLine;
  
      @XmlAttribute(required = false)
      public Integer getMultiLine() {
          return multiLine;
      }
  
      public void setMultiLine(final Integer multiLine) {
          this.multiLine = multiLine;
      }
  
      private String named;
  
      @Override
      @XmlElement(required = false)
      public String getNamed() {
          return named;
      }
  
      @Override
      public void setNamed(final String named) {
          this.named = named;
      }
  
      private PromptStyle promptStyle;
  
      @XmlAttribute(required = false)
      public PromptStyle getPromptStyle() {
          return promptStyle;
      }
  
      public void setPromptStyle(final PromptStyle promptStyle) {
          this.promptStyle = promptStyle;
      }
  
      private int dateRenderAdjustDays;
  
      @XmlAttribute(required = false)
      public int getDateRenderAdjustDays() {
          return dateRenderAdjustDays;
      }
  
      public void setDateRenderAdjustDays(final int dateRenderAdjustDays) {
          this.dateRenderAdjustDays = dateRenderAdjustDays;
      }
  
      private Integer typicalLength;
  
      @XmlAttribute(required = false)
      public Integer getTypicalLength() {
          return typicalLength;
      }
  
      public void setTypicalLength(final Integer typicalLength) {
          this.typicalLength = typicalLength;
      }
  
      private Repainting repainting;
  
      @XmlAttribute(required = false)
      public Repainting getRepainting() {
          return repainting;
      }
  
      public void setRepainting(final Repainting repainting) {
          this.repainting = repainting;
      }
  
      private List<ActionLayoutData> actions = new ArrayList<>();
  
      // no wrapper
      @Override
      @XmlElement(name = "action", required = false)
      public List<ActionLayoutData> getActions() {
          return actions;
      }
  
      @Override
      public void setActions(final List<ActionLayoutData> actionLayoutDatas) {
          this.actions = actionLayoutDatas;
      }
  
      private FieldSet owner;
      /**
       * Owner.
       *
       * <p>
       *     Set programmatically by framework after reading in from XML.
       * </p>
       */
      @Override
      @XmlTransient
      public FieldSet getOwner() {
          return owner;
      }
  
      public void setOwner(final FieldSet owner) {
          this.owner = owner;
      }
  
      private String metadataError;
  
      /**
       * For diagnostics; populated by the framework if and only if a metadata error.
       */
      @XmlElement(required = false)
      public String getMetadataError() {
          return metadataError;
      }
  
      public void setMetadataError(final String metadataError) {
          this.metadataError = metadataError;
      }
  
      private Link link;
  
      /**
       * The link to access this resource from the REST API (Restful Objects viewer).
       *
       * <p>
       *     Populated by the framework automatically.
       * </p>
       */
      @XmlElement(required = false)
      public Link getLink() {
          return link;
      }
  
      public void setLink(final Link link) {
          this.link = link;
      }
  
      @Override
      public String toString() {
          return "PropertyLayoutData{" +
                  "id='" + id + '\'' +
                  '}';
      }
  
  }
  