Package ro.sync.ecss.extensions.commons.table.properties

Class TableProperty

  • @API(type=INTERNAL,
     src=PUBLIC)
public class TableProperty
extends java.lang.Object
    Class representing a table property. It contains the name of the property, possible values, icons for the values, current set value of the property, the group that contains it, the type of GUI elements that will be used to present the property in the "Table properties" dialog.

    • Constructor Summary

      Constructors 
      Constructor Description
      TableProperty​(java.lang.String propertyName, java.lang.String propertyRenderString, java.util.List<java.lang.String> propertyValues, java.lang.String currentValue)
      Constructor.
      TableProperty​(java.lang.String propertyName, java.lang.String propertyRenderString, java.util.List<java.lang.String> propertyValues, java.lang.String currentValue, boolean isAttribute)
      Constructor.
      TableProperty​(java.lang.String propertyName, java.lang.String propertyRenderString, java.util.List<java.lang.String> propertyValues, java.lang.String currentValue, boolean isAttribute, boolean isActive)
      Constructor.
      TableProperty​(java.lang.String propertyName, java.lang.String propertyRenderString, java.util.List<java.lang.String> propertyValues, java.lang.String currentValue, java.lang.String parentGroup, GuiElements guiType, java.util.Map<java.lang.String,​java.lang.String> icons, boolean isAttribute, boolean isActive)
      Constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.String getAttributeName()
      Obtain the property name.
      java.lang.String getAttributeRenderString()
      Obtain the render string fort the property.
      java.lang.String getCurrentValue()
      Obtain the current value for the attributes.
      GuiElements getGuiType()
      Obtain the type of GUI elements which will be used to present the values for the property.
      java.util.Map<java.lang.String,​java.lang.String> getIcons()
      Obtain the icons for the property values.
      java.lang.String getOldValue()
      Obtain the old set value.
      java.lang.String getParentGroup()
      Obtain the group that includes the current property.
      java.util.List<java.lang.String> getValues()
      Obtain the property possible values.
      int hashCode()  
      boolean isActive()
      Check if the property can be edited through the properties dialog.
      boolean isAttribute()
      true if the current property represents an attribute.
      void setCurrentValue​(java.lang.String currentValue)
      Set a new current value for the property.
      void setGuiType​(GuiElements guiType)
      Set the type of GUI elements which will be used to present the values for the property.
      void setIcons​(java.util.Map<java.lang.String,​java.lang.String> icons)
      Set the icons for the property possible values.
      void setOldValue​(java.lang.String oldValue)
      Set the old value for the property.
      void setParentGroup​(java.lang.String parentGroup)
      Sets the group that includes the current property.
      void setValues​(java.util.List<java.lang.String> values)
      Sets the values for the current property.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • TableProperty

        public TableProperty​(java.lang.String propertyName,
                     java.lang.String propertyRenderString,
                     java.util.List<java.lang.String> propertyValues,
                     java.lang.String currentValue)
        Constructor.
        Parameters:
        propertyName - The qName of the current attribute.
        propertyRenderString - The string that will be presented in the SATablePropertiesCustomizerDialog. It can be different from the attribute name or it can be even the same.
        propertyValues - The list with the attribute's possible values.
        currentValue - The current of the attribute.

      • TableProperty

        public TableProperty​(java.lang.String propertyName,
                     java.lang.String propertyRenderString,
                     java.util.List<java.lang.String> propertyValues,
                     java.lang.String currentValue,
                     boolean isAttribute)
        Constructor.
        Parameters:
        propertyName - The qName of the current attribute.
        propertyRenderString - The string that will be presented in the SATablePropertiesCustomizerDialog. It can be different from the attribute name or it can be even the same.
        propertyValues - The list with the attribute's possible values.
        currentValue - The current of the attribute.
        isAttribute - true if the current property represents an attribute.

      • TableProperty

        public TableProperty​(java.lang.String propertyName,
                     java.lang.String propertyRenderString,
                     java.util.List<java.lang.String> propertyValues,
                     java.lang.String currentValue,
                     boolean isAttribute,
                     boolean isActive)
        Constructor.
        Parameters:
        propertyName - The qName of the current attribute.
        propertyRenderString - The string that will be presented in the SATablePropertiesCustomizerDialog. It can be different from the attribute name or it can be even the same.
        propertyValues - The list with the attribute's possible values.
        currentValue - The current of the attribute.
        isAttribute - true if the current property represents an attribute.
        isActive - true if the combobox corresponding to the current property is enabled, false otherwise.

      • TableProperty

        public TableProperty​(java.lang.String propertyName,
                     java.lang.String propertyRenderString,
                     java.util.List<java.lang.String> propertyValues,
                     java.lang.String currentValue,
                     java.lang.String parentGroup,
                     GuiElements guiType,
                     java.util.Map<java.lang.String,​java.lang.String> icons,
                     boolean isAttribute,
                     boolean isActive)
        Constructor.
        Parameters:
        propertyName - The qName of the current attribute.
        propertyRenderString - The string that will be presented in the SATablePropertiesCustomizerDialog. It can be different from the attribute name or it can be even the same.
        propertyValues - The list with the attribute's possible values.
        currentValue - The current of the attribute.
        parentGroup - The group name that will include the current property.
        guiType - The type of GUI element that will be used to represent the values for the current property. If is one of GuiElements.COMBOBOX, GuiElements.RADIO_BUTTONS. The default is GuiElements.COMBOBOX. If this parameter is set to null, the element that will be used is GuiElements.COMBOBOX.
        icons - The list of icons. An icon for every value. If empty icon corresponds to a value, the icon will be null
        isAttribute - true if the current property represents an attribute.
        isActive - true if the combobox corresponding to the current property is enabled, false otherwise.

    • Method Detail

      • getAttributeName

        public java.lang.String getAttributeName()
        Obtain the property name.
        Returns:
        Returns the property name.

      • getAttributeRenderString

        public java.lang.String getAttributeRenderString()
        Obtain the render string fort the property.
        Returns:
        the render string fort the property

      • getValues

        public java.util.List<java.lang.String> getValues()
        Obtain the property possible values.
        Returns:
        Returns the values.

      • getCurrentValue

        public java.lang.String getCurrentValue()
        Obtain the current value for the attributes.
        Returns:
        Returns the current value of the attribute.

      • setCurrentValue

        public void setCurrentValue​(java.lang.String currentValue)
        Set a new current value for the property.
        Parameters:
        currentValue - The new value to set.

      • getParentGroup

        public java.lang.String getParentGroup()
        Obtain the group that includes the current property.
        Returns:
        Returns the group name or null if no group contains this property.

      • setParentGroup

        public void setParentGroup​(java.lang.String parentGroup)
        Sets the group that includes the current property.
        Parameters:
        parentGroup - The group that includes the current property.

      • isAttribute

        public boolean isAttribute()
        true if the current property represents an attribute.
        Returns:
        Returns true if the property is an attribute.

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
        See Also:
        Object.equals(java.lang.Object)

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
        See Also:
        Object.toString()

      • getOldValue

        public java.lang.String getOldValue()
        Obtain the old set value.
        Returns:
        Returns the old value.

      • setOldValue

        public void setOldValue​(java.lang.String oldValue)
        Set the old value for the property. It should be correlated with setting a new value.
        Parameters:
        oldValue - The old value to set.

      • isActive

        public boolean isActive()
        Check if the property can be edited through the properties dialog.
        Returns:
        true if the combobox corresponding to the current property is enabled, false otherwise.

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
        See Also:
        Object.hashCode()

      • setValues

        public void setValues​(java.util.List<java.lang.String> values)
        Sets the values for the current property.
        Parameters:
        values - Values for the current property.

      • setGuiType

        public void setGuiType​(GuiElements guiType)
        Set the type of GUI elements which will be used to present the values for the property.
        Parameters:
        guiType - The new type GUI elements which will be used to present the values for the property.

      • getGuiType

        public GuiElements getGuiType()
        Obtain the type of GUI elements which will be used to present the values for the property.
        Returns:
        Returns the type of GUI elements which will be used to present the values for the property.

      • getIcons

        public java.util.Map<java.lang.String,​java.lang.String> getIcons()
        Obtain the icons for the property values. If the list contains null objects, then an empty icon should be used.
        Returns:
        Returns the icons for all the possible values. Every values is mapped to an icon path.

      • setIcons

        public void setIcons​(java.util.Map<java.lang.String,​java.lang.String> icons)
        Set the icons for the property possible values.
        Parameters:
        icons - The icons to set.