Class LiveDataPropertyDescriptor


  • public class LiveDataPropertyDescriptor
    extends Object
    Describes how the user interacts with a given property.
    Since:
    12.10
    Version:
    $Id: f9ab7848116f5ae94cc89de1d30075ab4400dd52 $
    • Constructor Detail

      • LiveDataPropertyDescriptor

        public LiveDataPropertyDescriptor()
    • Method Detail

      • getId

        public String getId()
        Returns:
        the property id
      • setId

        public void setId​(String id)
        Set the property id.
        Parameters:
        id - the new property id
      • getName

        public String getName()
        Returns:
        the property pretty name
      • setName

        public void setName​(String name)
        Sets the property pretty name.
        Parameters:
        name - the new pretty name
      • getDescription

        public String getDescription()
        Returns:
        the property description
      • setDescription

        public void setDescription​(String description)
        Sets the property description.
        Parameters:
        description - the new property description
      • getType

        public String getType()
        Returns:
        the property type
      • setType

        public void setType​(String type)
        Sets the property type.
        Parameters:
        type - the new property type
      • isSortable

        public Boolean isSortable()
        Returns:
        whether this property can be used to sort the live data or not; use null to inherit from the property type descriptor
      • setSortable

        public void setSortable​(Boolean sortable)
        Sets whether this property can be used to sort the live data.
        Parameters:
        sortable - whether this property can be used to sort the live data; pass null to inherit from the property type descriptor
      • getStyleName

        public String getStyleName()
        Returns:
        the CSS class name to add to the HTML element used to display this property
      • setStyleName

        public void setStyleName​(String styleName)
        Sets the CSS class name to add to the element used to display this property.
        Parameters:
        styleName - the new style name
      • getIcon

        public Map<String,​Object> getIcon()
        Returns:
        the icon meta data
      • setIcon

        public void setIcon​(Map<String,​Object> icon)
        Sets the icon meta data.
        Parameters:
        icon - the new icon meta data
      • isVisible

        public Boolean isVisible()
        Returns:
        whether this property should be displayed or not; the returned value can be null in which case the value should be inherited from the property type descriptor
      • setVisible

        public void setVisible​(Boolean visible)
        Sets whether this property should be displayed or not. Pass null to inherit from the property type descriptor.
        Parameters:
        visible - true to display this property, false to hide it, null to inherit from the property type descriptor
      • isFilterable

        public Boolean isFilterable()
        Returns:
        whether the user can filter by this property or not; the returned value can be null in which case the value should be inherited from the property type descriptor
      • setFilterable

        public void setFilterable​(Boolean filterable)
        Sets whether the user can filter by this property or not. Pass null to inherit from the property type descriptor.
        Parameters:
        filterable - true if the user can filter by this property, false if the user can't filter by this property, null to inherit from the property descriptor type
      • isEditable

        public Boolean isEditable()
        Returns:
        whether the user can edit the values of this property or not; the returned value can be null in which case the value should be inherited from the property type descriptor
      • setEditable

        public void setEditable​(Boolean editable)
        Sets whether the user can edit the values of this property or not. Pass null to inherit from the property type descriptor.
        Parameters:
        editable - true if the user can edit the values of this property, false if the user shouldn't be able to edit the property values, null to inherit from the property descriptor type
      • initialize

        public void initialize()
        Prevent null values where it's possible.