public class RMTextShape extends RMRectShape
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();
RMTypes.Align, RMTypes.AlignX, RMTypes.AlignY
Modifier and Type | Field and Description |
---|---|
static byte |
WRAP_BASIC |
static byte |
WRAP_NONE |
static byte |
WRAP_SCALE |
Constructor and Description |
---|
RMTextShape()
Creates an empty text instance.
|
RMTextShape(RMXString string)
Creates a text instance initialized with the given RMXString.
|
RMTextShape(java.lang.String plainText)
Creates a text instance initialized with the given plain text String.
|
Modifier and Type | Method and Description |
---|---|
void |
clearTextEditor()
Clears the text editor.
|
RMTextShape |
clone()
Standard clone implementation.
|
java.lang.Object |
fromXML(XMLArchiver anArchiver,
XMLElement anElement)
XML unarchival.
|
void |
fromXMLFinish(XMLArchiver anArchiver,
XMLElement anElement)
XML reference unarchival - to unarchive linked text.
|
RMTypes.AlignX |
getAlignmentX()
Returns the alignment for char 0.
|
RMTypes.AlignY |
getAlignmentY()
Returns the vertical alignment.
|
java.lang.String |
getAlignString()
Returns the alignment as a string, one of: "left", "center" or "right".
|
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 |
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.
|
RMLinkedText |
getLinkedText()
Returns the linked text for this text (if any).
|
Insets |
getMargin()
Returns margin.
|
int |
getMarginBottom()
Returns the bottom margin of the text (defaults to 0).
|
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).
|
Shape |
getPath()
Overrides shape implementation to get clip path.
|
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.
|
RichText |
getRichText()
Returns the RichText.
|
java.lang.String |
getText()
Returns the text associated with this RMText as a plain String.
|
Border |
getTextBorder()
Returns the border for char 0.
|
TextBox |
getTextBox()
Returns a text layout.
|
RMColor |
getTextColor()
Returns the color of the first character of the xstring associated with this RMText.
|
RMTextEditor |
getTextEditor()
Returns the text editor.
|
int |
getVisibleEnd()
Returns the last character index visible in this text.
|
int |
getVisibleStart()
Returns the first character index visible in this text.
|
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 |
isTextEditorSet()
Returns whether there is a text editor.
|
boolean |
isUnderlined()
Returns if char 0 is underlined.
|
int |
length()
Returns the length, in characters, of the XString associated with this RMText.
|
void |
paintShape(Painter aPntr)
Paints a text shape.
|
void |
peerDidChange(RMShape aShape)
This notification method is called when any peer is changed.
|
void |
propertyChange(PropChange anEvent)
Override to catch XString and TextEditor changes.
|
void |
revalidate()
Override to do home-brew layout.
|
void |
setAlignmentX(RMTypes.AlignX anAlignX)
Sets the align for all chars.
|
void |
setAlignmentY(RMTypes.AlignY anAlignment)
Sets the vertical alignment.
|
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 |
setHeight(double aValue)
Override to revalidate.
|
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(RMLinkedText aLinkedText)
Sets the linked text for this text (if any).
|
void |
setMargin(Insets aMargin)
Sets margin.
|
void |
setMarginString(java.lang.String aString)
Sets the margin as a string.
|
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 clear path shape.
|
void |
setText(java.lang.String aString)
Replaces the current text associated with this RMText with the given String.
|
void |
setTextBorder(Border aBorder)
Sets the border for all characters.
|
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 |
setWidth(double aValue)
Override to revalidate.
|
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.
|
java.lang.String |
toString()
Standard toSring implementation.
|
XMLElement |
toXML(XMLArchiver anArchiver)
XML archival.
|
getRadius
acceptsChildren, acceptsMouse, addBinding, addBinding, addDeepChangeListener, animUpdate, bounds, childrenSuperSelectImmediately, cloneDeep, contains, convertedPointFromShape, convertedPointToShape, convertFromShape, convertPointFromShape, convertPointToShape, convertRectFromShape, convertRectToShape, convertToShape, convertVectorFromShape, convertVectorToShape, copyShape, deepChange, divideShapeFromEdge, divideShapeFromTop, get, get, getAlignment, getAncestor, getAncestorCount, getAncestorInCommon, getAnimator, getAnimator, getAutosizing, getAutosizingDefault, getBestHeight, getBestWidth, getBinding, getBinding, getBindingCount, getBounds, getBoundsInside, getBoundsMarked, getBoundsMarkedDeep, getBoundsStroked, getBoundsStrokedDeep, getChild, getChildAnimator, getChildAnimator, getChildCount, getChildren, getClipShape, getColor, getConvertedFromShape, getConvertedRectFromShape, getConvertedRectToShape, getConvertedToShape, getDatasetEntity, getDatasetKey, getDocument, getEffect, getFill, getFrame, getFrameHeight, getFrameMaxX, getFrameMaxY, getFrameWidth, getFrameX, getFrameXY, getFrameY, getHeight, getMaxX, getMaxY, getMinHeight, getMinWidth, getName, getOpacity, getOpacityDeep, getPageBreak, getPageBreakMax, getPageBreakPage, getPageBreakPageMax, getPageShape, getParent, getParent, getPrefHeight, getPrefWidth, getPropNames, getRoll, getRootShape, getScaleX, getScaleY, getShapesToAncestor, getShapesToDescendant, getShapesToShape, getSize, getSkewX, getSkewY, getStroke, getStrokeColor, getStrokeOnTop, getStrokeWidth, getTimeline, getTimeline, getTransform, getTransformFromShape, getTransformInverse, getTransformToShape, getUndoer, getURL, getWidth, getX, getXY, getXYP, getY, height, indexOf, intersects, isAncestor, isAnimProperty, isDescendant, isEditing, isFontSet, isHittable, isLocked, isMinHeightSet, isMinWidthSet, isPrefHeightSet, isPrefWidthSet, isRoot, isRSS, isViewing, isVisible, offsetXY, page, pageMax, paint, paintShapeAll, paintShapeChildren, paintShapeOver, processEvent, put, removeBinding, removeBinding, removeDeepChangeListener, removeFromParent, repaint, rpgAll, rpgBindings, setAlignment, setAutosizing, setBestHeight, setBestSize, setBounds, setBounds, setColor, setEffect, setFill, setFrame, setFrame, setFrameSize, setFrameX, setFrameXY, setFrameXY, setFrameY, setLocked, setMinHeight, setMinSize, setMinWidth, setName, setOpacity, setParent, setPrefHeight, setPrefWidth, setRoll, setScaleX, setScaleXY, setScaleY, setSize, setSize, setSkewX, setSkewXY, setSkewY, setStroke, setStrokeColor, setStrokeWidth, setTime, setURL, setVisible, setX, setXY, setXY, setXYP, setY, undoerDisable, undoerEnable, undoerSetUndoTitle, width, x, y
public static final byte WRAP_NONE
public static final byte WRAP_BASIC
public static final byte WRAP_SCALE
public RMTextShape()
public RMTextShape(RMXString string)
public RMTextShape(java.lang.String plainText)
public RMXString getXString()
public void setXString(RMXString xString)
public RichText getRichText()
public int length()
public java.lang.String getText()
public void setText(java.lang.String aString)
public int getVisibleStart()
public int getVisibleEnd()
public boolean isAllTextVisible()
public void setFont(RMFont aFont)
public RMFormat getFormat()
public void setFormat(RMFormat aFormat)
public RMColor getTextColor()
getTextColor
in class RMShape
public void setTextColor(RMColor aColor)
setTextColor
in class RMShape
public boolean isUnderlined()
isUnderlined
in class RMShape
public void setUnderlined(boolean aFlag)
setUnderlined
in class RMShape
public Border getTextBorder()
public void setTextBorder(Border aBorder)
public RMTypes.AlignX getAlignmentX()
getAlignmentX
in class RMShape
public void setAlignmentX(RMTypes.AlignX anAlignX)
setAlignmentX
in class RMShape
public java.lang.String getAlignString()
public RMTypes.AlignY getAlignmentY()
getAlignmentY
in class RMShape
public void setAlignmentY(RMTypes.AlignY anAlignment)
setAlignmentY
in class RMShape
public byte getWraps()
public void setWraps(byte aValue)
public boolean getPerformsWrap()
public void setPerformsWrap(boolean aFlag)
public boolean getCoalesceNewlines()
public void setCoalesceNewlines(boolean aFlag)
public boolean getDrawsSelectionRect()
public void setDrawsSelectionRect(boolean aValue)
public float getCharSpacing()
public void setCharSpacing(float aValue)
public float getLineSpacing()
public void setLineSpacing(float aHeight)
public float getLineGap()
public void setLineGap(float aHeight)
public float getLineHeightMin()
public void setLineHeightMin(float aHeight)
public float getLineHeightMax()
public void setLineHeightMax(float aHeight)
public Insets getMargin()
public void setMargin(Insets aMargin)
public Insets getMarginDefault()
public java.lang.String getMarginString()
public void setMarginString(java.lang.String aString)
public int getMarginLeft()
public int getMarginRight()
public int getMarginTop()
public int getMarginBottom()
public void setWidth(double aValue)
public void setHeight(double aValue)
public Shape getPath()
getPath
in class RMRectShape
public void peerDidChange(RMShape aShape)
public RMShape getPathShape()
public void setPathShape(RMShape aShape)
public void setRadius(float aValue)
setRadius
in class RMRectShape
public RMLinkedText getLinkedText()
public void setLinkedText(RMLinkedText aLinkedText)
public TextBox getTextBox()
public boolean isTextEditorSet()
public RMTextEditor getTextEditor()
public void clearTextEditor()
public boolean superSelectable()
superSelectable
in class RMShape
public boolean isStructured()
public void paintShape(Painter aPntr)
paintShape
in class RMShape
public void propertyChange(PropChange anEvent)
propertyChange
in class RMShape
public void revalidate()
public RMTextShape clone()
public XMLElement toXML(XMLArchiver anArchiver)
toXML
in class RMRectShape
public java.lang.Object fromXML(XMLArchiver anArchiver, XMLElement anElement)
fromXML
in class RMRectShape
public void fromXMLFinish(XMLArchiver anArchiver, XMLElement anElement)