Package com.iizigo.vs.prop

Class EditorVSRow

java.lang.Object
com.iizix.prop.GProp<GProp<?>[]>
com.iizix.prop.PropCnr
com.iizix.prop.vs.VSComponent
com.iizix.prop.vs.VSRow
com.iizigo.vs.prop.EditorVSRow
All Implemented Interfaces:
IPropDesigner, EventListener, IFocusComp, IMessageBox, ICustomDataProvider, IGProp<GProp<?>[]>, IPropCnr, IVSComponent, IVSComponentListener, IVSComponentState, Cloneable, IAdaptable
public class EditorVSRow extends VSRow implements IPropDesigner
The Editor VirtualSpace Row property class.
Author:
Christopher Mindus

  • Constructor Details

    • EditorVSRow

      public EditorVSRow()
      Creates the VirtualSpace Row property container without a name. The name must be set in all cases using the setPropertyAtom call.

    • EditorVSRow

      public EditorVSRow(Atom propertyAtom)
      Creates the VirtualSpace Row property container with the specified name. All system-reserved names for components begins with "$".
      Parameters:
      propertyAtom - The name of the component, unique within it's parent.

    • EditorVSRow

      public EditorVSRow(Atom propertyAtom, VSField[] fields) throws PropException
      Creates the VirtualSpace Row property container with the specified name. All system-reserved names for components begins with "$".
      Parameters:
      propertyAtom - The name of the component, unique within it's parent.
      fields - The fields.
      Throws:
      PropException - For creation errors.

    • EditorVSRow

      public EditorVSRow(Atom propertyAtom, VSColumnHeader[] columns) throws PropException
      Creates the VirtualSpace Row property container with the specified name. All system-reserved names for components begins with "$".
      Parameters:
      propertyAtom - The name of the component, unique within it's parent.
      columns - The columns.
      Throws:
      PropException - For creation errors.

  • Method Details

    • createField

      public EditorVSField createField()
      Creates a new field with a unique name that then can be added to this row.
      Overrides:
      createField in class VSRow
      Returns:
      A new field, initialized with a value or not depending on if the value is null.

    • getVirtualSpace

      public EditorVirtualSpace getVirtualSpace()
      Gets the VirtualSpace instance.
      Specified by:
      getVirtualSpace in interface IVSComponent
      Overrides:
      getVirtualSpace in class VSComponent
      Returns:
      The VirtualSpace instance (an ancestor of this property or itself), or null if not found (i.e. property is not yet attached to a VirtualSpace).

    • getDesigner

      public VirtualSpaceDesignerProp getDesigner()
      Gets the Designer Extension for Properties.
      Specified by:
      getDesigner in interface IPropDesigner
      Returns:
      The instance of the Designer Extension.

    • clone

      public EditorVSRow clone()
      Clone must be overridden.
      Overrides:
      clone in class VSRow

    • onEventSelf

      public void onEventSelf(GEvent event)
      Checks for reordering of columns.
      Specified by:
      onEventSelf in interface IGProp<GProp<?>[]>
      Overrides:
      onEventSelf in class VSComponent
      Parameters:
      event - The property event.

    • getTable

      public EditorVSTable getTable()
      Gets the table of the row.
      Overrides:
      getTable in class VSRow
      Returns:
      The VirtualSpace Table instance, or null if row is not added to a table.

    • getColumnHeader

      public EditorVSColumnHeader getColumnHeader(int columnIndex)
      Gets the headers columns for the row.
      Overrides:
      getColumnHeader in class VSRow
      Parameters:
      columnIndex - The index of the column.
      Returns:
      The column of requested index, null if it's not a headerBackground row (i.e. VSRow.isColumnHeader() returns false), or the column index is out of range.

    • getColumnHeaders

      public EditorVSColumnHeader[] getColumnHeaders()
      Gets the headers columns for the row.
      Overrides:
      getColumnHeaders in class VSRow
      Returns:
      The array of VSFields, empty array if it's a headerBackground row (VSRow.isColumnHeader() returns true).

    • getFields

      public EditorVSField[] getFields()
      Gets the fields for the row.
      Overrides:
      getFields in class VSRow
      Returns:
      The array of VSFields, empty array if it's a headerBackground row (VSRow.isColumnHeader() returns true).

    • getField

      public EditorVSField getField(int columnIndex)
      Gets the field at specified column index.
      Overrides:
      getField in class VSRow
      Parameters:
      columnIndex - The column index.
      Returns:
      The field found, or null for none.

    • getPossibleChildren

      public Class<?>[] getPossibleChildren()
      Gets the acceptable children property classes that can be used in conjunction with e.g. a Paste operation.
      Specified by:
      getPossibleChildren in interface IPropCnr
      Overrides:
      getPossibleChildren in class PropCnr
      Returns:
      An array containing the classes of possible children, or null for no support.