Package net.arcadiusmc.dom

Interface JavaObjectElement

All Superinterfaces:

DomQueryable, Element, EventTarget, Node

public interface JavaObjectElement
extends Element

The Java Object element in the header allows for java classes to be triggered from the DOM by specifying their class name.

Activation

When the Attributes.CLASS_NAME attribute is set, a lookup is made via Class.forName(String, boolean, ClassLoader) to find the class.

If found, then a public static void onDomInitialize(Document) method in the class is called. If the method cannot be found, then a public constructor with a single Document parameter will be called. If that doesn't exist, activation fails.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INIT_METHOD_NAME

Method Summary

Modifier and Type	Method	Description
String	getClassName()	Get the name of the linked class.
Class<?>	getJavaClass()	Get the class named by getClassName().
void	setClassName(String className)	Set the name of the linked class.
boolean	wasEntrypointCalled()	Get whether the getJavaClass()'s entry point was called.

Methods inherited from interface net.arcadiusmc.dom.DomQueryable

getElementsByClassName, getElementsByTagName, querySelector, querySelectorAll

Methods inherited from interface net.arcadiusmc.dom.Element

appendChild, appendElement, appendText, canHaveChildren, clearChildren, firstChild, forEachDescendant, getAttribute, getAttributeEntries, getAttributeNames, getChild, getChildCount, getChildren, getClassList, getCurrentStyle, getId, getInlineStyle, getTagName, getTextContent, getTitleNode, getTooltip, hasChild, hasChildren, indexOf, insertAfter, insertBefore, isDescendant, lastChild, matches, prependChild, removeChild, removeChild, replaceChild, replaceChild, setAttribute, setId, setTextContent, setTitleNode

Methods inherited from interface net.arcadiusmc.dom.event.EventTarget

addEventListener, dispatchEvent, removeEventListener

Methods inherited from interface net.arcadiusmc.dom.Node

enterVisitor, exitVisitor, getDepth, getOwningDocument, getParent, getSiblingIndex, hasFlag, nextSibling, previousSibling

Field Details

INIT_METHOD_NAME

static final String INIT_METHOD_NAME

See Also:

• Constant Field Values

Method Details

getClassName

String getClassName()

Get the name of the linked class.

If the class name is set, and the class it was linked to was found, then it can be accessed with getJavaClass().

Shortcut for accessing the Attributes.CLASS_NAME attribute.

Specified by:

getClassName in interface Element

Returns:

Java Class name

getJavaClass

Class<?> getJavaClass()

Get the class named by getClassName().

Returns:

Java class

wasEntrypointCalled

boolean wasEntrypointCalled()

Get whether the getJavaClass()'s entry point was called. If this method returns false, then it means the entrypoint couldn't be found or threw an error when called.

Returns:

true, if the class entry point was called successfully, false otherwise.

setClassName

void setClassName(String className)

Set the name of the linked class.

Shortcut for changing the Attributes.CLASS_NAME attribute.

Specified by:

setClassName in interface Element

Parameters:

className - New class name