Package com.inductiveautomation.rm.shape

Class RMTableRow

    • Constructor Detail

      • 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 Detail

      • getTable

        public RMTable getTable()
        Returns the parent of this table row.

      • getTitle

        public java.lang.String getTitle()
        Returns the title for this table row.

      • setTitle

        public void setTitle​(java.lang.String aTitle)
        Sets the title for this table row.

      • 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.

      • 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 RMTextShape getColumn​(int anIndex)
        Returns the column at the given index (assumes row is structured and column is RMTextShape).

      • getNumberOfColumns

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

      • setNumberOfColumns

        public void setNumberOfColumns​(int aCount)
        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 its children cross a page boundary.

      • setReprintWhenWrapped

        public void setReprintWhenWrapped​(boolean aFlag)
        Sets whether this row is reprinted on a new page when its 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 double getMinSplitHeight()
        Returns the minimum distance in points from the top of the row that this row can split.

      • setMinSplitHeight

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

      • getMinSplitRemainderHeight

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

      • setMinSplitRemainderHeight

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

      • getPageBreakKey

        public java.lang.String getPageBreakKey()
        Returns the key used to determine whether row should force a page break.

      • setPageBreakKey

        public void setPageBreakKey​(java.lang.String aString)
        Sets the key used to determine whether row should force a page break.

      • getDeleteVerticalSpansOfHiddenShapes

        public boolean getDeleteVerticalSpansOfHiddenShapes()
        Returns whether layout deletes vertical spans of hidden shapes.

      • setDeleteVerticalSpansOfHiddenShapes

        public void setDeleteVerticalSpansOfHiddenShapes​(boolean aValue)
        Sets whether layout deletes vertical spans of hidden shapes.

      • getShiftShapesBelowHiddenShapesUp

        public boolean getShiftShapesBelowHiddenShapesUp()
        Returns whether to shift shapes below hidden shapes up.

      • setShiftShapesBelowHiddenShapesUp

        public void setShiftShapesBelowHiddenShapesUp​(boolean aValue)
        Sets whether to shift shapes below hidden shapes up.

      • syncStructureWithShape

        public void syncStructureWithShape​(RMParentShape 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 RMParentShape

      • 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

      • childrenSuperSelectImmediately

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

      • fromXMLChildren

        protected void fromXMLChildren​(RXArchiver anArchiver,
                               RXElement anElement)
        Override to make sure structured children are sorted by X (wasn't necessarily so before RM14).
        Overrides:
        fromXMLChildren in class RMParentShape

      • toString

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