Package com.reportmill.shape

Class RMLabels

java.lang.Object
com.reportmill.base.RMObject
com.reportmill.shape.RMShape
com.reportmill.shape.RMLabels
All Implemented Interfaces:
RMArchiver.Archiving, Cloneable
public class RMLabels extends RMShape
This class represents a block of labels.

  • Constructor Details

    • RMLabels

      public RMLabels()
      Creates a new labels template.

  • Method Details

    • getListKey

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

    • setListKey

      public void setListKey(String aKeyPath)
      Sets the list key associated with labels.
      Overrides:
      setListKey in class RMShape

    • 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 anIdex)
      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 float getSpacingWidth()
      Returns the spacing between labels horizontally.

    • setSpacingWidth

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

    • getSpacingHeight

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

    • setSpacingHeight

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

    • getPaginate

      public boolean getPaginate()
      Returns whether the labels should paginate.

    • setPaginate

      public void setPaginate(boolean aFlag)
      Sets whether the labels should paginate.

    • labelWidth

      public float labelWidth()
      Returns the width of an individual label.

    • labelHeight

      public float labelHeight()
      Returns the height of an individual label.

    • setWidthDeep

      public void setWidthDeep(float value, boolean constrain)
      Overrides shape method to recalc spacing width.
      Overrides:
      setWidthDeep in class RMShape

    • setHeightDeep

      public void setHeightDeep(float value, boolean constrain)
      Overrides shape method to recalc spacing height.
      Overrides:
      setHeightDeep in class RMShape

    • fixSize

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

    • rpgClonePreprocess

      public void rpgClonePreprocess(ReportMill reportMill)
      RPG clone - actual work happens in preprocess so RM knows how many pages are needed.
      Overrides:
      rpgClonePreprocess in class RMShape

    • rpgClone

      public RMShape rpgClone(ReportMill reportMill)
      RPG clone - returns individual pages of RPG labels.
      Overrides:
      rpgClone in class RMShape

    • equals

      public boolean equals(Object anObj)
      Standard equals implementation.
      Overrides:
      equals in class RMShape

    • clone

      public Object clone()
      Standard clone implementation.
      Overrides:
      clone in class RMShape

    • copy

      public void copy(Object anObj)
      Standard copy implementation.
      Overrides:
      copy in class RMShape

    • initWithArchiver

      public Object initWithArchiver(RMArchiver anArchiver)
      Legacy unarchival.
      Specified by:
      initWithArchiver in interface RMArchiver.Archiving
      Overrides:
      initWithArchiver in class RMShape

    • toXML

      public RXElement toXML(RXArchiver anArchiver)
      XML archival.
      Overrides:
      toXML in class RMShape

    • fromXML

      public Object fromXML(RXArchiver anArchiver, RXElement anElement)
      XML unarchival.
      Overrides:
      fromXML in class RMShape

    • superSelectable

      public boolean superSelectable()
      Editor method - indicates that labels block is super-selectable.
      Overrides:
      superSelectable in class RMShape

    • canBeUngrouped

      public boolean canBeUngrouped()
      Editor method - indicates that labels block can't be ungrouped.
      Overrides:
      canBeUngrouped in class RMShape

    • childrenSuperSelectImmediately

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