ilog.views.util.text

Class IlvAttributedStringUtil

java.lang.Object

ilog.views.util.text.IlvAttributedStringUtil

public class IlvAttributedStringUtil
extends Object

The IlvAttributedStringUtil class consists of static methods that are of general use when working with java.text.AttributedString. This class is a singleton and instances of this class cannot be created.

Since:

JViews 8.0

Field Summary

Fields

Modifier and Type	Field and Description
static DataFlavor	ATTRIBUTED_STRING_FLAVOR Data flavor for attributed string selections.

Method Summary

Modifier and Type	Method and Description
static AttributedString	concat(AttributedString astring1, AttributedString astring2) Concatenates two attributed strings.
static AttributedString	concat(AttributedString astring1, AttributedString astring2, AttributedString astring3) Concatenates three attributed strings.
static AttributedString	concat(AttributedString astring, String suffix) Concatenates an attributed string with string suffix.
static AttributedString	concat(AttributedString astring1, String string2, AttributedString astring3) Inserts a normal string between two attributed strings.
static AttributedString	concat(String prefix, AttributedString astring) Concatenates an attributed string with string prefix.
static void	copyAttributes(AttributedString src, int src_position, AttributedString dst, int dst_position, int length) Copies the attributes from the source attributed string to the destination attributed string.
static void	debugPrint(PrintStream out, AttributedString astring) Prints debug information about the attributed string.
static String	getString(AttributedString astring) Returns the string contained in an attributed string.
static TextAttribute	getTextAttribute(String name) Returns the text attribute of its name string.
static String	getTextAttributeName(TextAttribute t) Converts a text attribute to its name string.
static Transferable	getTransferable(AttributedString src) Returns a transferable for the attributed string.
static int	length(AttributedString astring) Returns the length of the attributed string.
static AttributedString	substring(AttributedString astring, int beginIndex, int endIndex) Returns the attributed string that is a substring of the input string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ATTRIBUTED_STRING_FLAVOR

public static final DataFlavor ATTRIBUTED_STRING_FLAVOR

Data flavor for attributed string selections.

Since:

JViews 8.1

Method Detail

getString

public static String getString(AttributedString astring)

Returns the string contained in an attributed string.

Parameters:

astring - The attributed string

Returns:

The raw string

length

public static int length(AttributedString astring)

Returns the length of the attributed string.

substring

public static AttributedString substring(AttributedString astring,
                                         int beginIndex,
                                         int endIndex)

Returns the attributed string that is a substring of the input string. The substring begins at the specified beginIndex and extends to the character at index endIndex - 1. Thus the length of the substring is endIndex-beginIndex.

Parameters:

astring - The original attributed string.

beginIndex - The beginning index, inclusive.

endIndex - The ending index, exclusive.

Returns:

The specified substring.

Throws:

IndexOutOfBoundsException - if the beginIndex is negative, or endIndex is larger than the length of this AttributedString object, or beginIndex is larger than endIndex.

concat

public static AttributedString concat(AttributedString astring1,
                                      AttributedString astring2)

Concatenates two attributed strings.

concat

public static AttributedString concat(AttributedString astring1,
                                      AttributedString astring2,
                                      AttributedString astring3)

Concatenates three attributed strings.

concat

public static AttributedString concat(String prefix,
                                      AttributedString astring)

Concatenates an attributed string with string prefix.

concat

public static AttributedString concat(AttributedString astring,
                                      String suffix)

Concatenates an attributed string with string suffix. The suffix receives the same attributes as the last character of the first attributed string.

concat

public static AttributedString concat(AttributedString astring1,
                                      String string2,
                                      AttributedString astring3)

Inserts a normal string between two attributed strings. The inner string receives the same attributes as the last character of the first attributed string.

copyAttributes

public static void copyAttributes(AttributedString src,
                                  int src_position,
                                  AttributedString dst,
                                  int dst_position,
                                  int length)

Copies the attributes from the source attributed string to the destination attributed string. The source and the destination must be different objects. Only the attributes are copied, but not the characters. The source string must have at least src_position + length characters. The destination string must have at least dst_position + length characters.

Parameters:

src - the source string.

src_position - start position in the source string.

dst - the destination string.

dst_position - start position in the destination string.

length - the number of characters whose attributes are copied.

Throws:

IllegalArgumentException - one of the strings has not enough characters.

debugPrint

public static void debugPrint(PrintStream out,
                              AttributedString astring)

Prints debug information about the attributed string. This is useful to see which attributes exist in an attributed string.

Parameters:

out - The output stream

astring - The attributed string

getTextAttributeName

public static String getTextAttributeName(TextAttribute t)

Converts a text attribute to its name string. This can be used as replacement for the non-public method TextAttribute.getName().

See Also:

getTextAttribute(java.lang.String)

getTextAttribute

public static TextAttribute getTextAttribute(String name)

Returns the text attribute of its name string.

See Also:

getTextAttributeName(java.awt.font.TextAttribute)

getTransferable

public static Transferable getTransferable(AttributedString src)

Returns a transferable for the attributed string. The returned transferable supports the string data flavor as well as the data flavor ATTRIBUTED_STRING_FLAVOR. The transfer data of the data flavor ATTRIBUTED_STRING_FLAVOR is the attributed string itself.

Since:

JViews 8.1