Class FieldArea

  • All Implemented Interfaces:
    java.io.Serializable

    public class FieldArea
    extends java.lang.Object
    implements java.io.Serializable
    A FieldArea is a group of object fields
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      FieldArea​(java.lang.String id, java.lang.String name, java.lang.String display, int position, boolean titleVisible)
      Constructor
    • Constructor Detail

      • FieldArea

        public FieldArea​(java.lang.String id,
                         java.lang.String name,
                         java.lang.String display,
                         int position,
                         boolean titleVisible)
        Constructor
    • Method Detail

      • getId

        public java.lang.String getId()
        Returns unique id of the area
      • setId

        public void setId​(java.lang.String id)
      • getName

        public java.lang.String getName()
        Returns functional name of the area
      • setName

        public void setName​(java.lang.String name)
      • getDisplay

        public java.lang.String getDisplay()
        Returns translated area title
      • getLabel

        public java.lang.String getLabel()
        Returns translated area title (alias to getDisplay)
      • setDisplay

        public void setDisplay​(java.lang.String disp)
      • setLabel

        public void setLabel​(java.lang.String disp)
      • getPosition

        public int getPosition()
        Returns area position
      • setPosition

        public void setPosition​(int p)
      • isTitleVisible

        public boolean isTitleVisible()
        Returns whether title is to be displayed or not
      • setTitleVisible

        public void setTitleVisible​(boolean b)
      • isVisible

        public boolean isVisible()
        Returns whether area is to be displayed or not
      • setVisible

        public void setVisible​(boolean b)
      • getIcon

        @Deprecated
        public java.lang.String getIcon()
        Deprecated.
        Use getIcon(g)
      • getIcon

        public java.lang.String getIcon​(Grant g)
        Get icon code
        Parameters:
        g - Grant
      • setIcon

        public void setIcon​(java.lang.String code)
      • getTabId

        public java.lang.String getTabId()
        Tab id if area belongs to a multi-tabs panel
      • getTabPos

        public int getTabPos()
      • setTab

        public void setTab​(java.lang.String tabId,
                           int pos)
      • getAreaId

        public java.lang.String getAreaId()
        UI area Id
      • setAreaId

        public void setAreaId​(java.lang.String areaId)
      • getTemplate

        public java.lang.String getTemplate()
        Area HTML template (if null, display field in one column)
      • setTemplate

        public void setTemplate​(java.lang.String template)
      • getUITemplate

        public java.lang.String getUITemplate()
        Area Front UI template
      • setUITemplate

        public void setUITemplate​(java.lang.String template)
      • addField

        public void addField​(ObjectField f)
        Adds a field to the area
        Parameters:
        f - Field to add
      • removeField

        public void removeField​(ObjectField f)
        Removes field from the area
        Parameters:
        f - Field to remove
      • removeFields

        public void removeFields()
        Removes all fields from the area
      • getField

        public ObjectField getField​(int idx)
        Gets field at specified index
        Parameters:
        idx - Index
        Returns:
        Field at specified index
      • getField

        public ObjectField getField​(int idx,
                                    boolean defaultPos)
        Gets field at specified index
        Parameters:
        idx - Index
        defaultPos - Default or reordered positions
        Returns:
        Field at specified index
      • getFields

        public java.util.List<ObjectField> getFields()
        Gets fields in reordered positions
        Returns:
        Fields in area
      • getDefaultFields

        public java.util.List<ObjectField> getDefaultFields()
        Gets initial ordered fields
        Returns:
        Fields in area
      • restoreFields

        public void restoreFields()
        Restore fields in initial positions
      • moveField

        public void moveField​(int from,
                              int to)
        Change field ordering
        Parameters:
        from - from position index
        to - to position index
      • getNbFields

        public int getNbFields()
        Returns the number of fields of the area
        Returns:
        number of fields of the area
      • load

        public static FieldArea load​(ObjectDB obj,
                                     int num)
        Load the field area definition from repository
        Parameters:
        obj - Object
        num - Area position
      • toString

        public java.lang.String toString()
        Generates basic string dump for field area (useful for debug purposes)
        Overrides:
        toString in class java.lang.Object
        Returns:
        field area as string