RMText (ReportMill 12 API)

java.lang.Object
- com.reportmill.base.RMObject
- - com.reportmill.shape.RMShape
  - - com.reportmill.shape.RMRectangle
    - - com.reportmill.shape.RMText

All Implemented Interfaces:

com.reportmill.base.RMPropertyChanger, java.beans.PropertyChangeListener, java.lang.Cloneable, java.util.EventListener

Direct Known Subclasses:

RMGraphLegend, RMGraphPartLabelAxis, RMGraphPartValueAxis
```
public class RMText
extends RMRectangle
```
This class is an RMShape subclass for handling rich text. Text is probably the most common and useful element in a ReportMill template. You might use this class to programatically build or modify a template, like this:
```
   RMXString xstring = new RMXString("Hello world!", RMFont.getFont("Arial", 12), RMColor.red);
   RMText text = new RMText(xstring);
   template.getPage(0).addChild(text);
   text.setXY(36, 36);
   text.setSizeToFit();
 
```

Field Summary

Fields
Modifier and Type	Field and Description
`static byte`	`ALIGN_BOTTOM`
`static byte`	`ALIGN_CENTER`
`static byte`	`ALIGN_FULL`
`static byte`	`ALIGN_LEFT`
`static byte`	`ALIGN_MIDDLE`
`static byte`	`ALIGN_RIGHT`
`static byte`	`ALIGN_TOP`
`static byte`	`WRAP_BASIC`
`static byte`	`WRAP_NONE`
`static byte`	`WRAP_SCALE`

Fields inherited from class com.reportmill.shape.RMShape
WRAP_TYPE_BOTH, WRAP_TYPE_NONE

Constructor Summary

Constructors
Constructor and Description
`RMText()` Creates an empty text instance.
`RMText(RMXString string)` Creates a text instance initialized with the given RMXString.
`RMText(java.lang.String plainText)` Creates a text instance initialized with the given plain text String.

Method Summary

Methods
Modifier and Type	Method and Description
`RMText`	`clone()` Standard clone implementation.
`void`	`copyText(RMText aText)` Copies attributes from given object.
`boolean`	`equals(java.lang.Object anObj)` Standard equals implementation.
`void`	`fromXMLFinish(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement)` XML reference unarchival - to unarchive linked text.
`java.lang.Object`	`fromXMLShape(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement, java.lang.Object anOwner)` XML unarchival.
`byte`	`getAlign()` Returns the alignment for char 0.
`java.lang.String`	`getAlignString()` Returns the alignment as a string, one of: "left", "center" or "right".
`byte`	`getAlignVertical()` Returns the vertical alignment.
`java.lang.String`	`getAlignVerticalString()` Returns the vertical alignment as a string (one of: "top", "middle" or "bottom").
`RMRect`	`getBoundsFromTextBounds(RMRect aRect)` Returns bounds from given text bounds, adjusted to account for text margins.
`float`	`getCharSpacing()` Returns the char spacing at char 0.
`boolean`	`getCoalesceNewlines()` Returns whether text should coalesce consecutive newlines in rpgClone.
`boolean`	`getDrawsSelectionRect()` Returns whether text should always draw at least a light gray border (useful when editing).
`RMFont`	`getFont()` Returns the font for char 0.
`RMFormat`	`getFormat()` Returns the format for char 0.
`float`	`getHeightToFit()` Returns the ideal height for this RMText.
`float`	`getHeightToFit(boolean includeFinalEmptyLine)` Returns the ideal height for this RMText.
`float`	`getLineGap()` Returns the line gap at char 0.
`float`	`getLineHeightMax()` Returns the maximum line height at char 0.
`float`	`getLineHeightMin()` Returns the minimum line height at char 0.
`float`	`getLineSpacing()` Returns the line spacing at char 0.
`com.reportmill.shape.RMLinkedText`	`getLinkedText()` Returns the linked text for this text (if any).
`java.awt.Insets`	`getMargin()` Returns margin.
`int`	`getMarginBottom()` Returns the bottom margin of the text (defaults to 0).
`java.awt.Insets`	`getMarginDefault()` Returns the default margin of the text (top=1, left=2, right=2, bottom=0).
`int`	`getMarginLeft()` Returns the left margin of the text (default to 2).
`int`	`getMarginRight()` Returns the right margin of the text (defaults to 2).
`java.lang.String`	`getMarginString()` Returns the margin as a string.
`int`	`getMarginTop()` Returns the top margin of the text (defaults to 1).
`RMPath`	`getMaskPath()` Overridden from RMShape to provide the outlines of all the glyphs
`java.lang.Object`	`getObject()` Bogus accessor to provide type information for setObject.
`RMXString.Outline`	`getOutline()` Returns the outline for char 0.
`RMPath`	`getPath()` Returns the path for this shape.
`RMPath`	`getPathInBounds()` Overrides shape implementation to pass through getPathInBounds(inset).
`RMPath`	`getPathInBounds(int inset)` Returns the shape's path scaled to the shape's current bounds.
`RMShape`	`getPathShape()` Returns the shape that provides the path for this text to wrap text to.
`boolean`	`getPerformsWrap()` Returns whether text should wrap around other shapes that cause wrap.
`RMSize`	`getPreferredSizeImpl()` Override to return layout preferred size (unless this text is scaling fonts to fit).
`java.lang.String`	`getText()` Returns the text associated with this RMText as a plain String.
`RMRect`	`getTextBounds()` Returns the actual bounding rect of the text (currently just inset 2 pixels on either side).
`RMColor`	`getTextColor()` Returns the color of the first character of the xstring associated with this RMText.
`com.reportmill.text.RMTextLayout`	`getTextLayout()` Returns a text layout configured for this text, with layout already performed.
`com.reportmill.text.RMTextLayout`	`getTextLayout(boolean performLayout)` Returns a text layout configured for this text, with an option to perform layout.
`int`	`getVisibleEnd()` Returns the last character index visible in this text.
`int`	`getVisibleStart()` Returns the first character index visible in this text.
`float`	`getWidthToFit()` Returns the ideal width for this RMText.
`byte`	`getWraps()` Returns the wrapping behavior for over-filled rpgCloned text (NONE, WRAP, SHRINK).
`RMXString`	`getXString()` Returns the XString associated with this RMText.
`boolean`	`isAllTextVisible()` Returns whether all characters can be visibly rendered in text bounds.
`boolean`	`isStructured()` Editor method.
`boolean`	`isUnderlined()` Returns if char 0 is underlined.
`int`	`length()` Returns the length, in characters, of the XString associated with this RMText.
`java.util.List<RMText>`	`paginate()` Paginates this text by creating linked texts to show all text and returns a list of this text and the linked texts.
`void`	`paintShape(com.reportmill.shape.RMShapePainter aPainter, java.awt.Graphics2D g)` Paints a text shape.
`void`	`peerDidChange(RMShape aShape)` This notification method is called when any peer is changed.
`void`	`repaint()` Editor method - passes on repaints to linked text.
`void`	`resolvePageReferences(com.reportmill.base.ReportMill aReportMill, java.lang.Object userInfo)` Re-does the RPG clone to resolve any @Page@ keys (assumed to be present in userInfo).
`void`	`scaleFonts(float aFactor)` Resizes all the font's in text string by given factor.
`void`	`setAlign(int align)` Sets the align for all chars.
`void`	`setAlignVertical(byte anAlignment)` Sets the vertical alignment.
`void`	`setAlignVerticalString(java.lang.String aString)` Sets the vertical alignment by a string (one of "top", "middle" or "bottom").
`void`	`setCharSpacing(float aValue)` Sets the char spacing for the text string.
`void`	`setCoalesceNewlines(boolean aFlag)` Sets whether text should coalesce consecutive newlines in rpgClone.
`void`	`setDrawsSelectionRect(boolean aValue)` Sets whether text should always draw at least a light-gray border (useful when editing).
`void`	`setFont(RMFont aFont)` Sets the font for all characters.
`void`	`setFormat(RMFormat aFormat)` Sets the format for all characters.
`void`	`setHeightToFit(float aValue)` Sets the text's height to fit (often called with -1 to force recalc).
`void`	`setLineGap(float aHeight)` Sets the line gap for all chars.
`void`	`setLineHeightMax(float aHeight)` Sets the maximum line height for all chars.
`void`	`setLineHeightMin(float aHeight)` Sets the minimum line height for all chars.
`void`	`setLineSpacing(float aHeight)` Sets the line spacing for all chars.
`void`	`setLinkedText(com.reportmill.shape.RMLinkedText anLinkedText)` Sets the linked text for this text (if any).
`void`	`setMargin(java.awt.Insets aMargin)` Sets margin.
`void`	`setMarginString(java.lang.String aString)` Sets the margin as a string.
`void`	`setObject(java.lang.Object anObj)` Sets an object for text to perform substitution on.
`void`	`setOutline(RMXString.Outline anOutline)` Sets the Outline for all characters.
`void`	`setPathShape(RMShape aShape)` Sets the shape that provides the path for this text to wrap text to.
`void`	`setPerformsWrap(boolean aFlag)` Sets whether text should wrap around other shapes that cause wrap.
`void`	`setRadius(float aValue)` Overrides rectangle implementation to potentially force text relayout.
`void`	`setReportMill(com.reportmill.base.ReportMill aReportMill)` This method handles basic (non-wrapping) rpgCloning for RMText, with key substitution.
`void`	`setText(java.lang.String aString)` Replaces the current text associated with this RMText with the given String.
`void`	`setTextColor(RMColor aColor)` Sets the color of the characters in the XString associated with this RMText.
`void`	`setUnderlined(boolean aFlag)` Sets all chars to be underlined.
`void`	`setWraps(byte aValue)` Sets the wrapping behavior for over-filled rpgCloned text (NONE, WRAP, SHRINK).
`void`	`setXString(RMXString xString)` Sets the XString associated with this RMText.
`boolean`	`superSelectable()` Editor method - indicates that this shape can be super selected.
`void`	`textDidChange()` Sends Text property changed event.
`java.lang.String`	`toString()` Standard toSring implementation.
`com.reportmill.archiver.RXElement`	`toXMLShape(com.reportmill.archiver.RXArchiver anArchiver, java.lang.Object anOwner)` XML archival.

Methods inherited from class com.reportmill.shape.RMRectangle
getRadius

Methods inherited from class com.reportmill.shape.RMShape
acceptsChildren, acceptsMouse, addBinding, addChild, addChild, addChild, addChild, animUpdate, bounds, bringShapesToFront, checkBindings, childrenSuperSelectImmediately, cloneDeep, contains, convertedPointFromShape, convertedPointToShape, convertedRectFromShape, convertedRectToShape, convertedSizeFromShape, convertedSizeToShape, convertedVectorFromShape, convertedVectorToShape, convertFromShape, convertPathFromShape, convertPathToShape, convertPointFromShape, convertPointToShape, convertRectFromShape, convertRectToShape, convertSizeFromShape, convertSizeToShape, convertToShape, convertVectorFromShape, convertVectorToShape, copyShape, createDivideShapeRemainder, createLayout, createPartClone, divideShapeFromEdge, divideShapeFromTop, doLayout, firePropertyChange, fromXML, fromXMLShapeChildren, fromXMLShapeLayout, get, get, getAction, getAncestor, getAncestorCount, getAncestorInCommon, getAnim, getAnim, getAnimator, getAnimator, getAspectMapped, getAspects, getAutosizing, getAutosizingDefault, getBinder, getBinding, getBinding, getBindingCount, getBounds, getBoundsInside, getBoundsMarked, getBoundsMarkedDeep, getBoundsOfChildren, getCausesWrap, getCausesWrapType, getChild, getChildAnimator, getChildAnimator, getChildArray, getChildClipShape, getChildContaining, getChildCount, getChildLast, getChildren, getChildrenIntersecting, getChildrenWhoCauseWrap, getChildrenWithClass, getChildrenWithClass, getChildWithClass, getChildWithName, getClipShape, getColor, getDatasetEntity, getDatasetKey, getDocument, getEffect, getFill, getFloat, getFrame, getFrame, getFrameMaxX, getFrameMaxY, getFrameX, getFrameXY, getFrameY, getHeight, getHover, getImageFill, getLayout, getLineWidth, getMaximumSize, getMaximumSizeProperty, getMaxX, getMaxY, getMinimumSize, getMinimumSizeProperty, getName, getOpacity, getOpacityDeep, getOriginal, getPageBreak, getPageBreakMax, getPageBreakPage, getPageBreakPageMax, getPageShape, getParent, getParentWithClass, getPart, getPartCount, getPartDeep, getPartDeepCount, getPreferredSize, getPreferredSizeProperty, getPreferredSizeX, getReportMill, getRoll, getRootShape, getScaleX, getScaleY, getShapesToAncestor, getShapesToDescendant, getShapesToShape, getSize, getSizeP, getSkewX, getSkewY, getStroke, getStrokeColor, getStrokeWidth, getTransform, getTransformFromShape, getTransformInverse, getTransformToShape, getUndoer, getUrl, getVisbileBounds, getVisibleBounds, getVisibleBounds, getVisibleBounds, getWidth, getX, getXY, getXYP, getY, height, indexOf, indexOfChild, intersects, isAncestor, isAnimProperty, isDescendant, isEditing, isHittable, isHittableChild, isLocked, isMouseDown, isMouseOver, isRoot, isShowing, isValid, isViewing, isVisible, isVisibleChild, isVisibleDeep, layoutReset, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, notRSS, offsetChildrenXY, offsetXY, page, pageMax, paint, paintShapeAll, paintShapeChildren, paintShapeOver, propertyChange, put, removeBinding, removeBinding, removeChild, removeChild, removeChildren, removeFromParent, repaint, revalidate, sendShapesToBack, setAction, setAutosizing, setBounds, setBounds, setCausesWrap, setCausesWrapType, setColor, setEffect, setFill, setFrame, setFrame, setFrameSize, setFrameX, setFrameXY, setFrameXY, setFrameY, setHeight, setHeightToFit, setHover, setLayout, setLayoutEnabled, setLineWidth, setLocked, setMaximumSize, setMinimumSize, setName, setOpacity, setParent, setPreferredSize, setReportMillBindings, setReportMillDeep, setRoll, setScaleX, setScaleXY, setScaleY, setSize, setSize, setSizeP, setSizeToFit, setSizeToFit, setSkewX, setSkewXY, setSkewY, setStroke, setStrokeColor, setStrokeWidth, setTime, setUrl, setVisible, setWidth, setX, setXY, setXY, setXYP, setY, shapeHidden, shapeShown, toXML, toXMLShapeChildren, toXMLShapeLayout, undoerDisable, undoerEnable, undoerSetUndoTitle, validate, width, x, y

Methods inherited from class com.reportmill.base.RMObject
addListener, addPropertyChangeListener, firePropertyChange, getListener, getListenerCount, getListeners, isFirePropertyChangeEnabled, isUndoing, removeListener, removePropertyChangeListener, setFirePropertyChangeEnabled, setUndoing

Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ALIGN_LEFT
```
public static final byte ALIGN_LEFT
```
    See Also:
    Constant Field Values
  - ALIGN_CENTER
```
public static final byte ALIGN_CENTER
```
    See Also:
    Constant Field Values
  - ALIGN_RIGHT
```
public static final byte ALIGN_RIGHT
```
    See Also:
    Constant Field Values
  - ALIGN_FULL
```
public static final byte ALIGN_FULL
```
    See Also:
    Constant Field Values
  - ALIGN_TOP
```
public static final byte ALIGN_TOP
```
    See Also:
    Constant Field Values
  - ALIGN_MIDDLE
```
public static final byte ALIGN_MIDDLE
```
    See Also:
    Constant Field Values
  - ALIGN_BOTTOM
```
public static final byte ALIGN_BOTTOM
```
    See Also:
    Constant Field Values
  - WRAP_NONE
```
public static final byte WRAP_NONE
```
    See Also:
    Constant Field Values
  - WRAP_BASIC
```
public static final byte WRAP_BASIC
```
    See Also:
    Constant Field Values
  - WRAP_SCALE
```
public static final byte WRAP_SCALE
```
    See Also:
    Constant Field Values
- Constructor Detail
  - RMText
```
public RMText()
```
    Creates an empty text instance.
  - RMText
```
public RMText(RMXString string)
```
    Creates a text instance initialized with the given RMXString.
  - RMText
```
public RMText(java.lang.String plainText)
```
    Creates a text instance initialized with the given plain text String.
- Method Detail
  - getXString
```
public RMXString getXString()
```
    Returns the XString associated with this RMText.
  - setXString
```
public void setXString(RMXString xString)
```
    Sets the XString associated with this RMText.
  - length
```
public int length()
```
    Returns the length, in characters, of the XString associated with this RMText.
  - getText
```
public java.lang.String getText()
```
    Returns the text associated with this RMText as a plain String.
  - setText
```
public void setText(java.lang.String aString)
```
    Replaces the current text associated with this RMText with the given String.
  - getVisibleStart
```
public int getVisibleStart()
```
    Returns the first character index visible in this text.
  - getVisibleEnd
```
public int getVisibleEnd()
```
    Returns the last character index visible in this text.
  - isAllTextVisible
```
public boolean isAllTextVisible()
```
    Returns whether all characters can be visibly rendered in text bounds.
  - getFont
```
public RMFont getFont()
```
    Returns the font for char 0.
    
    Overrides:
    
    getFont in class RMShape
  - setFont
```
public void setFont(RMFont aFont)
```
    Sets the font for all characters.
    
    Overrides:
    
    setFont in class RMShape
  - getFormat
```
public RMFormat getFormat()
```
    Returns the format for char 0.
    
    Overrides:
    
    getFormat in class RMShape
  - setFormat
```
public void setFormat(RMFormat aFormat)
```
    Sets the format for all characters.
    
    Overrides:
    
    setFormat in class RMShape
  - getTextColor
```
public RMColor getTextColor()
```
    Returns the color of the first character of the xstring associated with this RMText.
    
    Overrides:
    
    getTextColor in class RMShape
  - setTextColor
```
public void setTextColor(RMColor aColor)
```
    Sets the color of the characters in the XString associated with this RMText.
    
    Overrides:
    
    setTextColor in class RMShape
  - isUnderlined
```
public boolean isUnderlined()
```
    Returns if char 0 is underlined.
    
    Overrides:
    
    isUnderlined in class RMShape
  - setUnderlined
```
public void setUnderlined(boolean aFlag)
```
    Sets all chars to be underlined.
    
    Overrides:
    
    setUnderlined in class RMShape
  - getOutline
```
public RMXString.Outline getOutline()
```
    Returns the outline for char 0.
    
    Overrides:
    
    getOutline in class RMShape
  - setOutline
```
public void setOutline(RMXString.Outline anOutline)
```
    Sets the Outline for all characters.
    
    Overrides:
    
    setOutline in class RMShape
  - getAlign
```
public byte getAlign()
```
    Returns the alignment for char 0.
  - setAlign
```
public void setAlign(int align)
```
    Sets the align for all chars.
  - getAlignString
```
public java.lang.String getAlignString()
```
    Returns the alignment as a string, one of: "left", "center" or "right".
  - getAlignVertical
```
public byte getAlignVertical()
```
    Returns the vertical alignment.
  - setAlignVertical
```
public void setAlignVertical(byte anAlignment)
```
    Sets the vertical alignment.
  - getAlignVerticalString
```
public java.lang.String getAlignVerticalString()
```
    Returns the vertical alignment as a string (one of: "top", "middle" or "bottom").
  - setAlignVerticalString
```
public void setAlignVerticalString(java.lang.String aString)
```
    Sets the vertical alignment by a string (one of "top", "middle" or "bottom").
  - getWraps
```
public byte getWraps()
```
    Returns the wrapping behavior for over-filled rpgCloned text (NONE, WRAP, SHRINK).
  - setWraps
```
public void setWraps(byte aValue)
```
    Sets the wrapping behavior for over-filled rpgCloned text (NONE, WRAP, SHRINK).
  - getPerformsWrap
```
public boolean getPerformsWrap()
```
    Returns whether text should wrap around other shapes that cause wrap.
  - setPerformsWrap
```
public void setPerformsWrap(boolean aFlag)
```
    Sets whether text should wrap around other shapes that cause wrap.
  - getCoalesceNewlines
```
public boolean getCoalesceNewlines()
```
    Returns whether text should coalesce consecutive newlines in rpgClone.
  - setCoalesceNewlines
```
public void setCoalesceNewlines(boolean aFlag)
```
    Sets whether text should coalesce consecutive newlines in rpgClone.
  - getDrawsSelectionRect
```
public boolean getDrawsSelectionRect()
```
    Returns whether text should always draw at least a light gray border (useful when editing).
  - setDrawsSelectionRect
```
public void setDrawsSelectionRect(boolean aValue)
```
    Sets whether text should always draw at least a light-gray border (useful when editing).
  - getCharSpacing
```
public float getCharSpacing()
```
    Returns the char spacing at char 0.
  - setCharSpacing
```
public void setCharSpacing(float aValue)
```
    Sets the char spacing for the text string.
  - getLineSpacing
```
public float getLineSpacing()
```
    Returns the line spacing at char 0.
  - setLineSpacing
```
public void setLineSpacing(float aHeight)
```
    Sets the line spacing for all chars.
  - getLineGap
```
public float getLineGap()
```
    Returns the line gap at char 0.
  - setLineGap
```
public void setLineGap(float aHeight)
```
    Sets the line gap for all chars.
  - getLineHeightMin
```
public float getLineHeightMin()
```
    Returns the minimum line height at char 0.
  - setLineHeightMin
```
public void setLineHeightMin(float aHeight)
```
    Sets the minimum line height for all chars.
  - getLineHeightMax
```
public float getLineHeightMax()
```
    Returns the maximum line height at char 0.
  - setLineHeightMax
```
public void setLineHeightMax(float aHeight)
```
    Sets the maximum line height for all chars.
  - getMargin
```
public java.awt.Insets getMargin()
```
    Returns margin.
  - setMargin
```
public void setMargin(java.awt.Insets aMargin)
```
    Sets margin.
  - getMarginDefault
```
public java.awt.Insets getMarginDefault()
```
    Returns the default margin of the text (top=1, left=2, right=2, bottom=0).
  - getMarginString
```
public java.lang.String getMarginString()
```
    Returns the margin as a string.
  - setMarginString
```
public void setMarginString(java.lang.String aString)
```
    Sets the margin as a string.
  - getMarginLeft
```
public int getMarginLeft()
```
    Returns the left margin of the text (default to 2).
  - getMarginRight
```
public int getMarginRight()
```
    Returns the right margin of the text (defaults to 2).
  - getMarginTop
```
public int getMarginTop()
```
    Returns the top margin of the text (defaults to 1).
  - getMarginBottom
```
public int getMarginBottom()
```
    Returns the bottom margin of the text (defaults to 0).
  - getTextBounds
```
public RMRect getTextBounds()
```
    Returns the actual bounding rect of the text (currently just inset 2 pixels on either side).
  - getBoundsFromTextBounds
```
public RMRect getBoundsFromTextBounds(RMRect aRect)
```
    Returns bounds from given text bounds, adjusted to account for text margins.
  - getPath
```
public RMPath getPath()
```
    Returns the path for this shape.
    
    Overrides:
    
    getPath in class RMRectangle
  - getPathInBounds
```
public RMPath getPathInBounds()
```
    Overrides shape implementation to pass through getPathInBounds(inset).
    
    Overrides:
    
    getPathInBounds in class RMShape
  - getPathInBounds
```
public RMPath getPathInBounds(int inset)
```
    Returns the shape's path scaled to the shape's current bounds.
  - textDidChange
```
public void textDidChange()
```
    Sends Text property changed event.
  - peerDidChange
```
public void peerDidChange(RMShape aShape)
```
    This notification method is called when any peer is changed.
  - getPathShape
```
public RMShape getPathShape()
```
    Returns the shape that provides the path for this text to wrap text to.
  - setPathShape
```
public void setPathShape(RMShape aShape)
```
    Sets the shape that provides the path for this text to wrap text to.
  - setRadius
```
public void setRadius(float aValue)
```
    Overrides rectangle implementation to potentially force text relayout.
    
    Overrides:
    
    setRadius in class RMRectangle
  - getLinkedText
```
public com.reportmill.shape.RMLinkedText getLinkedText()
```
    Returns the linked text for this text (if any).
  - setLinkedText
```
public void setLinkedText(com.reportmill.shape.RMLinkedText anLinkedText)
```
    Sets the linked text for this text (if any).
  - getTextLayout
```
public com.reportmill.text.RMTextLayout getTextLayout()
```
    Returns a text layout configured for this text, with layout already performed.
  - getTextLayout
```
public com.reportmill.text.RMTextLayout getTextLayout(boolean performLayout)
```
    Returns a text layout configured for this text, with an option to perform layout.
  - getPreferredSizeImpl
```
public RMSize getPreferredSizeImpl()
```
    Override to return layout preferred size (unless this text is scaling fonts to fit).
    
    Overrides:
    
    getPreferredSizeImpl in class RMShape
  - getWidthToFit
```
public float getWidthToFit()
```
    Returns the ideal width for this RMText.
  - getHeightToFit
```
public float getHeightToFit()
```
    Returns the ideal height for this RMText.
  - getHeightToFit
```
public float getHeightToFit(boolean includeFinalEmptyLine)
```
    Returns the ideal height for this RMText. Provides an option to include the height of trailing newlines.
  - setHeightToFit
```
public void setHeightToFit(float aValue)
```
    Sets the text's height to fit (often called with -1 to force recalc).
  - scaleFonts
```
public void scaleFonts(float aFactor)
```
    Resizes all the font's in text string by given factor.
  - setReportMill
```
public void setReportMill(com.reportmill.base.ReportMill aReportMill)
```
    This method handles basic (non-wrapping) rpgCloning for RMText, with key substitution.
    
    Overrides:
    
    setReportMill in class RMShape
  - getObject
```
public java.lang.Object getObject()
```
    Bogus accessor to provide type information for setObject.
  - setObject
```
public void setObject(java.lang.Object anObj)
```
    Sets an object for text to perform substitution on.
  - paginate
```
public java.util.List<RMText> paginate()
```
    Paginates this text by creating linked texts to show all text and returns a list of this text and the linked texts.
  - resolvePageReferences
```
public void resolvePageReferences(com.reportmill.base.ReportMill aReportMill,
                         java.lang.Object userInfo)
```
    Re-does the RPG clone to resolve any @Page@ keys (assumed to be present in userInfo).
    
    Overrides:
    
    resolvePageReferences in class RMShape
  - getMaskPath
```
public RMPath getMaskPath()
```
    Overridden from RMShape to provide the outlines of all the glyphs
    
    Overrides:
    
    getMaskPath in class RMShape
  - superSelectable
```
public boolean superSelectable()
```
    Editor method - indicates that this shape can be super selected.
    
    Overrides:
    
    superSelectable in class RMShape
  - isStructured
```
public boolean isStructured()
```
    Editor method.
  - repaint
```
public void repaint()
```
    Editor method - passes on repaints to linked text.
    
    Overrides:
    
    repaint in class RMShape
  - paintShape
```
public void paintShape(com.reportmill.shape.RMShapePainter aPainter,
              java.awt.Graphics2D g)
```
    Paints a text shape.
    
    Overrides:
    
    paintShape in class RMShape
  - copyText
```
public void copyText(RMText aText)
```
    Copies attributes from given object.
  - equals
```
public boolean equals(java.lang.Object anObj)
```
    Standard equals implementation.
    
    Overrides:
    
    equals in class RMRectangle
  - clone
```
public RMText clone()
```
    Standard clone implementation.
    
    Overrides:
    
    clone in class RMShape
  - toXMLShape
```
public com.reportmill.archiver.RXElement toXMLShape(com.reportmill.archiver.RXArchiver anArchiver,
                                           java.lang.Object anOwner)
```
    XML archival.
    
    Overrides:
    
    toXMLShape in class RMRectangle
  - fromXMLShape
```
public java.lang.Object fromXMLShape(com.reportmill.archiver.RXArchiver anArchiver,
                            com.reportmill.archiver.RXElement anElement,
                            java.lang.Object anOwner)
```
    XML unarchival.
    
    Overrides:
    
    fromXMLShape in class RMRectangle
  - fromXMLFinish
```
public void fromXMLFinish(com.reportmill.archiver.RXArchiver anArchiver,
                 com.reportmill.archiver.RXElement anElement)
```
    XML reference unarchival - to unarchive linked text.
  - toString
```
public java.lang.String toString()
```
    Standard toSring implementation.
    
    Overrides:
    
    toString in class RMShape

Class RMText

Field Summary

Fields inherited from class com.reportmill.shape.RMShape

Constructor Summary

Method Summary

Methods inherited from class com.reportmill.shape.RMRectangle

Methods inherited from class com.reportmill.shape.RMShape

Methods inherited from class com.reportmill.base.RMObject

Methods inherited from class java.lang.Object

Field Detail

ALIGN_LEFT

ALIGN_CENTER

ALIGN_RIGHT

ALIGN_FULL

ALIGN_TOP

ALIGN_MIDDLE

ALIGN_BOTTOM

WRAP_NONE

WRAP_BASIC

WRAP_SCALE

Constructor Detail

RMText

RMText

RMText

Method Detail

getXString

setXString

length

getText

setText

getVisibleStart

getVisibleEnd

isAllTextVisible

getFont

setFont

getFormat

setFormat

getTextColor

setTextColor

isUnderlined

setUnderlined

getOutline

setOutline

getAlign

setAlign

getAlignString

getAlignVertical

setAlignVertical

getAlignVerticalString

setAlignVerticalString

getWraps

setWraps

getPerformsWrap

setPerformsWrap

getCoalesceNewlines

setCoalesceNewlines

getDrawsSelectionRect

setDrawsSelectionRect

getCharSpacing

setCharSpacing

getLineSpacing

setLineSpacing

getLineGap

setLineGap

getLineHeightMin

setLineHeightMin

getLineHeightMax

setLineHeightMax

getMargin

setMargin

getMarginDefault

getMarginString

setMarginString

getMarginLeft

getMarginRight

getMarginTop

getMarginBottom

getTextBounds

getBoundsFromTextBounds

getPath