public class RMParagraph extends java.lang.Object implements java.lang.Cloneable, RMTypes
RMParagraph pgraph = RMParagraph.defaultParagraph.deriveAligned(RMParagraph.ALIGN_RIGHT); RMXString xstring = new RMXString("Hello World", pgraph);
RMTypes.Align, RMTypes.AlignX, RMTypes.AlignY
Modifier and Type | Field and Description |
---|---|
static RMParagraph |
CENTERED |
static RMParagraph |
DEFAULT |
static char |
TAB_CENTER |
static char |
TAB_DECIMAL |
static char |
TAB_LEFT |
static char |
TAB_RIGHT |
Constructor and Description |
---|
RMParagraph()
Creates a new paragraph object initialized to defaultParagraph.
|
RMParagraph(TextLineStyle aLineStyle)
Creates a new paragraph with the given alignment and indentation.
|
Modifier and Type | Method and Description |
---|---|
RMParagraph |
clone()
Standard clone of this object.
|
RMParagraph |
deriveAligned(RMTypes.AlignX anAlign)
Returns a paragraph identical to the receiver, but with the given alignment.
|
RMParagraph |
deriveIndent(double leftIndent,
double leftIndentFirst,
double rightIndent)
Returns a paragraph identical to the receiver, but with the given indentation values.
|
RMParagraph |
deriveLineGap(float aHeight)
Returns a paragraph identical to the receiver, but with the given line gap.
|
RMParagraph |
deriveLineHeightMax(float aHeight)
Returns a paragraph identical to the receiver, but with the given max line height.
|
RMParagraph |
deriveLineHeightMin(float aHeight)
Returns a paragraph identical to the receiver, but with the given min line height.
|
RMParagraph |
deriveLineSpacing(float aHeight)
Returns a paragraph identical to the receiver, but with the given line spacing.
|
boolean |
equals(java.lang.Object anObj)
Standard equals implementation.
|
java.lang.Object |
fromXML(XMLArchiver anArchiver,
XMLElement anElement)
XML unarchival.
|
RMTypes.AlignX |
getAlignmentX()
Returns the alignment associated with this paragraph.
|
double |
getLeftIndent()
Returns the left side indentation of this paragraph.
|
double |
getLeftIndentFirst()
Returns left side indentation of first line in this paragraph (this can be set different than successive lines).
|
float |
getLineGap()
Returns additional line spacing expressed as a constant amount in points.
|
float |
getLineHeightMax()
Returns the maximum line height in printer points associated with this paragraph.
|
float |
getLineHeightMin()
Returns the minimum line height in printer points associated with this paragraph.
|
float |
getLineSpacing()
Returns the spacing of lines expressed as a factor of a given line's height.
|
float |
getParagraphSpacing()
Returns the spacing between paragraphs in printer points associated with this paragraph.
|
double |
getRightIndent()
Returns the right side indentation of this paragraph.
|
float |
getTab(int anIndex)
Returns the specific tab value for the given index in printer points.
|
int |
getTabCount()
Returns the number of tabs associated with this paragraph.
|
int |
getTabIndex(double aLoc)
Returns the tab index for the given location.
|
float[] |
getTabs()
Returns the raw tab array
|
char |
getTabType(int anIndex)
Returns the type of tab at the given index.
|
char[] |
getTabTypes()
Returns the raw tab type array
|
XMLElement |
toXML(XMLArchiver anArchiver)
XML archival.
|
public static final RMParagraph DEFAULT
public static final RMParagraph CENTERED
public static final char TAB_LEFT
public static final char TAB_RIGHT
public static final char TAB_CENTER
public static final char TAB_DECIMAL
public RMParagraph()
public RMParagraph(TextLineStyle aLineStyle)
public RMTypes.AlignX getAlignmentX()
public double getLeftIndent()
public double getLeftIndentFirst()
public double getRightIndent()
public float getLineSpacing()
public float getLineGap()
public float getLineHeightMin()
public float getLineHeightMax()
public float getParagraphSpacing()
public int getTabCount()
public float getTab(int anIndex)
public char getTabType(int anIndex)
public float[] getTabs()
public char[] getTabTypes()
public int getTabIndex(double aLoc)
public RMParagraph deriveAligned(RMTypes.AlignX anAlign)
public RMParagraph deriveIndent(double leftIndent, double leftIndentFirst, double rightIndent)
public RMParagraph deriveLineSpacing(float aHeight)
public RMParagraph deriveLineGap(float aHeight)
public RMParagraph deriveLineHeightMin(float aHeight)
public RMParagraph deriveLineHeightMax(float aHeight)
public RMParagraph clone()
clone
in class java.lang.Object
public boolean equals(java.lang.Object anObj)
equals
in class java.lang.Object
public XMLElement toXML(XMLArchiver anArchiver)
public java.lang.Object fromXML(XMLArchiver anArchiver, XMLElement anElement)