Package de.espirit.firstspirit.access.editor.value

Interface DomElement

All Superinterfaces:

ValueChangeNotifier

public interface DomElement
extends ValueChangeNotifier

API interface for an DomEditorValue element.

Since:

4.0

Method Summary

Modifier and Type	Method	Description
void	adopt(DomElement element)	Adopts all values from the given element.
@Nullable Element	diff(Element other)	Compute a difference between this element and the given one.
Element	get()	Returns root element.
DefaultDomNode	getRoot()	Returns root node ( <DOM> ).
boolean	isEmpty()	Returns true if this element has no content.
void	parseHtml(String html)	Sets the given html.
void	set(String xml)	Sets the given xml.
void	set(Element element)	Sets root element.
String	toText(boolean asHtml)	Returns html (asHtml==true) or plain text (asHtml==false).

Methods inherited from interface de.espirit.common.event.ValueChangeNotifier

addChangeListener, removeChangeListener

Method Details

getRoot

@ApiDoc(comment="Returns root node (DOM)",
        since="4.2.15")
DefaultDomNode getRoot()

Returns root node ( <DOM> ).

Returns:

root node.

Since:

4.2.15

get

@ApiDoc(comment="Returns root element.",
        since="4.0.17")
Element get()

Returns root element.

Returns:

root element.

Since:

4.0.17

isEmpty

@ApiDoc(comment="Returns true if this element has no content.",
        since="4.0.17")
boolean isEmpty()

Returns true if this element has no content.

Returns:

true if this element has no content.

Since:

4.0.17

set

@ApiDoc(comment="Sets root element.",
        since="4.0.17")
void set(Element element)

Sets root element.

Parameters:

element - root element.

Since:

4.0.17

set

@ApiDoc(comment="Sets the given xml.",
        since="4.0.17")
void set(String xml)

Sets the given xml.

Parameters:

xml - to set.

Since:

4.0.17

toText

@ApiDoc(comment="Returns html (asHtml==true) or plain text (asHtml==false).",
        since="4.0.17")
String toText(boolean asHtml)

Returns html (asHtml==true) or plain text (asHtml==false).

Parameters:

asHtml - true to return html, false to return plain text.

Returns:

html (asHtml==true) or plain text (asHtml==false).

Since:

4.0.17

See Also:

• parseHtml(String)

parseHtml

@ApiDoc(comment="Sets the given html.",
        since="4.0.17")
void parseHtml(String html)

Sets the given html.

Parameters:

html - to set.

Since:

4.0.17

See Also:

• toText(boolean)

adopt

@ApiDoc(comment="Adopts all values from the given element.",
        since="4.0.17")
void adopt(DomElement element)

Adopts all values from the given element.

Parameters:

element - source.

Since:

4.0.17

diff

@ApiDoc(comment="Compute a difference between this element and the given one.",
        since="4.0")
@Nullable
@Nullable Element diff(Element other)

Compute a difference between this element and the given one.

Parameters:

other - The element to compare to.

Returns:

The difference element or null, if equal.

Since:

4.0