Package com.reportmill.shape

Class RMTableRow

java.lang.Object
com.reportmill.base.RMObject
com.reportmill.shape.RMShape
com.reportmill.shape.RMSwitchShape
com.reportmill.shape.RMTableRow
All Implemented Interfaces:
RMArchiver.Archiving, Cloneable
public class RMTableRow extends RMSwitchShape
This class models a table row in a table.

  • Field Details

  • Constructor Details

    • RMTableRow

      public RMTableRow()
      Creates a plain, unstructured table row.

    • RMTableRow

      public RMTableRow(boolean isStructured)
      Creates a table row allowing the user to specify whether it should be structured.

  • Method Details

    • getTitle

      public String getTitle()
      Returns the title for this table row in it's parent table.

    • isStructured

      public boolean isStructured()
      Returns whether this table row is structured.

    • setStructured

      public void setStructured(boolean aFlag)
      Sets whether this table row should be structured.

    • setStructured

      public void setStructured(boolean aFlag, boolean fixColumns)
      Sets whether this table row should be structured, with an option to re-layout children.

    • getSyncStructureWithRowAbove

      public boolean getSyncStructureWithRowAbove()
      Returns whether table row should synchronize the column widths of the row immediately above it.

    • setSyncStructureWithRowAbove

      public void setSyncStructureWithRowAbove(boolean aFlag)
      Sets whether table row should synchronize the column widths of the row immediately above it.

    • getSyncStructureWithAlternates

      public boolean getSyncStructureWithAlternates()
      Returns whether table row should synchronize the column widths of alternate versions.

    • setSyncStructureWithAlternates

      public void setSyncStructureWithAlternates(boolean aFlag)
      Sets whether table row should synchronize the column widths of alternate versions.

    • getColumn

      public RMText getColumn(int anIndex)
      Returns the column at the given index (assumes row is structured and column is RMText).

    • getNumberOfColumns

      public int getNumberOfColumns()
      Returns the number of columns in this table row (really just child count).

    • setNumberOfColumns

      public void setNumberOfColumns(int count)
      Sets the number of columns in this table row.

    • getNumberOfChildrenToStayWith

      public int getNumberOfChildrenToStayWith()
      Returns the number of children this table row needs to be accompanied by, if some children run off page bottom.

    • setNumberOfChildrenToStayWith

      public void setNumberOfChildrenToStayWith(int aValue)
      Sets the number of children this table row needs to be accompanied by, if some children run off page bottom.

    • getReprintWhenWrapped

      public boolean getReprintWhenWrapped()
      Returns whether this row is reprinted on a new page when it's children cross a page boundary.

    • setReprintWhenWrapped

      public void setReprintWhenWrapped(boolean aFlag)
      Sets whether this row is reprinted on a new page when it's children cross a page boundary.

    • getPrintEvenIfGroupIsEmpty

      public boolean getPrintEvenIfGroupIsEmpty()
      Returns whether this row should print even if it has no children (assumed to be a header/summary row).

    • setPrintEvenIfGroupIsEmpty

      public void setPrintEvenIfGroupIsEmpty(boolean aFlag)
      Returns whether this row should print even if it has no children (assumed to be a header/summary row).

    • getMoveToBottom

      public boolean getMoveToBottom()
      Returns whether this row should be moved to the bottom of the table during report generation.

    • setMoveToBottom

      public void setMoveToBottom(boolean aFlag)
      Sets whether this row should be moved to the bottom of the table during report generation.

    • getMinSplitHeight

      public float getMinSplitHeight()
      Returns the minimum distance in points from the top of the row that this row can split.

    • setMinSplitHeight

      public void setMinSplitHeight(float aValue)
      Sets the minimum distance in points from the top of the row that this row can split.

    • getMinSplitRemainderHeight

      public float getMinSplitRemainderHeight()
      Returns the minimum distance in points from the bottom of the row that this row can split.

    • setMinSplitRemainderHeight

      public void setMinSplitRemainderHeight(float aValue)
      Sets the minimum distance in points from the top of the row that this row can split.

    • arrange

      public void arrange()
      Recalcs column widths to fill table row width.

    • arrangeWithShape

      public void arrangeWithShape(RMShape aShape)
      Recalcs column widths to fill table row width.

    • syncStructureWithShape

      public void syncStructureWithShape(RMShape aShape)
      The syncStructureWithShape() method sync's the column widths of receiver to those of given shape.

    • getRowAbove

      public RMTableRow getRowAbove()
      Returns the row above this one in the template.

    • addChild

      public void addChild(RMShape aChild, int anIndex)
      Overrides standard shape method to turn off structuring if child isn't text.
      Overrides:
      addChild in class RMShape

    • transferAttributes

      protected void transferAttributes(RMSwitchShape toShape)
      Overrides switch shape method to specify additional attributes to be transferred when setVersion is called.
      Overrides:
      transferAttributes in class RMSwitchShape

    • rpgCloneBase

      public Object rpgCloneBase()
      This rpgCloneBase over-ride is used to substitute RMTableRowRPG as the class for the rpgClone.
      Overrides:
      rpgCloneBase in class RMShape

    • rpgClone

      public RMShape rpgClone(ReportMill rm, RMGroup group, String suggestedVersion)
      This rpgClone method hands things off to RMTableRowRPG.

    • rpgCloneNotification

      public void rpgCloneNotification(ReportMill rm, RMShape copy)
      Overrides shape method to suppress normal notification (will send after table row's version).
      Overrides:
      rpgCloneNotification in class RMShape

    • equals

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

    • copy

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

    • canBeUngrouped

      public boolean canBeUngrouped()
      Editor method - states that this shape can't be ungrouped.
      Overrides:
      canBeUngrouped in class RMShape

    • childrenSuperSelectImmediately

      public boolean childrenSuperSelectImmediately()
      Editor method - states that children super-select immediately when table row is structured.
      Overrides:
      childrenSuperSelectImmediately in class RMShape

    • sizesToFitChildren

      public boolean sizesToFitChildren()
      Editor method.
      Overrides:
      sizesToFitChildren in class RMShape

    • boundsChanged

      public void boundsChanged(RMShape shape)
      Notification method - relays out children when bounds are changed.
      Overrides:
      boundsChanged in class RMShape

    • toXML

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

    • fromXML

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

    • initWithArchiver

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

    • toString

      public String toString()
      Returns a string description of the table row.
      Overrides:
      toString in class RMShape