Package snap.text

Class RichText

java.lang.Object

snap.props.PropObject

snap.text.TextDoc

snap.text.RichText

All Implemented Interfaces:

CharSequence, Cloneable, PropChange.DoChange, CharSequenceX, XMLArchiver.Archivable

public class RichText
extends TextDoc
implements XMLArchiver.Archivable

This class represents a block of text (lines).

Field Summary

Fields inherited from class snap.text.TextDoc

_defaultLineStyle, _defaultTextStyle, _length, _lines, _parentTextStyle, _propChangeEnabled, _width, Chars_Prop, DefaultTextStyle_Prop, LineStyle_Prop, ParentTextStyle_Prop, Style_Prop, TextModified_Prop

Fields inherited from class snap.props.PropObject

_pcs, EMPTY_OBJECT

Constructor Summary

Constructors

Constructor	Description
RichText()	Constructor.
RichText(CharSequence theChars, Object... theAttrs)	Creates RichText initialized with given String and attributes (font, color).

Method Summary

Modifier and Type	Method	Description
RichText	clone()	Standard clone implementation.
RichText	copyForRange(int aStart, int aEnd)	Returns a copy of this text for given char range.
protected TextLine	createLine()	Creates a new TextLine for use in this text.
Object	fromXML(XMLArchiver anArchiver, XMLElement anElement)	XML unarchival.
boolean	isRichText()	Override to indicate rich text supported.
boolean	isUnderlined()	Returns whether text contains an underlined run.
void	setLineStyle(TextLineStyle aStyle, int aStart, int anEnd)	Sets a given style to a given range.
void	setLineStyleValue(String aKey, Object aValue, int aStart, int anEnd)	Sets a given style to a given range.
void	setStyle(TextStyle aStyle, int aStart, int anEnd)	Sets a given style to a given range.
void	setStyleValue(String aKey, Object aValue, int aStart, int anEnd)	Sets a given attribute to a given value for a given range.
XMLElement	toXML(XMLArchiver anArchiver)	XML archival.

Methods inherited from class snap.text.TextDoc

addChars, addChars, addDefaultLine, addLine, addTextDoc, charAt, clear, createTokensForTextLine, getAlignX, getDefaultLineStyle, getDefaultStyle, getFontForCharIndex, getLine, getLineCount, getLineForCharIndex, getLineLast, getLineLongest, getLines, getLineStyleForCharIndex, getParentTextStyle, getPrefWidth, getPrefWidth, getRunForCharIndex, getRunForCharRange, getRunLast, getSourceFile, getSourceURL, getStartCharIndex, getString, getStyleForCharIndex, getStyleForCharRange, indexOf, isDefaultTextStyleSet, isPropChangeEnabled, isTextModified, length, newFromSource, readFromSourceURL, removeChars, removeLine, replaceChars, replaceChars, scaleFonts, setAlignX, setDefaultLineStyle, setDefaultStyle, setParentTextStyle, setPropChangeEnabled, setSourceURL, setString, setStyleValue, setStyleValue, setStyleValue, setTextModified, setUnderlined, subSequence, toStringProps, updateLines, writeToSourceFile

Methods inherited from class snap.props.PropObject

addDeepChangeListener, addPropChangeListener, addPropChangeListener, firePropChange, firePropChange, firePropChange, getPropDefault, getPropForName, getPropParent, getPropSet, getPropsForArchival, getPropsForArchivalExtra, getPropValue, initProps, isPropDefault, processPropChange, removeDeepChangeListener, removePropChangeListener, removePropChangeListener, setPropValue, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.CharSequence

chars, codePoints, isEmpty, toString

Methods inherited from interface snap.util.CharSequenceX

getIndentLength, getIndentString, getLastChar, indexAfterNewline, indexOfNewline, isAfterLineEnd, isLastCharNewline, isLineEnd, isLineEndChar, isWhiteSpace, lastIndexAfterNewline, lastIndexOfNewline, startsWith

Constructor Details

RichText

public RichText()

Constructor.

RichText

public RichText(CharSequence theChars,
 Object... theAttrs)

Creates RichText initialized with given String and attributes (font, color).

Method Details

isRichText

public boolean isRichText()

Override to indicate rich text supported.

Overrides:

isRichText in class TextDoc

createLine

protected TextLine createLine()

Creates a new TextLine for use in this text.

Overrides:

createLine in class TextDoc

setStyle

public void setStyle(TextStyle aStyle,
 int aStart,
 int anEnd)

Sets a given style to a given range.

Overrides:

setStyle in class TextDoc

setStyleValue

public void setStyleValue(String aKey,
 Object aValue,
 int aStart,
 int anEnd)

Sets a given attribute to a given value for a given range.

Overrides:

setStyleValue in class TextDoc

setLineStyle

public void setLineStyle(TextLineStyle aStyle,
 int aStart,
 int anEnd)

Sets a given style to a given range.

Overrides:

setLineStyle in class TextDoc

setLineStyleValue

public void setLineStyleValue(String aKey,
 Object aValue,
 int aStart,
 int anEnd)

Sets a given style to a given range.

Overrides:

setLineStyleValue in class TextDoc

isUnderlined

public boolean isUnderlined()

Returns whether text contains an underlined run.

Overrides:

isUnderlined in class TextDoc

copyForRange

public RichText copyForRange(int aStart,
 int aEnd)

Returns a copy of this text for given char range.

clone

public RichText clone()

Standard clone implementation.

Overrides:

clone in class TextDoc

toXML

public XMLElement toXML(XMLArchiver anArchiver)

XML archival.

Specified by:

toXML in interface XMLArchiver.Archivable

fromXML

public Object fromXML(XMLArchiver anArchiver,
 XMLElement anElement)

XML unarchival.

Specified by:

fromXML in interface XMLArchiver.Archivable