Package com.reportmill.text

Class RMParagraph

java.lang.Object
com.reportmill.base.RMObject
com.reportmill.text.RMParagraph
All Implemented Interfaces:
RMArchiver.Archiving, Cloneable
public class RMParagraph extends RMObject
This class represents attributes of a paragraph in an RMXString (all of the characters up to and including each newline in an RMXString make up a paragraph). Paragraphs can have their own alignment, indentation, min/max line height, etc. You might use this class like this: 

   RMParagraph pgraph = RMParagraph.defaultParagraph.deriveAligned(RMParagraph.ALIGN_RIGHT);
   RMXString xstring = new RMXString("Hello World", pgraph);

  • Field Details

  • Constructor Details

    • RMParagraph

      public RMParagraph()
      Creates a new paragraph object initialized to defaultParagraph. You should probably use RMParagraph.defaultParagraph instead.

    • RMParagraph

      public RMParagraph(int anAlign, float leftIndent, float leftIndentFirst, float rightIndent)
      Creates a new paragraph with the given alignment and indentation.

  • Method Details

    • getAlign

      public byte getAlign()
      Returns the alignment associated with this paragraph.

    • getAlignString

      public String getAlignString()
      Returns a string representation of the alignment associated with this paragraph, "left", "center" or "right".

    • getAlign

      public byte getAlign(String aString)
      Returns an alignment for the given string, "left", "center", "right" or "full".

    • getLeftIndent

      public float getLeftIndent()
      Returns the left side indentation of this paragraph.

    • getLeftIndentFirst

      public float getLeftIndentFirst()
      Returns the left side indentation of the first line in this paragraph (this can be set different than successive lines).

    • getRightIndent

      public float getRightIndent()
      Returns the right side indentation of this paragraph.

    • getLineSpacing

      public float getLineSpacing()
      Returns the spacing of lines expressed as a factor of a given line's height.

    • getLineGap

      public float getLineGap()
      Returns additional line spacing expressed as a constant amount in points.

    • getLineHeightMin

      public float getLineHeightMin()
      Returns the minimum line height in printer points associated with this paragraph.

    • getLineHeightMax

      public float getLineHeightMax()
      Returns the maximum line height in printer points associated with this paragraph.

    • getParagraphSpacing

      public float getParagraphSpacing()
      Returns the spacing between paragraphs in printer points associated with this paragraph.

    • getTabCount

      public int getTabCount()
      Returns the number of tabs associated with this paragraph.

    • getTab

      public float getTab(int anIndex)
      Returns the specific tab value for the given index in printer points.

    • getTabType

      public char getTabType(int anIndex)
      Returns the type of tab at the given index.

    • getTabIndex

      public int getTabIndex(float aLocation)
      Returns the tab index for the given location.

    • getTabsString

      public String getTabsString()
      Returns the values of all the tabs associated with this paragraph as a comma separated string.

    • deriveAligned

      public RMParagraph deriveAligned(int anAlign)
      Returns a paragraph identical to the receiver, but with the given alignment.

    • deriveIndent

      public RMParagraph deriveIndent(float leftIndent, float leftIndentFirst, float rightIndent)
      Returns a paragraph identical to the receiver, but with the given indentation values.

    • deriveLineSpacing

      public RMParagraph deriveLineSpacing(float aHeight)
      Returns a paragraph identical to the receiver, but with the given line spacing.

    • deriveLineGap

      public RMParagraph deriveLineGap(float aHeight)
      Returns a paragraph identical to the receiver, but with the given line gap.

    • deriveLineHeightMin

      public RMParagraph deriveLineHeightMin(float aHeight)
      Returns a paragraph identical to the receiver, but with the given min line height.

    • deriveLineHeightMax

      public RMParagraph deriveLineHeightMax(float aHeight)
      Returns a paragraph identical to the receiver, but with the given max line height.

    • deriveTabs

      public RMParagraph deriveTabs(float[] newTabs, char[] newTypes)
      Returns a paragraph identical to the receiver, but with the given tabs.

    • deriveTab

      public RMParagraph deriveTab(int anIndex, float tabValue, char tabType)
      Returns a paragraph identical to the receiver, but with new value for tab at given index.

    • equals

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

    • initWithArchiver

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

    • toXML

      public RXElement toXML(RXArchiver anArchiver)
      XML archival.

    • fromXML

      public Object fromXML(RXArchiver anArchiver, RXElement anElement)
      XML unarchival.