net.sourceforge.nite.gui.util
Interface AbstractDisplayElement

All Known Implementing Classes:

ConcreteDisplayElement

public interface AbstractDisplayElement

See also AbstractCallableToolConfig and NXTConfig class. It's common for elements in tools to have a specific element they are displaying or creating and a type which is either an enumerated attribute or a pointer into a type ontology. This interface makes it easier for the tools to fit together: e.g. the linker element can now care less about what it's linking together.

Author:

Jonathan Kilgour, UEdin

Method Summary

java.lang.String	getElementName() Return the name of the element this display is predominantly designed for displaying or creating.
java.lang.String	getElementNameLong() Return the full name of the element this display is predominantly designed for displaying or creating: can be multiple words e.g.
java.lang.String	getElementNameShort() Return the short name of the element this display is predominantly designed for displaying or creating: e.g.
java.lang.String	getEnumeratedTypeAttribute() Return the name of the enumerated attribute that is used for the type (only required to be set if typeIsEnumeratedVariable() is true).
java.lang.String	getTypeDefault() If the type is an enumerated attribute, this is the String value of the default; if the type is an ontology this is the ID of the default type element.
java.lang.String	getTypeGloss() Return the name of the attribute on elements of the type ontology that give a 'gloss' of their meaning
java.lang.String	getTypeOntologyRoot() Return the name of the root element of the type ontology
java.lang.String	getTypeRole() Return the role of the pointer from the base element into the type ontology
boolean	typeIsEnumeratedVariable() true if the type is an enumerated attribute; false if the type is a pointer to an ontology.

Method Detail

getElementName

java.lang.String getElementName()

Return the name of the element this display is predominantly designed for displaying or creating.

typeIsEnumeratedVariable

boolean typeIsEnumeratedVariable()

true if the type is an enumerated attribute; false if the type is a pointer to an ontology.

getEnumeratedTypeAttribute

java.lang.String getEnumeratedTypeAttribute()

Return the name of the enumerated attribute that is used for the type (only required to be set if typeIsEnumeratedVariable() is true).

getTypeRole

java.lang.String getTypeRole()

Return the role of the pointer from the base element into the type ontology

getTypeOntologyRoot

java.lang.String getTypeOntologyRoot()

Return the name of the root element of the type ontology

getTypeGloss

java.lang.String getTypeGloss()

Return the name of the attribute on elements of the type ontology that give a 'gloss' of their meaning

getElementNameLong

java.lang.String getElementNameLong()

Return the full name of the element this display is predominantly designed for displaying or creating: can be multiple words e.g. "Dialogue Act".

getElementNameShort

java.lang.String getElementNameShort()

Return the short name of the element this display is predominantly designed for displaying or creating: e.g. "DA"

getTypeDefault

java.lang.String getTypeDefault()

If the type is an enumerated attribute, this is the String value of the default; if the type is an ontology this is the ID of the default type element.