org.jivesoftware.smackx.message_markup.element

Class SpanElement

java.lang.Object

org.jivesoftware.smackx.message_markup.element.SpanElement

All Implemented Interfaces:

Element, NamedElement, MarkupElement.MarkupChildElement

public class SpanElement
extends Object
implements MarkupElement.MarkupChildElement

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SpanElement.SpanStyle

Field Summary

Fields

Modifier and Type	Field and Description
static String	code
static String	deleted
static String	ELEMENT
static String	emphasis

Fields inherited from interface org.jivesoftware.smackx.message_markup.element.MarkupElement.MarkupChildElement

ATTR_END, ATTR_START

Constructor Summary

Constructors

Constructor and Description
SpanElement(int start, int end, Set<SpanElement.SpanStyle> styles) Create a new Span element.

Method Summary

Modifier and Type	Method and Description
String	getElementName() Returns the root element name.
int	getEnd() Return the end index of this element.
int	getStart() Return the start index of this element.
Set<SpanElement.SpanStyle>	getStyles() Return all styles of this span.
XmlStringBuilder	toXML(String enclosingNamespace) Returns the XML representation of this Element.

Methods inherited from class java.lang.Object

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

Field Detail

ELEMENT

public static final String ELEMENT

See Also:

Constant Field Values

emphasis

public static final String emphasis

See Also:

Constant Field Values

code

public static final String code

See Also:

Constant Field Values

deleted

public static final String deleted

See Also:

Constant Field Values

Constructor Detail

SpanElement

public SpanElement(int start,
                   int end,
                   Set<SpanElement.SpanStyle> styles)

Create a new Span element.

Parameters:

start - start index

end - end index

styles - list of styles that apply to this span

Method Detail

getStart

public int getStart()

Description copied from interface: MarkupElement.MarkupChildElement

Return the start index of this element.

Specified by:

getStart in interface MarkupElement.MarkupChildElement

Returns:

start index

getEnd

public int getEnd()

Description copied from interface: MarkupElement.MarkupChildElement

Return the end index of this element.

Specified by:

getEnd in interface MarkupElement.MarkupChildElement

Returns:

end index

getStyles

public Set<SpanElement.SpanStyle> getStyles()

Return all styles of this span.

Returns:

styles

getElementName

public String getElementName()

Description copied from interface: NamedElement

Returns the root element name.

Specified by:

getElementName in interface NamedElement

Returns:

the element name.

toXML

public XmlStringBuilder toXML(String enclosingNamespace)

Description copied from interface: Element

Returns the XML representation of this Element. This method takes an optional argument for the enclosing namespace which may be null or the empty String if the value is not known.

Specified by:

toXML in interface Element

Parameters:

enclosingNamespace - the enclosing namespace or null.

Returns:

the stanza extension as XML.