Package com.inductiveautomation.rm.shape

Class RMLabels

java.lang.Object
com.inductiveautomation.rm.base.RMListenerList
com.inductiveautomation.rm.base.RMObject
com.inductiveautomation.rm.shape.RMShape
com.inductiveautomation.rm.shape.RMParentShape
com.inductiveautomation.rm.shape.RMLabels
All Implemented Interfaces:
Archivable, DeepChangeListener, RMPropertyChanger, RMTypes, PropertyChangeListener, Cloneable, EventListener
public class RMLabels extends RMParentShape
This class represents a block of labels.

  • Field Details

  • Constructor Details

    • RMLabels

      public RMLabels()
      Creates a new labels template.

  • Method Details

    • getLabelFormat

      public LabelFormat getLabelFormat()

    • setLabelFormat

      public void setLabelFormat(LabelFormat labelFormat)

    • getLabel

      public RMLabel getLabel()
      Returns the default label shape.

    • getDatasetKey

      public String getDatasetKey()
      Returns the dataset key associated with labels.
      Overrides:
      getDatasetKey in class RMShape

    • setDatasetKey

      public void setDatasetKey(String aKeyPath)
      Sets the dataset key associated with labels.

    • getGrouping

      public RMGrouping getGrouping()
      Returns the grouping for this labels shape.

    • getSorts

      public List getSorts()
      Returns the list of sorts associated with labels.

    • getSortCount

      public int getSortCount()
      Returns the number of sorts associated with labels.

    • getSort

      public RMSort getSort(int anIndex)
      Returns the specific sort at the given index.

    • getNumberOfRows

      public int getNumberOfRows()
      Returns the number of rows in the labels block.

    • setNumberOfRows

      public void setNumberOfRows(int aValue)
      Sets the number of rows in the labels block.

    • getNumberOfColumns

      public int getNumberOfColumns()
      Returns the number of columns in the labels block.

    • setNumberOfColumns

      public void setNumberOfColumns(int aValue)
      Sets the number of columns in the labels block.

    • getSpacingWidth

      public double getSpacingWidth()
      Returns the spacing between labels horizontally.

    • setSpacingWidth

      public void setSpacingWidth(double aValue)
      Sets the spacing between labels horizontally.

    • getSpacingHeight

      public double getSpacingHeight()
      Returns the spacing between labels vertically.

    • setSpacingHeight

      public void setSpacingHeight(double aValue)
      Sets the spacing between labels vertically.

    • getLabelWidth

      public double getLabelWidth()
      Returns the width of an individual label.

    • setLabelWidth

      public void setLabelWidth(double width)

    • getLabelHeight

      public double getLabelHeight()
      Returns the height of an individual label.

    • setLabelHeight

      public void setLabelHeight(double height)

    • setWidth

      public void setWidth(double aWidth)
      Overrides shape method to recalc spacing width.
      Overrides:
      setWidth in class RMParentShape

    • setHeight

      public void setHeight(double value)
      Overrides shape method to recalc spacing height.
      Overrides:
      setHeight in class RMParentShape

    • fixSize

      public void fixSize()
      Resets labels block width and height if any of labels other attributes have changed.

    • updateLabelSizes

      public void updateLabelSizes()

    • rpgAll

      public RMShape rpgAll(ReportOwner anRptOwner, RMShape aParent)
      Report Generation.
      Overrides:
      rpgAll in class RMParentShape

    • paintShape

      public void paintShape(RMShapePainter aPntr)
      Paint labels shapes.
      Overrides:
      paintShape in class RMShape

    • clone

      public RMLabels clone()
      Override to clone grouping.
      Overrides:
      clone in class RMParentShape

    • childrenSuperSelectImmediately

      public boolean childrenSuperSelectImmediately()
      Editor method - indicates that labels child should super-select immediately.
      Overrides:
      childrenSuperSelectImmediately in class RMShape

    • toXMLShape

      protected RXElement toXMLShape(RXArchiver anArchiver)
      XML archival.
      Overrides:
      toXMLShape in class RMParentShape

    • fromXMLShape

      protected void fromXMLShape(RXArchiver anArchiver, RXElement anElement)
      XML unarchival.
      Overrides:
      fromXMLShape in class RMParentShape

    • setSize

      public void setSize(RMSize aSize)
      Overridden because we want the size of the RMLabels to be the computed size determined by the size and numbers of the individual labels
      Overrides:
      setSize in class RMShape