Package com.reportmill.shape

Class RMCrossTab

java.lang.Object
com.reportmill.base.RMObject
com.reportmill.shape.RMShape
com.reportmill.shape.RMCrossTab
All Implemented Interfaces:
RMArchiver.Archiving, Cloneable
public class RMCrossTab extends RMShape
This class represents a groupable data matrix (or crosstab).

  • Field Details

  • Constructor Details

    • RMCrossTab

      public RMCrossTab()
      Creates a plain crosstab.

  • Method Details

    • getListKey

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

    • setListKey

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

    • getGrouper

      public RMGrouper getGrouper()
      Returns the grouper associated with this crosstab.

    • getGroupingCount

      public int getGroupingCount()
      Returns the number of groups associated with this crosstab.

    • getGrouping

      public RMGrouping getGrouping(int anIndex)
      Returns the crosstab grouping at the given index.

    • getGroupingLast

      public RMGrouping getGroupingLast()
      Returns the last crosstab grouping.

    • getSelectedGrouping

      public RMGrouping getSelectedGrouping()
      Returns the selected crosstab grouping (when editing).

    • getSelectedSort

      public RMSort getSelectedSort()
      Returns the selected sort for the selected crosstab grouping.

    • getColumnGroupingIndex

      public int getColumnGroupingIndex()
      Returns the grouping index that crosstab's columns start with.

    • setColumnGroupingIndex

      public void setColumnGroupingIndex(int anIndex)
      Sets the grouping index that crosstab's columns start with.

    • getPageBreakGroupIndex

      public int getPageBreakGroupIndex()
      Returns the grouping index that crosstab page breaks on.

    • setPageBreakGroupIndex

      public void setPageBreakGroupIndex(int anIndex)
      Sets the grouping index that crosstab page breaks on.

    • getOverflowBehavior

      public int getOverflowBehavior()
      Returns the overflow behavior of the crosstab.

    • setOverflowBehavior

      public void setOverflowBehavior(int aValue)
      Sets the overflow behavior of the crosstab.

    • getSelectedGroupingIndex

      public int getSelectedGroupingIndex()
      Returns currently selected grouping index.

    • setSelectedGroupingIndex

      public void setSelectedGroupingIndex(int anIndex)
      Sets the currently selected grouping index.

    • getSelectedSortIndex

      public int getSelectedSortIndex()
      Returns currently selected sort index.

    • setSelectedSortIndex

      public void setSelectedSortIndex(int anIndex)
      Sets the currently selected sort index.

    • groupingButtonRect

      public RMRect groupingButtonRect(int anIndex)
      Returns the bounds rect for the grouping button at the given index.

    • groupingButtonIndexAtPoint

      public int groupingButtonIndexAtPoint(RMPoint aPoint)
      Returns the grouping index for the button at the given point.

    • addGroupingForKey

      public void addGroupingForKey(String aKey, int i)
      Adds a grouping for the given key at the given grouping index.

    • addGroupingForKey

      public void addGroupingForKey(String aKey, int anIndex, int aType)
      Adds a grouping for the given key at the given grouping index.

    • moveGrouping

      public void moveGrouping(int si, int di)
      Moves a grouping from the first index to the second index.

    • moveGrouping

      public void moveGrouping(int sourceIndex, int destIndex, int destType)
      Moves a grouping from the first index to the second index.

    • removeGrouping

      public void removeGrouping(RMGrouping aGrouping)
      Removes the given grouping.

    • removeGrouping

      public void removeGrouping(int anIndex)
      Removes the grouping at the given index.

    • dragKeyAtPoint

      public void dragKeyAtPoint(String aString, RMPoint aPoint)
      Drag and drop: tells crosstab that key is being dragged at point.
      Overrides:
      dragKeyAtPoint in class RMShape

    • dropKeyAtPoint

      public void dropKeyAtPoint(String aString, RMPoint aPoint)
      Drag and drop: tells crosstab that key was dropped at point.
      Overrides:
      dropKeyAtPoint in class RMShape

    • dragExit

      public void dragExit()
      Drag and drop: tells crosstab that key exited crosstab.
      Overrides:
      dragExit in class RMShape

    • addGroupingForKeyAtPoint

      public void addGroupingForKeyAtPoint(String aKey, RMPoint aPoint)
      Adds a grouping for the given key at the given point.

    • rpgClonePreprocess

      public void rpgClonePreprocess(ReportMill reportMill)
      RPG clone actually happens in preprocess step, so we know how many pages it generates.
      Overrides:
      rpgClonePreprocess in class RMShape

    • rpgClone

      public RMShape rpgClone(ReportMill aReportMill)
      RPG clone method actually returns page index specified by aReportMill (generated in preprocess).
      Overrides:
      rpgClone in class RMShape

    • superSelectable

      public boolean superSelectable()
      Editor method - specifies that crosstab is super-selectable.
      Overrides:
      superSelectable in class RMShape

    • childrenSuperSelectImmediately

      public boolean childrenSuperSelectImmediately()
      Editor method - specifies that crosstab's children super select immediately.
      Overrides:
      childrenSuperSelectImmediately in class RMShape

    • canBeUngrouped

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

    • acceptsChildren

      public boolean acceptsChildren()
      Editor method - specifies that crosstab can't accept children.
      Overrides:
      acceptsChildren in class RMShape

    • acceptsDragKeys

      public boolean acceptsDragKeys()
      Editor method - specifies that crosstab accepts drag keys.
      Overrides:
      acceptsDragKeys in class RMShape

    • equals

      public boolean equals(Object anObj)
      Standard equals implementation.
      Overrides:
      equals 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