Package de.espirit.firstspirit.access.store.templatestore.gom

Class GomComment

java.lang.Object

de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomElement

de.espirit.firstspirit.access.store.templatestore.gom.GomComment

All Implemented Interfaces:

GomElement, GomEmbeddedXml, GomHideable, Serializable

@NonExtendable
public class GomComment
extends AbstractGomElement
implements GomEmbeddedXml, GomHideable

GOM comment definition.

Since:

4.0

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TAG	The tag of this component

Constructor Summary

Constructors

Constructor	Description
GomComment()

Method Summary

Modifier and Type	Method	Description
protected String	getDefaultTag()	Return the default tag for a gom element.
String	getEmbeddedXml()	Get the XML to be embedded for the element
boolean	hasRepresentation()	Indicates the GOM element having a UI representation.
boolean	isHidden()	Indicator for hidden elements.
void	setEmbeddedXml(String xml)	Set the given XML as element content

Methods inherited from class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomElement

getGomElementTag, getIncludeConfiguration, setGomElementTag, setIncludeConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.espirit.firstspirit.access.store.templatestore.gom.GomElement

getGomElementTag, getIncludeConfiguration, setGomElementTag, setIncludeConfiguration

Field Details

TAG

public static final String TAG

The tag of this component

Since:

4.0

See Also:

• Constant Field Values

Constructor Details

GomComment

public GomComment()

Method Details

getDefaultTag

protected String getDefaultTag()

Description copied from class: AbstractGomElement

Return the default tag for a gom element.

Specified by:

getDefaultTag in class AbstractGomElement

Returns:

The elements default tag.

getEmbeddedXml

public String getEmbeddedXml()

Description copied from interface: GomEmbeddedXml

Get the XML to be embedded for the element

Specified by:

getEmbeddedXml in interface GomEmbeddedXml

Returns:

The XML to embed

setEmbeddedXml

public void setEmbeddedXml(String xml)
                    throws ParsingError

Description copied from interface: GomEmbeddedXml

Set the given XML as element content

Specified by:

setEmbeddedXml in interface GomEmbeddedXml

Parameters:

xml - The embedded XML

Throws:

ParsingError - If the XML could not be processed by the embeddee

hasRepresentation

public boolean hasRepresentation()

Description copied from class: AbstractGomElement

Indicates the GOM element having a UI representation.

Specified by:

hasRepresentation in interface GomElement

Overrides:

hasRepresentation in class AbstractGomElement

Returns:

true, if it has a representation.

isHidden

public boolean isHidden()

Description copied from interface: GomHideable

Indicator for hidden elements.

Specified by:

isHidden in interface GomHideable

Returns:

true, if the element should be hidden.