nl.fountain.xelem.excel.ss
Class SSComment

java.lang.Object
  nl.fountain.xelem.excel.AbstractXLElement
      nl.fountain.xelem.excel.ss.SSComment

All Implemented Interfaces:

Comment, XLElement

public class SSComment
extends AbstractXLElement
implements Comment

An implementation of the XLElement Comment.

Field Summary

Fields inherited from interface nl.fountain.xelem.excel.XLElement

PREFIX_HTML, PREFIX_O, PREFIX_SS, PREFIX_X, XMLNS, XMLNS_HTML, XMLNS_O, XMLNS_SS, XMLNS_X

Constructor Summary

SSComment()

Method Summary

Element	assemble(Element parent, GIO gio) Assembles the state of this XLElement and all of it's children into an Element.
String	getAuthor()
String	getData()
String	getDataClean() Gets the content of the data element stripped of the author (if there was any).
String	getNameSpace() Gets the namespace of this XLElement.
String	getPrefix() Gets the prefix of this XLElement.
String	getTagName() Gets the tagname (localName) of this XLElement.
void	setAttributes(Attributes attrs) Does effectively nothing.
void	setAuthor(String author)
void	setChildElement(String localName, String content) Does effectively nothing.
void	setData(String data)
void	setShowAlways(boolean show)
boolean	showsAlways()

Methods inherited from class nl.fountain.xelem.excel.AbstractXLElement

addElementComment, assemble, createAttributeNS, createAttributeNS, createElementNS, createElementNS, createElementNS, createElementNS, getElementComments

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.fountain.xelem.excel.XLElement

addElementComment, getElementComments

Constructor Detail

SSComment

public SSComment()

Method Detail

setAuthor

public void setAuthor(String author)

Specified by:

setAuthor in interface Comment

getAuthor

public String getAuthor()

Specified by:

getAuthor in interface Comment

setShowAlways

public void setShowAlways(boolean show)

Specified by:

setShowAlways in interface Comment

showsAlways

public boolean showsAlways()

Specified by:

showsAlways in interface Comment

setData

public void setData(String data)

Specified by:

setData in interface Comment

getData

public String getData()

Specified by:

getData in interface Comment

getDataClean

public String getDataClean()

Description copied from interface: Comment

Gets the content of the data element stripped of the author (if there was any).

Specified by:

getDataClean in interface Comment

Returns:

the content of the data element stripped of the author

getTagName

public String getTagName()

Description copied from interface: XLElement

Gets the tagname (localName) of this XLElement.

Specified by:

getTagName in interface XLElement

Returns:

qualified name

getNameSpace

public String getNameSpace()

Description copied from interface: XLElement

Gets the namespace of this XLElement.

Specified by:

getNameSpace in interface XLElement

Returns:

namespace

getPrefix

public String getPrefix()

Description copied from interface: XLElement

Gets the prefix of this XLElement.

Specified by:

getPrefix in interface XLElement

Returns:

prefix

assemble

public Element assemble(Element parent,
                        GIO gio)

Description copied from interface: XLElement

Assembles the state of this XLElement and all of it's children into an Element. Attaches the new element to it's parent-element if needed.

Specified by:

assemble in interface XLElement

Parameters:

parent - the parent-element to which the new formed element will be appended

gio - a global information object

Returns:

the newly assembled element. may be null.

setAttributes

public void setAttributes(Attributes attrs)

Description copied from class: AbstractXLElement

Does effectively nothing.

Specified by:

setAttributes in interface XLElement

Overrides:

setAttributes in class AbstractXLElement

Parameters:

attrs - the attributes found on the element

setChildElement

public void setChildElement(String localName,
                            String content)

Description copied from class: AbstractXLElement

Does effectively nothing.

Specified by:

setChildElement in interface XLElement

Overrides:

setChildElement in class AbstractXLElement

Parameters:

localName - the local name of the child

content - the content of the child