|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Type
This interface defines a JAXFront node type. Every node type holds the belonging meta information (XML schema element), a W3C element, the target JAXFront DOM and the XUIDefinition.
Field Summary | |
---|---|
static short |
ComplexGroup
|
static short |
ComplexGroupList
|
static short |
CompositeType
|
static short |
DummyType
|
static short |
EmptyType
|
static short |
GroupType
|
static short |
ListType
|
static short |
NONE
|
static short |
SimpleGroup
|
static short |
SimpleGroupList
|
static short |
SimpleType
|
static short |
SimpleTypeList
|
static short |
VirtualType
|
Method Summary | |
---|---|
void |
addTreeNode(boolean shouldBeSerialized)
Adds this type to the tree. |
void |
bind(Document DOM,
org.w3c.dom.Element element)
Binds the values on a W3C element to the underlying JAXFront type. |
void |
bind(Document DOM,
org.w3c.dom.Element element,
boolean bindOnlyAvailable)
Binds the values on a W3C element to the underlying JAXFront type. |
void |
bind(java.lang.Object trigger,
Type type)
Binds the values of an JAXFront type to myself. |
void |
bind(Type type)
Binds the values of an JAXFront type to myself. |
Type |
deepClone(Document dom,
boolean cloneChoices,
boolean includingData)
Creates a deep clone of this type and all its referenced types. |
Type |
deepClone(Document dom,
boolean cloneChoices,
boolean includingData,
boolean includeEditingType,
SchemaNode schemaNode,
org.w3c.dom.Element element)
Creates a deep clone of this type and all its referenced types. |
Type |
getChild(java.lang.String name)
Gets a child (recursive) type with a given name |
Type |
getChild(java.lang.String name,
java.lang.String namespace)
Gets a child (recursive) type with a given name |
Type |
getChoosenType()
Gets the choosen type if this type is a choice element. |
java.lang.Object |
getClientProperty(java.lang.String key)
Gets a client property for this type. |
java.util.List |
getDerivedTypes()
Gets a list of all derived types if this type is an abstract type. |
Type |
getDirectChild(java.lang.String name)
Gets a direct child (next axis) type with a given name |
Type |
getDirectChild(java.lang.String name,
java.lang.String namespace)
Gets a direct child (next axis) type with a given name |
java.util.List |
getDirectChildren()
Gets a list of all child types. |
java.util.List |
getDirectChildren(java.lang.String name)
Gets a list of child types with a given name. |
java.lang.String |
getDirectChildValue(java.lang.String name)
Gets the value of a child type with a given name. |
java.lang.String |
getDisplayValue()
Returns this type as a String representation. |
Document |
getDOM()
Gets the current JAXFront document (DOM). |
java.lang.String |
getFullCaption()
Returns the nls translated (if any) xpath of a type up to its upper most represented tree node parent. |
java.lang.String |
getFullCaption(int labelLength)
Returns the nls translated (if any) xpath of a type up to its upper most represented tree node parent. |
short[] |
getId()
Gets a unique ID within the current JAXFront documennt (DOM) expressing axis position. |
Type |
getMixedContent()
Returns the mixed content leaf type or null if none. |
java.lang.String |
getName()
Returns the name witout namespace previx. |
java.lang.String |
getNamespace()
Gets the namespace name of the underlying W3C DOM. |
Type |
getNextSibling()
Returns the next sibling type of the current type. |
Type |
getParent()
Gets the parent type of the current type. |
Type |
getParent(java.lang.String parentName)
Gets the parent type with the given name. |
ListType |
getParentList()
Gets the parent list type of the current type. |
java.lang.String |
getPrefixedXPathLocation()
Gets the prefixed xpath location of the current type. |
Type |
getPreviousSibling()
Returns the previous sibling type of the current type. |
java.beans.PropertyChangeSupport |
getPropertyChangeSupport()
Gets the PropertyChangeSupport helper instance for this type. |
java.lang.String |
getQName()
Gets the tag name including namespace prefix. |
Type |
getRepresentedTableLayoutParent()
Returns the type (one of my parents) which defines a tableLayout which represents this type or null. |
Type |
getRepresentedTabParent(boolean checkCurrentType)
Gets the holding tree parent type that is represented as tab. |
Type |
getRepresentedTreeNodeHolder()
Gets the holding tree parent type in the navigation tree, where the view holder is self. |
Type |
getRepresentedTreeNodeParent()
Gets the holding tree parent type in the navigation tree. |
javax.swing.ImageIcon |
getRepresentedTreeNodeParentIcon()
Returns the uppermost icon that can be found of the tree node parents of the current type. |
java.lang.String |
getRepresentedTreeNodeParentIconName()
Returns the name of the uppermost icon that can be found of the tree node parents of the current type. |
SchemaNode |
getSchemaElement()
Gets the meta information schema element. |
SchemaType |
getSchemaType()
|
java.lang.String |
getSerializationName()
|
java.lang.String |
getShortCaption()
Returns the nls translated (if any) xpath of a type up to its upper most represented tree node parent. |
StyleDefinition |
getStyle()
|
Type |
getTemplate()
|
java.lang.String |
getTreeHierarchyContext()
Returns the treeEntry hierarchy of the current type as coma separated String (context). |
short |
getTypeClassification()
Returns the type classification. |
java.lang.Object |
getUserObject()
Gets any user object set to this type. |
java.lang.String |
getVisualName()
Returns the visual name of this type. |
java.lang.String |
getW3CXPathLocation(boolean prefixed)
Gets the W3C xpath location of the current type.This method returns the xpath without internal created unnamed elements! |
java.lang.String |
getXPathLocation()
Gets the xpath location of the current type. |
XUIDefinition |
getXUIDefinition()
Gets the current XUI definition. |
XUIDefinition |
getXUIDefinition(boolean create)
Gets the current XUI definition saying if a xui definition should be initialized lazy if it does not exist. |
boolean |
hasChoosenType()
|
boolean |
hasRecursionBeenBuilt()
Returns true if type is a recursion holder and recursive start element has been created yet. |
boolean |
hasRepresentableTreeChildren()
Returns true if this type has any child types represented in the navigation tree. |
boolean |
hasUIDefinition()
Returns true if the uiDefinition is alredy set. |
boolean |
hasUnChoosenChoiceParent()
Returns true if this type has an unchoosen choice parent, false otherwise |
boolean |
hasUndefinedChildren()
Returns true it this type holds a direct optional child. |
boolean |
hasValidationError()
Returns true if an validation error exists for this type. |
boolean |
isAbstract()
Returns true if this type is defined abstract in the schema element. |
boolean |
isAnonymous()
Returns true if this type has no tag element (unnamed holder). |
boolean |
isAttribute()
Returns true if this type is defined as an attribute in the XML schema. |
boolean |
isChoice()
Returns true if this type is acting as a choice. |
boolean |
isComposite()
Returns true if this type consists of other types. |
boolean |
isDerived()
Returns true if this type is implementing an abstract type. |
boolean |
isDerivedFrom(Type type)
Returns true if this type is a child of a given type. |
boolean |
isDerivedFromEditingType()
Returns true if this type is derived from an editing type. |
boolean |
isEditingType()
Returns true if my parent is a list and this type is a template for further addings. |
boolean |
isEmpty()
Returns true if this type is not represented in the target JAXFront DOM. |
boolean |
isGlobal()
Return true it this type is global. |
boolean |
isIncluded()
Returns true if this type was included from an included xui file. |
boolean |
isKey()
Returns true if this type is a key selector. |
boolean |
isKeyContext()
Returns true if this type is a key context used in KeyKeyRefManager. |
boolean |
isKeyRef()
Returns true if this type is a key ref selector. |
boolean |
isList()
Returns true if this type represents a list. |
boolean |
isLocked()
Returns true if this type is locked via document.lock(). |
boolean |
isRecursive()
Returns true if this type is starting a new recursion. |
boolean |
isReleased()
|
boolean |
isRenderable()
Returns true if the type is included into the rendering process. |
boolean |
isRepresentedAsHeader()
Returns true if this type has a header. |
boolean |
isRepresentedAsTab()
Returns true if this type is represented as tab. |
boolean |
isRepresentedAsTreeNode()
Returns true if this type is represented in the navigation tree. |
boolean |
isRequired()
Returns true if this type is defined mandatory in the xml schema. |
boolean |
isRoot()
Returns true if this type is the root of the JAXFront DOM. |
boolean |
isSerializable()
Returns true if this type should be serialized in the resulting W3C DOM. |
boolean |
isSerializable(boolean checkValue)
Returns true if this type should be serialized in the resulting W3C DOM. |
boolean |
isSimple()
Returns true if this is a leaf in the tree. |
boolean |
isUserInstanciated()
|
boolean |
isVirtual()
Returns true if this type is implementing an virtual type. |
void |
markAsDirtyXPath()
Marks an xpath as dirty. |
void |
putClientProperty(java.lang.String key,
java.lang.Object object)
|
void |
release()
Release all allocated resources for this type. |
boolean |
remove()
Removes this type from the JAXFront DOM. |
void |
removeAll()
Removes all types from this type. |
boolean |
removeChild(Type child)
Removes a child from the JAXFront DOM. |
void |
removeClientProperty(java.lang.String key)
|
void |
removeMessage()
Removes all validation error messages for this type. |
void |
removeTreeNode(boolean shouldBeSerialized)
Removes this type from the tree. |
java.lang.StringBuffer |
serialize()
Serializes the current subTree to a StringBuffer |
void |
serialize(java.lang.StringBuffer sb,
int indent,
boolean writeName,
boolean recursive)
Serializes the current subTree to a StringBuffer |
void |
setApplicationRequired(boolean required)
Sets if an user input is required for this type or not (overwrites xml schema cardinality). |
void |
setBackground(java.awt.Color color)
|
void |
setChoosenType(Type choosenType)
Sets the choosen type if this type is a choice. |
void |
setChoosenType(Type choosenType,
boolean temporary)
Sets the choosen type if this type is a choice. |
void |
setCodeSetValues(java.lang.String url,
java.lang.String codeSetName,
java.lang.String[] values,
java.lang.String defaultSelection)
Sets the codeSet values for the current type. |
void |
setDirectChildValue(java.lang.String childName,
java.lang.String value)
Sets the value of a child type of this type. |
void |
setDOM(Document DOM)
Sets a current JAXFront document (DOM). |
void |
setEditable(boolean editable)
Sets the component editable or not editable. |
void |
setEnabled(boolean enabled)
Sets the component enabled (active) or disabled (inactive). |
void |
setForeground(java.awt.Color color)
|
void |
setId(short[] id)
Sets a unique ID within the current JAXFront documennt (DOM) expressing axis position. |
void |
setIsKeyContext(boolean isContext)
Set true if this type is a key context! |
void |
setLabelColor(java.awt.Color color)
|
void |
setLabelText(java.lang.String text)
|
void |
setParent(Type parent)
Gets the parent type of the current type. |
void |
setRenderable(boolean renderable)
Defines if the type should be included into the rendering process. |
void |
setSchemaElement(SchemaNode element)
Sets the meta information schema element. |
void |
setSerializable(boolean isDefined)
Sets if this type should be serialized in the resulting W3C DOM. |
void |
setSerializable(boolean isDefined,
boolean checkForEmptyContent)
Sets if this type should be serialized in the resulting W3C DOM which depends on the content of the type. |
void |
setTemplate(Type template)
|
void |
setTreeIcon(java.lang.String gifName)
Set the tree icon for this type. |
void |
setUIDefinition(XUIDefinition uiDefinition)
Sets a XUI definition to this type. |
void |
setUserInstanciated(boolean userTriggered)
|
void |
setUserObject(java.lang.Object object)
Sets any user object to this type. |
void |
setVisible(boolean visible)
Sets the visualizer of this type visible or invisible at runtime. |
void |
setVisibleAndSerializable(boolean visible,
boolean isSerializable)
Sets the component visible or invisible and defines if the data will be serialized or not. |
void |
showLabel(boolean visible)
Sets the label visible or invisible. |
void |
showMessage(java.lang.String message,
java.lang.String classification,
boolean showDialog,
boolean needsUserAcceptance)
Dislplays a message for this type with the passed information. |
boolean |
unChoosenBranch()
|
Field Detail |
---|
static final short NONE
static final short SimpleType
static final short SimpleTypeList
static final short SimpleGroup
static final short SimpleGroupList
static final short ComplexGroup
static final short ComplexGroupList
static final short VirtualType
static final short EmptyType
static final short CompositeType
static final short ListType
static final short GroupType
static final short DummyType
Method Detail |
---|
void bind(Document DOM, org.w3c.dom.Element element)
DOM
- the current document to which this type belongselement
- the element to bindvoid bind(Document DOM, org.w3c.dom.Element element, boolean bindOnlyAvailable)
DOM
- the current document to which this type belongselement
- the element to bindbindOnlyAvailable
- indicates if the not available elements will be removed from
type treevoid bind(Type type)
DOM
- the current document to which this type belongstype
- the type to bind tovoid bind(java.lang.Object trigger, Type type)
DOM
- the current document to which this type belongstrigger
- trigger object e.g. Clipboard,Button used to identify user triggered actionstype
- the type to bind toType deepClone(Document dom, boolean cloneChoices, boolean includingData) throws java.lang.CloneNotSupportedException
dom
- the current dom to which this type belongsincludingData
- indicates if all binded data should be copied as well (default is false)
java.lang.CloneNotSupportedException
Type deepClone(Document dom, boolean cloneChoices, boolean includingData, boolean includeEditingType, SchemaNode schemaNode, org.w3c.dom.Element element) throws java.lang.CloneNotSupportedException
dom
- the current dom to which this type belongsincludingData
- indicates if all binded data should be copied as well (default is false)
java.lang.CloneNotSupportedException
Type getDirectChild(java.lang.String name)
name
- name of the child
Type getDirectChild(java.lang.String name, java.lang.String namespace)
name
- name of the childnamespace
- namespace of the child
Type getChild(java.lang.String name)
name
- name of the child
Type getChild(java.lang.String name, java.lang.String namespace)
name
- name of the child
java.util.List getDirectChildren()
java.util.List getDirectChildren(java.lang.String name)
name
- the name of the child(s)
java.lang.String getDirectChildValue(java.lang.String name)
name
- the name of the child
Type getChoosenType()
java.lang.Object getClientProperty(java.lang.String key)
object
- any user objectjava.util.List getDerivedTypes()
Document getDOM()
short[] getId()
java.lang.String getQName()
java.lang.String getNamespace()
Type getParent()
Type getParent(java.lang.String parentName)
parentName
- the name of the parent type
ListType getParentList()
java.beans.PropertyChangeSupport getPropertyChangeSupport()
Type getRepresentedTabParent(boolean checkCurrentType)
Type getRepresentedTreeNodeParent()
Type getRepresentedTreeNodeHolder()
SchemaNode getSchemaElement()
XUIDefinition getXUIDefinition()
XUIDefinition getXUIDefinition(boolean create)
lazyInitialization
- should be lazy initialized if not exists
java.lang.Object getUserObject()
java.lang.String getPrefixedXPathLocation()
java.lang.String getXPathLocation()
java.lang.String getW3CXPathLocation(boolean prefixed)
prefixed
- true if the xpath should be generated with namespace prefixes.
boolean hasRepresentableTreeChildren()
boolean hasUnChoosenChoiceParent()
boolean hasChoosenType()
boolean isAbstract()
boolean isAnonymous()
boolean isAttribute()
boolean isChoice()
boolean isComposite()
boolean isSerializable()
boolean isSerializable(boolean checkValue)
checkValue
- true if the serialize process should check if the type's value
is null
boolean isDerived()
boolean isDerivedFrom(Type type)
type
- parent type
boolean isEditingType()
boolean isEmpty()
boolean isList()
boolean isLocked()
boolean isRepresentedAsHeader()
boolean isRepresentedAsTab()
Type getRepresentedTableLayoutParent()
boolean isRepresentedAsTreeNode()
boolean isRequired()
boolean isRoot()
boolean isSimple()
boolean isVirtual()
void putClientProperty(java.lang.String key, java.lang.Object object)
void removeClientProperty(java.lang.String key)
void release()
boolean remove() throws ListModificationException
ListModificationException
void removeAll() throws ListModificationException
ListModificationException
boolean removeChild(Type child) throws ListModificationException
child
- a child type of this type
ListModificationException
java.lang.StringBuffer serialize()
void serialize(java.lang.StringBuffer sb, int indent, boolean writeName, boolean recursive)
sb
- a StringBuffer into which the subTree will be serializedindent
- size of indentwriteName
- true, if the name of the type should be serialized, false
otherwiserecursive
- true, if all containing types should be serializedvoid setDirectChildValue(java.lang.String childName, java.lang.String value)
childName
- the name of the childvalue
- the value to setvoid setChoosenType(Type choosenType)
choosenType
- the type that is currently choosenvoid setChoosenType(Type choosenType, boolean temporary)
choosenType
- the type that is choosentemporary
- true, if the choosen type acts temporarily as choosen type,
false otherwisevoid setDOM(Document DOM)
DOM
- a JAXFront document (DOM)void setId(short[] id)
id
- a unique IDvoid setSerializable(boolean isDefined)
isDefined
- true if this type should be serialized in the resulting W3C
DOM, false otherwisevoid setSerializable(boolean isDefined, boolean checkForEmptyContent)
isDefined
- true if this type should be serialized in the resulting W3C
DOM, false otherwisecheckForEmptyContent
- true if the content of this type should be checked for empty
contentvoid setParent(Type parent)
parent
- the parent type of the current typevoid setSchemaElement(SchemaNode element)
element
- the meta information schema elementvoid setUIDefinition(XUIDefinition uiDefinition)
uiDefinition
- a XUI definitionvoid setUserObject(java.lang.Object object)
object
- any user objectjava.lang.String getDisplayValue()
short getTypeClassification()
boolean hasValidationError()
boolean hasUIDefinition()
boolean isKey()
boolean isKeyRef()
boolean isKeyContext()
void setIsKeyContext(boolean isContext)
isContext
- true if this type is a key contextvoid setApplicationRequired(boolean required)
required
- true if an user input is required for this typevoid setCodeSetValues(java.lang.String url, java.lang.String codeSetName, java.lang.String[] values, java.lang.String defaultSelection)
url
- the url of the codeSet to be setcodeSetName
- the name of the codeSet to be setvalues
- the values of the codeSetdefaultSelection
- the default selected codevoid setBackground(java.awt.Color color)
Component.setBackground(java.awt.Color)
void setForeground(java.awt.Color color)
Component.setForeground(java.awt.Color)
void setLabelColor(java.awt.Color color)
Visualizer.setLabelColor(java.awt.Color)
void setLabelText(java.lang.String text)
Visualizer.setLabelText(java.lang.String)
void setVisible(boolean visible)
visible
- true if the component should be visibleType getTemplate()
void setTemplate(Type template)
void setRenderable(boolean renderable)
renderable
- false if the type should not be renderedboolean isRenderable()
void setEditable(boolean editable)
true
- if the component should be editablevoid setEnabled(boolean enabled)
true
- if the component should be enabledvoid setVisibleAndSerializable(boolean visible, boolean isSerializable)
visible
- true if the component should be visibleisSerializable
- true if the entered data should be serializedvoid showLabel(boolean visible)
visible
- true if the label should be visibleboolean isRecursive()
java.lang.String getTreeHierarchyContext()
java.lang.String getShortCaption()
java.lang.String getFullCaption()
getFullCaption(int)
java.lang.String getFullCaption(int labelLength)
labelLength
- the length of each element description label that will be
displayed
javax.swing.ImageIcon getRepresentedTreeNodeParentIcon()
java.lang.String getRepresentedTreeNodeParentIconName()
Type getNextSibling()
Type getPreviousSibling()
boolean isDerivedFromEditingType()
boolean isIncluded()
Type getMixedContent()
java.lang.String getVisualName()
void markAsDirtyXPath()
boolean hasRecursionBeenBuilt()
boolean isGlobal()
void removeTreeNode(boolean shouldBeSerialized)
shouldBeSerialized
- defines if the content of this type will be serializedvoid addTreeNode(boolean shouldBeSerialized)
shouldBeSerialized
- defines if this type should be serializedboolean hasUndefinedChildren()
void removeMessage()
void showMessage(java.lang.String message, java.lang.String classification, boolean showDialog, boolean needsUserAcceptance)
message
- message textclassification
- category (info, warning,...)showDialog
- defines if message should be shown as dialogneedsUserAcceptance
- defines if user needs to accept message or notvoid setTreeIcon(java.lang.String gifName)
gifName
- name of the gif for the tree iconjava.lang.String getName()
java.lang.String getSerializationName()
boolean isUserInstanciated()
void setUserInstanciated(boolean userTriggered)
boolean unChoosenBranch()
boolean isReleased()
SchemaType getSchemaType()
StyleDefinition getStyle()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |