public class RMXString extends RMObject
You might use it like this:
RMXString xstring = new RMXString("Hello World", RMColor.red); xstring.addAttribute(RMFont.getFont("Arail Bold", 12), 0, 5); xstring.addAttribute(RMFont.getFont("Arial BoldItalic", 12), 6, xstring.length());
Advanced applications, that need to disect or render strings, might iterate over the runs like this:
for(int i=0; i
Modifier and Type | Class and Description |
---|---|
static class |
RMXString.Outline
The Outline inner class represents the attributes of outlined text: strokeWidth and fillColor.
|
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CHAR_SPACING_KEY |
static java.lang.String |
COLOR_KEY |
static java.lang.String |
FONT_KEY |
static java.lang.String |
FONT_SCALE_KEY |
static java.lang.String |
FORMAT_KEY |
static java.lang.String |
OUTLINE_KEY |
static java.lang.String |
PARAGRAPH_KEY |
static java.lang.String |
SCRIPTING_KEY |
static java.lang.String |
UNDERLINE_KEY |
Constructor and Description |
---|
RMXString()
Creates an empty RMXString.
|
RMXString(java.lang.String aString)
Creates an RMXString intialized with the given String and no attributes.
|
RMXString(java.lang.String aString,
java.util.Map attrs)
Creates an RMXString initialized with the given String with all characters set to the given attributes.
|
RMXString(java.lang.String aString,
java.lang.Object anAttr)
Creates an RMXString initialized with the given String with all characters set to the given
attribute (should be a common attribute type like RMFont, RMColor, RMFormat, etc.).
|
RMXString(java.lang.String aString,
java.lang.Object[] attrs)
Creates an RMXString initialized with the given String with all characters set to the given
attributes objects in object array (should be common attribute types like RMFont, RMColor, RMFormat, etc.).
|
Modifier and Type | Method and Description |
---|---|
void |
add(RMXString xString)
Appends the given XString to the end of this String.
|
void |
add(RMXString xString,
int anIndex)
Appends the given XString to this XString, at the given index.
|
void |
add(java.lang.String aString)
Appends the given String to the end of this XString.
|
void |
add(java.lang.String aString,
int anIndex)
Appends the given String to this XString, at the given index.
|
void |
add(java.lang.String aString,
java.util.Map attrs)
Appends the given string to the end of this XString, with the given attributes.
|
void |
add(java.lang.String aString,
java.util.Map attrs,
int anIndex)
Appends the given String to this XString, with the given attributes, at the given index.
|
void |
addAttribute(java.lang.Object attr)
Applies the given attribute to whole xstring, assuming it's a basic attr types (font, color, etc.).
|
void |
addAttribute(java.lang.Object attr,
int start,
int end)
Applies the given attribute to the given character range, assuming it's a basic attr type (font, color, etc.).
|
void |
addAttribute(java.lang.String aKey,
java.lang.Object object)
Adds a given attribute of given type to the whole string.
|
void |
addAttribute(java.lang.String aKey,
java.lang.Object attr,
int start,
int end)
Adds a given attribute of given type to the given range of the string.
|
void |
addAttribute(java.lang.String aKey,
java.lang.Object attr,
int start,
int end,
boolean ifAbsent)
Adds a given attribute of given type to the given range of the string, only if specified type is missing.
|
void |
addAttributes(java.util.Map attrs,
int start,
int end)
Adds the attributes in the given map to the specified character range.
|
void |
addAttributes(java.util.Map attrs,
int start,
int end,
boolean ifAbsent)
Adds the attributes in the given map to the specified character range.
|
void |
alignCenter()
Aligns the xstring center.
|
void |
alignLeft()
Aligns the xstring left.
|
void |
alignRight()
Aligns the xstring right.
|
RMXString |
blend(RMXString aString,
float fraction)
Returns a blended version of the receiver and the given string (0 is receiver, 1 is given string).
|
char |
charAt(int anIndex)
Returns the character at the given index.
|
java.lang.Object |
clone()
Returns a clone of the receiver.
|
void |
coalesceNewlines()
Replaces any occurrance of consecutive newlines with a single newline.
|
void |
delete(int start,
int end)
Deletes the chars in the given range.
|
void |
didChange()
Notifies string that something significant changed.
|
boolean |
equals(java.lang.Object anObj)
Standard Object equals implementation.
|
java.lang.Object |
fromXML(RXArchiver anArchiver,
RXElement anElement)
XML unarchival.
|
byte |
getAlign()
Returns the horizontal alignment of the first paragraph of the xstring.
|
java.lang.Object |
getAttributeAt(java.lang.String aKey,
int anIndex)
Returns the value for the given attribute key at the given character index.
|
java.util.Map |
getAttributes(int anIndex)
Returns the attributes Map for the run at the given index.
|
java.util.Map |
getAttributesAt(int anIndex)
Returns the attributes Map for the run at the given character index.
|
RMColor |
getColorAtIndex(int index)
Returns the current color at the given character index.
|
RMFont |
getFontAtIndex(int index)
Returns the current font at the given character index.
|
float |
getFontScale()
Returns the value that should be multipied times all font sizes in this string (defaults to 1).
|
RMFormat |
getFormatAtIndex(int index)
Returns the current format at the given character index.
|
RMParagraph |
getParagraphAtIndex(int index)
Returns the current paragraph at the given character index.
|
RMXString |
getRepresentableString()
Returns a version of this string that substitutes alternate fonts for any characters that cannot be displayed in
their associated fonts (simply returns the receiver if all characters are valid).
|
RMXStringRun |
getRun(int anIndex)
Returns the specific Run at the given index in this XString.
|
RMXStringRun |
getRunAt(int anIndex)
Returns the XString run at the given index.
|
RMXStringRun |
getRunAtExactly(int anIndex)
Returns an XString run for the given character index, potentially splitting an existing run to ensure
that new run starts at the given index.
|
int |
getRunCount()
Returns the number of runs in this XString.
|
int |
getRunIndexAt(int anIndex)
Returns the XString run index for the given character index.
|
int |
getRunIndexAtExactly(int anIndex)
Returns an XString segement index for the given character index, potentially splitting an existing run to ensure
that new run starts at the given index.
|
RMXStringRun |
getRunLast()
Returns the last run in this XString (convenience).
|
int |
getVersion()
Returns the version of this xstring.
|
static RMXString |
getXStringForHTML(java.lang.String html,
RMFont aFont)
Creates and returns an XString from a given HTML String.
|
static RMXString |
getXStringForRTF(java.lang.String rtf,
RMFont aFont)
Creates and returns an XString from a given RTF String.
|
int |
indexOf(java.lang.String aString)
Returns the index within this string of the first occurrence of the given substring.
|
int |
indexOf(java.lang.String aString,
int start)
Returns the index within this string of first occurrence of given substring, starting at given index.
|
java.lang.Object |
initWithArchiver(RMArchiver anArchiver)
Legacy archival.
|
int |
length()
Returns the number of characters associated with this RMXString.
|
void |
removeAttribute(java.lang.String aKey,
int start,
int end)
Removes any attribute of the specified type from the specified range of the string.
|
void |
replace(int start,
int end,
RMXString xString)
Replaces the chars in given range, with given XString.
|
void |
replace(int start,
int end,
java.lang.String aString)
Replaces chars in given range, with given String.
|
void |
replace(int start,
int end,
java.lang.String aString,
java.util.Map attrs)
Replaces chars in given range, with given String, using the given attributes.
|
void |
replace(java.lang.String aString)
Replaces all chars of this XString with given String.
|
RMXString |
rpgClone(ReportMill aReportMill,
java.lang.Object userInfo,
RMShape aShape)
Creates a clone of the receiver, with substitution performed on @-sign deliniated keys.
|
java.util.Vector |
separate(java.lang.String aSeparator)
Returns a List of XString substrings of this XString that are separated by the given separator String.
|
void |
setAlign(int align)
Sets the horizontal alignment of the xstring.
|
void |
setFontScale(float aScale)
Sets a value to that should be multiplied times all font sizes in this string.
|
void |
setOutlined(boolean flag)
Sets the xstring to be outlined.
|
void |
setParagraph(RMParagraph ps,
int start)
Sets the paragraph at the given character index.
|
void |
setParagraph(RMParagraph ps,
int start,
int end)
Sets the paragraph for the given character index range.
|
void |
setUnderlined(boolean flag)
Sets the xstring to be underlined.
|
java.lang.String |
string()
Returns the plain String associated with this RMXString.
|
RMXString |
substring(int index)
Returns the substring from the given index to end of XString.
|
RMXString |
substring(int start,
int end)
Returns the substring from the given start index to the given end index.
|
java.lang.String |
toString()
Returns the String associated with this XString.
|
java.lang.String |
toStringXML()
Returns an XML style string representation of the attributes and string runs in this XString.
|
RXElement |
toXML(RXArchiver anArchiver)
XML archival.
|
copy, didChange, didUndo, getAnimAttribute, getClassNameShort, undoClone, undoCopy, undoEquals
public static final java.lang.String FONT_KEY
public static final java.lang.String COLOR_KEY
public static final java.lang.String FORMAT_KEY
public static final java.lang.String UNDERLINE_KEY
public static final java.lang.String OUTLINE_KEY
public static final java.lang.String PARAGRAPH_KEY
public static final java.lang.String FONT_SCALE_KEY
public static final java.lang.String SCRIPTING_KEY
public static final java.lang.String CHAR_SPACING_KEY
public RMXString()
public RMXString(java.lang.String aString)
public RMXString(java.lang.String aString, java.util.Map attrs)
public RMXString(java.lang.String aString, java.lang.Object anAttr)
public RMXString(java.lang.String aString, java.lang.Object[] attrs)
public java.lang.String string()
public int length()
public int indexOf(java.lang.String aString)
public int indexOf(java.lang.String aString, int start)
public char charAt(int anIndex)
public int getRunCount()
public RMXStringRun getRun(int anIndex)
public RMXStringRun getRunLast()
public java.util.Map getAttributes(int anIndex)
public java.lang.Object getAttributeAt(java.lang.String aKey, int anIndex)
public java.util.Map getAttributesAt(int anIndex)
public void addAttributes(java.util.Map attrs, int start, int end)
public void addAttributes(java.util.Map attrs, int start, int end, boolean ifAbsent)
public void addAttribute(java.lang.String aKey, java.lang.Object object)
public void addAttribute(java.lang.String aKey, java.lang.Object attr, int start, int end)
public void addAttribute(java.lang.String aKey, java.lang.Object attr, int start, int end, boolean ifAbsent)
public void removeAttribute(java.lang.String aKey, int start, int end)
public RMFont getFontAtIndex(int index)
public RMColor getColorAtIndex(int index)
public RMFormat getFormatAtIndex(int index)
public RMParagraph getParagraphAtIndex(int index)
public void setParagraph(RMParagraph ps, int start)
public void setParagraph(RMParagraph ps, int start, int end)
public void addAttribute(java.lang.Object attr)
public void addAttribute(java.lang.Object attr, int start, int end)
public float getFontScale()
public void setFontScale(float aScale)
public void add(java.lang.String aString)
public void add(java.lang.String aString, int anIndex)
public void add(RMXString xString)
public void add(RMXString xString, int anIndex)
public void add(java.lang.String aString, java.util.Map attrs)
public void add(java.lang.String aString, java.util.Map attrs, int anIndex)
public void replace(java.lang.String aString)
public void replace(int start, int end, java.lang.String aString)
public void replace(int start, int end, java.lang.String aString, java.util.Map attrs)
public void replace(int start, int end, RMXString xString)
public void delete(int start, int end)
public RMXString substring(int index)
public RMXString substring(int start, int end)
public java.util.Vector separate(java.lang.String aSeparator)
public void coalesceNewlines()
public static RMXString getXStringForHTML(java.lang.String html, RMFont aFont)
public static RMXString getXStringForRTF(java.lang.String rtf, RMFont aFont)
public RMXStringRun getRunAt(int anIndex)
public int getRunIndexAt(int anIndex)
public RMXStringRun getRunAtExactly(int anIndex)
public int getRunIndexAtExactly(int anIndex)
public void didChange()
public void setUnderlined(boolean flag)
public void setOutlined(boolean flag)
public byte getAlign()
public void setAlign(int align)
public void alignLeft()
public void alignRight()
public void alignCenter()
public int getVersion()
public RMXString getRepresentableString()
public java.lang.Object clone()
public boolean equals(java.lang.Object anObj)
equals
in class java.lang.Object
public RMXString rpgClone(ReportMill aReportMill, java.lang.Object userInfo, RMShape aShape)
public RMXString blend(RMXString aString, float fraction)
public java.lang.Object initWithArchiver(RMArchiver anArchiver)
initWithArchiver
in interface RMArchiver.Archiving
initWithArchiver
in class RMObject
public RXElement toXML(RXArchiver anArchiver)
public java.lang.Object fromXML(RXArchiver anArchiver, RXElement anElement)
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String toStringXML()