Package com.iizix.prop.content

Interface IContentData<ITEM extends IContentItem>

All Known Implementing Classes:
MapMarker, MLCheckBox, MLComboBox, MLDateTime, MLItem, MLRadioButton, MLSimple, MLSlider, MLSpinner, MLSwitch, MLText
public interface IContentData<ITEM extends IContentItem>
The data content interface used to carry information about an item.
Author:
Christopher Mindus

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addMappings(VSMappings mappings, String uiRef, ITEM item)
    Adds the mappings of a VirtualSpace to the panel components.
    ITEM
    getItemProp()
    Returns the property that was used to update this data content.
    VSRow
    getVSRow()
    Gets the associated VSRow for this item.
    void
    initialize(ITEM item)
    Initializes the item property from the content data.
    boolean
    isSelected()
    Gets the selection state of the item.
    void
    refreshFromVS(int[] columns)
    Refreshes contents from VirtualSpace.
    String
    setSelection(boolean on)
    Sets the selection state of an item.
    String
    setSelectionInternal(boolean on)
    Internal method to sets the selection state of an item.

  • Method Details

    • refreshFromVS

      void refreshFromVS(int[] columns)
      Refreshes contents from VirtualSpace.
      Parameters:
      columns - The connected table columns indicies, -1 for none.

    • getVSRow

      VSRow getVSRow()
      Gets the associated VSRow for this item.
      Returns:
      The row, or null if not associated with VirtualSpace.

    • getItemProp

      ITEM getItemProp()
      Returns the property that was used to update this data content.
      Returns:
      The property, or null if none is assigned.

    • initialize

      void initialize(ITEM item)
      Initializes the item property from the content data.
      Parameters:
      item - The item.

    • isSelected

      boolean isSelected()
      Gets the selection state of the item.
      Returns:
      The selected state.

    • setSelection

      String setSelection(boolean on)
      Sets the selection state of an item.
      Parameters:
      on - The new selection state.
      Returns:
      null for success, otherwise an error message why the selection failed.

    • setSelectionInternal

      String setSelectionInternal(boolean on)
      Internal method to sets the selection state of an item. This method is not intended to be called as it is used by the framework and will not cause a callback or event notification of selection changes.
      Parameters:
      on - The new selection state.
      Returns:
      null for success, empty string for no change, otherwise an error message why the selection failed.

    • addMappings

      void addMappings(VSMappings mappings, String uiRef, ITEM item)
      Adds the mappings of a VirtualSpace to the panel components.

      The default is to find the relative references to VS and add those references. Override to provide other functionality.

      Parameters:
      mappings - The mappings instance to fill in.
      uiRef - The reference.
      item - The item property.