Package com.iizix.prop.ui

Class GridData

java.lang.Object
com.iizix.prop.GProp<GProp<?>[]>
com.iizix.prop.PropCnr
com.iizix.prop.ui.LayoutProp
com.iizix.prop.ui.GridData
All Implemented Interfaces:
EventListener, IGProp<GProp<?>[]>, IPropCnr, ILayoutAssumeHeight, ILayoutAssumeWidth, ILayoutDataAlignX, ILayoutDataAlignY, ILayoutUnitHeight, ILayoutUnitWidth, Cloneable
Direct Known Subclasses:
EGridData
public class GridData extends LayoutProp implements ILayoutUnitWidth, ILayoutUnitHeight, ILayoutDataAlignX, ILayoutDataAlignY, ILayoutAssumeWidth, ILayoutAssumeHeight
The GridData is the layout data for components in a container with GridLayout.
Author:
Christopher Mindus

  • Constructor Details

    • GridData

      public GridData()
      Creates a GridData container without name and with a null value.

    • GridData

      public GridData(Atom propertyAtom)
      Creates a GridData container with the specified name with a null value.
      Parameters:
      propertyAtom - the property atom.

    • GridData

      public GridData(Atom propertyAtom, GProp<?>[] properties) throws PropException
      Creates a GridData container with the specified name and properties.
      Parameters:
      propertyAtom - the property atom.
      properties - the property array value for the property.
      Throws:
      PropException - as structural changes in containers on client is prohibited.

  • Method Details

    • doGrabRemainingX

      public boolean doGrabRemainingX()
      Returns if the component grabs the remaining space in X.

    • doGrabRemainingY

      public boolean doGrabRemainingY()
      Returns if the component grabs the remaining space in Y.

    • canSetWidth

      public boolean canSetWidth()
      Verifies if the component width can be set.
      Overrides:
      canSetWidth in class LayoutProp
      Returns:
      true if the width can be set.

    • canSetHeight

      public boolean canSetHeight()
      Verifies if the component height can be set.
      Overrides:
      canSetHeight in class LayoutProp
      Returns:
      true if the height can be set.

    • setSize

      public boolean setSize(GUnit width, GUnit height, IComplexOperation op)
      Assigns the component width and/or height.
      Overrides:
      setSize in class LayoutProp
      Parameters:
      width - The width to set, null for no change.
      height - The height to set, null for no change.
      op - The complex operation interface for undo/redo operations, null for none.
      Returns:
      true for success.

    • isWidthIndirectlyDefined

      public boolean isWidthIndirectlyDefined()
      Returns if the width is indirectly defined due to settings of this layout.

      This is used e.g. for grid layout data that has Grab remaining horizontal option.

      Overrides:
      isWidthIndirectlyDefined in class LayoutProp
      Returns:
      true if the layout for the component indirectly causes the width to be set, false otherwise.

    • isHeightIndirectlyDefined

      public boolean isHeightIndirectlyDefined()
      Returns if the height is indirectly defined due to settings of this layout.

      This is used e.g. for grid layout data that has Grab remaining vertical option.

      Overrides:
      isHeightIndirectlyDefined in class LayoutProp
      Returns:
      true if the layout for the component indirectly causes the height to be set, false otherwise.