com.jaxfront.core.type
Interface Type

All Known Subinterfaces:
CompositeType, ListType
All Known Implementing Classes:
AbstractCompositeType, AbstractListType, AbstractType, ComplexGroup, ComplexGroupList, DummyXPathRootType, EmptyType, SimpleGroup, SimpleGroupList, SimpleType, SimpleTypeList, VirtualType, XPathDummyChoiceTypeWrapper

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.

Version:
1.60

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

NONE

static final short NONE
See Also:
Constant Field Values

SimpleType

static final short SimpleType
See Also:
Constant Field Values

SimpleTypeList

static final short SimpleTypeList
See Also:
Constant Field Values

SimpleGroup

static final short SimpleGroup
See Also:
Constant Field Values

SimpleGroupList

static final short SimpleGroupList
See Also:
Constant Field Values

ComplexGroup

static final short ComplexGroup
See Also:
Constant Field Values

ComplexGroupList

static final short ComplexGroupList
See Also:
Constant Field Values

VirtualType

static final short VirtualType
See Also:
Constant Field Values

EmptyType

static final short EmptyType
See Also:
Constant Field Values

CompositeType

static final short CompositeType
See Also:
Constant Field Values

ListType

static final short ListType
See Also:
Constant Field Values

GroupType

static final short GroupType
See Also:
Constant Field Values

DummyType

static final short DummyType
See Also:
Constant Field Values
Method Detail

bind

void bind(Document DOM,
          org.w3c.dom.Element element)
Binds the values on a W3C element to the underlying JAXFront type.

Parameters:
DOM - the current document to which this type belongs
element - the element to bind

bind

void bind(Document DOM,
          org.w3c.dom.Element element,
          boolean bindOnlyAvailable)
Binds the values on a W3C element to the underlying JAXFront type. Removes not available types if no W3C element has been found and the flag "bindOnlyAvailable" is set to true.

Parameters:
DOM - the current document to which this type belongs
element - the element to bind
bindOnlyAvailable - indicates if the not available elements will be removed from type tree

bind

void bind(Type type)
Binds the values of an JAXFront type to myself.

Parameters:
DOM - the current document to which this type belongs
type - the type to bind to

bind

void bind(java.lang.Object trigger,
          Type type)
Binds the values of an JAXFront type to myself.

Parameters:
DOM - the current document to which this type belongs
trigger - trigger object e.g. Clipboard,Button used to identify user triggered actions
type - the type to bind to

deepClone

Type deepClone(Document dom,
               boolean cloneChoices,
               boolean includingData)
               throws java.lang.CloneNotSupportedException
Creates a deep clone of this type and all its referenced types.

Parameters:
dom - the current dom to which this type belongs
includingData - indicates if all binded data should be copied as well (default is false)
Returns:
the cloned type
Throws:
java.lang.CloneNotSupportedException

deepClone

Type deepClone(Document dom,
               boolean cloneChoices,
               boolean includingData,
               boolean includeEditingType,
               SchemaNode schemaNode,
               org.w3c.dom.Element element)
               throws java.lang.CloneNotSupportedException
Creates a deep clone of this type and all its referenced types.

Parameters:
dom - the current dom to which this type belongs
includingData - indicates if all binded data should be copied as well (default is false)
Returns:
the cloned type
Throws:
java.lang.CloneNotSupportedException

getDirectChild

Type getDirectChild(java.lang.String name)
Gets a direct child (next axis) type with a given name

Parameters:
name - name of the child
Returns:
a child with the given name

getDirectChild

Type getDirectChild(java.lang.String name,
                    java.lang.String namespace)
Gets a direct child (next axis) type with a given name

Parameters:
name - name of the child
namespace - namespace of the child
Returns:
a child with the given name

getChild

Type getChild(java.lang.String name)
Gets a child (recursive) type with a given name

Parameters:
name - name of the child
Returns:
a child with the given name

getChild

Type getChild(java.lang.String name,
              java.lang.String namespace)
Gets a child (recursive) type with a given name

Parameters:
name - name of the child
Returns:
a child with the given name

getDirectChildren

java.util.List getDirectChildren()
Gets a list of all child types.

Returns:
a list of all child types

getDirectChildren

java.util.List getDirectChildren(java.lang.String name)
Gets a list of child types with a given name.

Parameters:
name - the name of the child(s)
Returns:
a list of child types with a given name

getDirectChildValue

java.lang.String getDirectChildValue(java.lang.String name)
Gets the value of a child type with a given name.

Parameters:
name - the name of the child
Returns:
the value of a child type with a given name

getChoosenType

Type getChoosenType()
Gets the choosen type if this type is a choice element.

Returns:
the choosen type if this type is a choice, null otherwise

getClientProperty

java.lang.Object getClientProperty(java.lang.String key)
Gets a client property for this type.

Parameters:
object - any user object

getDerivedTypes

java.util.List getDerivedTypes()
Gets a list of all derived types if this type is an abstract type.

Returns:
a list of all derived types if this type is an abstract type, null otherwise

getDOM

Document getDOM()
Gets the current JAXFront document (DOM).

Returns:
the current JAXFront document (DOM)

getId

short[] getId()
Gets a unique ID within the current JAXFront documennt (DOM) expressing axis position.

Returns:
a unique ID

getQName

java.lang.String getQName()
Gets the tag name including namespace prefix.

Returns:
the tag name name including namespace prefix

getNamespace

java.lang.String getNamespace()
Gets the namespace name of the underlying W3C DOM.

Returns:
the namespace name of the underlying W3C DOM

getParent

Type getParent()
Gets the parent type of the current type.

Returns:
the parent type of the current type

getParent

Type getParent(java.lang.String parentName)
Gets the parent type with the given name.

Parameters:
parentName - the name of the parent type
Returns:
the parent type with the given name

getParentList

ListType getParentList()
Gets the parent list type of the current type.

Returns:
the parent list type of the current type

getPropertyChangeSupport

java.beans.PropertyChangeSupport getPropertyChangeSupport()
Gets the PropertyChangeSupport helper instance for this type.

Returns:
the PropertyChangeSupport helper instance for this type

getRepresentedTabParent

Type getRepresentedTabParent(boolean checkCurrentType)
Gets the holding tree parent type that is represented as tab.

Returns:
the holding tree parent type that is represented as tab

getRepresentedTreeNodeParent

Type getRepresentedTreeNodeParent()
Gets the holding tree parent type in the navigation tree.

Returns:
the holding tree parent type in the navigation tree

getRepresentedTreeNodeHolder

Type getRepresentedTreeNodeHolder()
Gets the holding tree parent type in the navigation tree, where the view holder is self.

Returns:
the holding tree parent type in the navigation tree

getSchemaElement

SchemaNode getSchemaElement()
Gets the meta information schema element.

Returns:
the meta information schema element

getXUIDefinition

XUIDefinition getXUIDefinition()
Gets the current XUI definition.

Returns:
the current XUI definition

getXUIDefinition

XUIDefinition getXUIDefinition(boolean create)
Gets the current XUI definition saying if a xui definition should be initialized lazy if it does not exist.

Parameters:
lazyInitialization - should be lazy initialized if not exists
Returns:
the current XUI definition

getUserObject

java.lang.Object getUserObject()
Gets any user object set to this type.

Returns:
any user object set to this type

getPrefixedXPathLocation

java.lang.String getPrefixedXPathLocation()
Gets the prefixed xpath location of the current type.

Returns:
the prefixed xpath location of the current type

getXPathLocation

java.lang.String getXPathLocation()
Gets the xpath location of the current type.

Returns:
the xpath location of the current type

getW3CXPathLocation

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!

Parameters:
prefixed - true if the xpath should be generated with namespace prefixes.
Returns:
the xpath location of the current type

hasRepresentableTreeChildren

boolean hasRepresentableTreeChildren()
Returns true if this type has any child types represented in the navigation tree.

Returns:
true, if this type has any child types represented in the navigation tree, false otherwise

hasUnChoosenChoiceParent

boolean hasUnChoosenChoiceParent()
Returns true if this type has an unchoosen choice parent, false otherwise


hasChoosenType

boolean hasChoosenType()

isAbstract

boolean isAbstract()
Returns true if this type is defined abstract in the schema element.

Returns:
true if this type is defined abstract in the schema element, false otherwise

isAnonymous

boolean isAnonymous()
Returns true if this type has no tag element (unnamed holder).

Returns:
true if this type has no tag element (unnamed holder), false otherwise

isAttribute

boolean isAttribute()
Returns true if this type is defined as an attribute in the XML schema.

Returns:
true if this type is defined as an attribute in the XML schema, false otherwise

isChoice

boolean isChoice()
Returns true if this type is acting as a choice.

Returns:
true if this type is acting as a choice, false otherwise

isComposite

boolean isComposite()
Returns true if this type consists of other types.

Returns:
true if this type consists of other types, false otherwise

isSerializable

boolean isSerializable()
Returns true if this type should be serialized in the resulting W3C DOM.

Returns:
true if this type should be serialized in the resulting W3C DOM, false otherwise

isSerializable

boolean isSerializable(boolean checkValue)
Returns true if this type should be serialized in the resulting W3C DOM.

Parameters:
checkValue - true if the serialize process should check if the type's value is null
Returns:
true if this type should be serialized in the resulting W3C DOM, false otherwise

isDerived

boolean isDerived()
Returns true if this type is implementing an abstract type.

Returns:
true if this type is implementing an abstract type

isDerivedFrom

boolean isDerivedFrom(Type type)
Returns true if this type is a child of a given type.

Parameters:
type - parent type
Returns:
true if this type is a child of a given type, false otherwise

isEditingType

boolean isEditingType()
Returns true if my parent is a list and this type is a template for further addings.

Returns:
true if my parent is a list and this type is a template for further addings, false otherwise

isEmpty

boolean isEmpty()
Returns true if this type is not represented in the target JAXFront DOM.

Returns:
true if this type is not represented in the target JAXFront DOM, false otherwise

isList

boolean isList()
Returns true if this type represents a list.

Returns:
true if this type represents a list, false otherwise

isLocked

boolean isLocked()
Returns true if this type is locked via document.lock().

Returns:
true if this type is locked.

isRepresentedAsHeader

boolean isRepresentedAsHeader()
Returns true if this type has a header.

Returns:
true if this type has a header, false otherwise

isRepresentedAsTab

boolean isRepresentedAsTab()
Returns true if this type is represented as tab.

Returns:
true if this type is represented as tab, false otherwise

getRepresentedTableLayoutParent

Type getRepresentedTableLayoutParent()
Returns the type (one of my parents) which defines a tableLayout which represents this type or null.


isRepresentedAsTreeNode

boolean isRepresentedAsTreeNode()
Returns true if this type is represented in the navigation tree.

Returns:
true if this type is represented in the navigation tree, false otherwise

isRequired

boolean isRequired()
Returns true if this type is defined mandatory in the xml schema.

Returns:
true if this type is defined mandatory in the xml schema, false otherwise

isRoot

boolean isRoot()
Returns true if this type is the root of the JAXFront DOM.

Returns:
true if this type is the root of the JAXFront DOM, false otherwise

isSimple

boolean isSimple()
Returns true if this is a leaf in the tree.

Returns:
true if this is a leaf in the tree, false otherwise

isVirtual

boolean isVirtual()
Returns true if this type is implementing an virtual type.

Returns:
true if this type is implementing an virtual type

putClientProperty

void putClientProperty(java.lang.String key,
                       java.lang.Object object)

removeClientProperty

void removeClientProperty(java.lang.String key)

release

void release()
Release all allocated resources for this type.


remove

boolean remove()
               throws ListModificationException
Removes this type from the JAXFront DOM.

Throws:
ListModificationException

removeAll

void removeAll()
               throws ListModificationException
Removes all types from this type.

Throws:
ListModificationException

removeChild

boolean removeChild(Type child)
                    throws ListModificationException
Removes a child from the JAXFront DOM.

Parameters:
child - a child type of this type
Throws:
ListModificationException

serialize

java.lang.StringBuffer serialize()
Serializes the current subTree to a StringBuffer


serialize

void serialize(java.lang.StringBuffer sb,
               int indent,
               boolean writeName,
               boolean recursive)
Serializes the current subTree to a StringBuffer

Parameters:
sb - a StringBuffer into which the subTree will be serialized
indent - size of indent
writeName - true, if the name of the type should be serialized, false otherwise
recursive - true, if all containing types should be serialized

setDirectChildValue

void setDirectChildValue(java.lang.String childName,
                         java.lang.String value)
Sets the value of a child type of this type.

Parameters:
childName - the name of the child
value - the value to set

setChoosenType

void setChoosenType(Type choosenType)
Sets the choosen type if this type is a choice.

Parameters:
choosenType - the type that is currently choosen

setChoosenType

void setChoosenType(Type choosenType,
                    boolean temporary)
Sets the choosen type if this type is a choice.

Parameters:
choosenType - the type that is choosen
temporary - true, if the choosen type acts temporarily as choosen type, false otherwise

setDOM

void setDOM(Document DOM)
Sets a current JAXFront document (DOM).

Parameters:
DOM - a JAXFront document (DOM)

setId

void setId(short[] id)
Sets a unique ID within the current JAXFront documennt (DOM) expressing axis position.

Parameters:
id - a unique ID

setSerializable

void setSerializable(boolean isDefined)
Sets if this type should be serialized in the resulting W3C DOM.

Parameters:
isDefined - true if this type should be serialized in the resulting W3C DOM, false otherwise

setSerializable

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. If the type has empty content it won't be serialized by default. If a type should be serialized even if it has empty content then set checkForEmptyContent to false which won't check the type for empty content during serializing.

Parameters:
isDefined - true if this type should be serialized in the resulting W3C DOM, false otherwise
checkForEmptyContent - true if the content of this type should be checked for empty content

setParent

void setParent(Type parent)
Gets the parent type of the current type.

Parameters:
parent - the parent type of the current type

setSchemaElement

void setSchemaElement(SchemaNode element)
Sets the meta information schema element.

Parameters:
element - the meta information schema element

setUIDefinition

void setUIDefinition(XUIDefinition uiDefinition)
Sets a XUI definition to this type.

Parameters:
uiDefinition - a XUI definition

setUserObject

void setUserObject(java.lang.Object object)
Sets any user object to this type.

Parameters:
object - any user object

getDisplayValue

java.lang.String getDisplayValue()
Returns this type as a String representation.

Returns:
this type as a String representation

getTypeClassification

short getTypeClassification()
Returns the type classification.


hasValidationError

boolean hasValidationError()
Returns true if an validation error exists for this type.


hasUIDefinition

boolean hasUIDefinition()
Returns true if the uiDefinition is alredy set.


isKey

boolean isKey()
Returns true if this type is a key selector.


isKeyRef

boolean isKeyRef()
Returns true if this type is a key ref selector.


isKeyContext

boolean isKeyContext()
Returns true if this type is a key context used in KeyKeyRefManager.


setIsKeyContext

void setIsKeyContext(boolean isContext)
Set true if this type is a key context!

Parameters:
isContext - true if this type is a key context

setApplicationRequired

void setApplicationRequired(boolean required)
Sets if an user input is required for this type or not (overwrites xml schema cardinality).

Parameters:
required - true if an user input is required for this type

setCodeSetValues

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.

Parameters:
url - the url of the codeSet to be set
codeSetName - the name of the codeSet to be set
values - the values of the codeSet
defaultSelection - the default selected code

setBackground

void setBackground(java.awt.Color color)
See Also:
Component.setBackground(java.awt.Color)

setForeground

void setForeground(java.awt.Color color)
See Also:
Component.setForeground(java.awt.Color)

setLabelColor

void setLabelColor(java.awt.Color color)
See Also:
Visualizer.setLabelColor(java.awt.Color)

setLabelText

void setLabelText(java.lang.String text)
See Also:
Visualizer.setLabelText(java.lang.String)

setVisible

void setVisible(boolean visible)
Sets the visualizer of this type visible or invisible at runtime. Note: If you want to exclude the type of the rendering process, use setRenderable(false)!

Parameters:
visible - true if the component should be visible

getTemplate

Type getTemplate()

setTemplate

void setTemplate(Type template)

setRenderable

void setRenderable(boolean renderable)
Defines if the type should be included into the rendering process. Note: If the type is not rendered it can't be make visible by an uiAction defined in a rule!

Parameters:
renderable - false if the type should not be rendered

isRenderable

boolean isRenderable()
Returns true if the type is included into the rendering process. Note: If the type is not rendered it can't be make visible by an uiAction defined in a rule!


setEditable

void setEditable(boolean editable)
Sets the component editable or not editable.

Parameters:
true - if the component should be editable

setEnabled

void setEnabled(boolean enabled)
Sets the component enabled (active) or disabled (inactive).

Parameters:
true - if the component should be enabled

setVisibleAndSerializable

void setVisibleAndSerializable(boolean visible,
                               boolean isSerializable)
Sets the component visible or invisible and defines if the data will be serialized or not.

Parameters:
visible - true if the component should be visible
isSerializable - true if the entered data should be serialized

showLabel

void showLabel(boolean visible)
Sets the label visible or invisible.

Parameters:
visible - true if the label should be visible

isRecursive

boolean isRecursive()
Returns true if this type is starting a new recursion.


getTreeHierarchyContext

java.lang.String getTreeHierarchyContext()
Returns the treeEntry hierarchy of the current type as coma separated String (context).

Returns:
the treeEntry hierarchy as String

getShortCaption

java.lang.String getShortCaption()
Returns the nls translated (if any) xpath of a type up to its upper most represented tree node parent. Only tree node parents are listed whereas all other parents as well as the root type are dismissed. Hierarchies are separated by " - ". Example: /purchaseOrder/shipToAdress/name -> purchaseOrder has a treeEntry, shipToAdress not. This would give following expression: purchaseOrder - name

Returns:
an nls translated (if any) xpath of a type up to its upper most represented tree node parent

getFullCaption

java.lang.String getFullCaption()
Returns the nls translated (if any) xpath of a type up to its upper most represented tree node parent. All parent types are checked (unlike getShortCaption()). The parent type that are represented as tree nodes will be listed with their nls treeEntry label. Each element caption will be cut by the global defined length and will get the string "...". The elements will be separated by the string " - ". For elements with cardinality n, the index within the list will be added at the end. If a schema key has been defined for an element, the key will be used as index for n, else the xpath-index will be applied. Example: /purchaseOrder/item[s]/item[1]/productDescription This would give following expression: purchaseOrder - item - item[1] - productDescription

Returns:
an nls translated (if any) xpath of a type up to its upper most represented tree node parent
See Also:
getFullCaption(int)

getFullCaption

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. All parent types are checked (unlike getShortCaption()). The parent type that are represented as tree nodes will be listed with their nls treeEntry label. Each element caption will be cut by the global defined length and will get the string "...". The elements will be separated by the string " - ". For elements with cardinality n, the index within the list will be added at the end. If a schema key has been defined for an element, the key will be used as index for n, else the xpath-index will be applied. Example: /purchaseOrder/item[s]/item[1]/productDescription This would give following expression: purchaseOrder - item - item[1] - productDescription

Parameters:
labelLength - the length of each element description label that will be displayed
Returns:
an nls translated (if any) xpath of a type up to its upper most represented tree node parent

getRepresentedTreeNodeParentIcon

javax.swing.ImageIcon getRepresentedTreeNodeParentIcon()
Returns the uppermost icon that can be found of the tree node parents of the current type.

Returns:
the icon of the uppermost tree node parent

getRepresentedTreeNodeParentIconName

java.lang.String getRepresentedTreeNodeParentIconName()
Returns the name of the uppermost icon that can be found of the tree node parents of the current type.

Returns:
the name of the icon of the uppermost tree node parent

getNextSibling

Type getNextSibling()
Returns the next sibling type of the current type.

Returns:
the next sibling type

getPreviousSibling

Type getPreviousSibling()
Returns the previous sibling type of the current type.

Returns:
the previous sibling type

isDerivedFromEditingType

boolean isDerivedFromEditingType()
Returns true if this type is derived from an editing type.


isIncluded

boolean isIncluded()
Returns true if this type was included from an included xui file.


getMixedContent

Type getMixedContent()
Returns the mixed content leaf type or null if none.


getVisualName

java.lang.String getVisualName()
Returns the visual name of this type.


markAsDirtyXPath

void markAsDirtyXPath()
Marks an xpath as dirty. It will be recalculated the next time.


hasRecursionBeenBuilt

boolean hasRecursionBeenBuilt()
Returns true if type is a recursion holder and recursive start element has been created yet.


isGlobal

boolean isGlobal()
Return true it this type is global.


removeTreeNode

void removeTreeNode(boolean shouldBeSerialized)
Removes this type from the tree.

Parameters:
shouldBeSerialized - defines if the content of this type will be serialized

addTreeNode

void addTreeNode(boolean shouldBeSerialized)
Adds this type to the tree.

Parameters:
shouldBeSerialized - defines if this type should be serialized

hasUndefinedChildren

boolean hasUndefinedChildren()
Returns true it this type holds a direct optional child.


removeMessage

void removeMessage()
Removes all validation error messages for this type.


showMessage

void showMessage(java.lang.String message,
                 java.lang.String classification,
                 boolean showDialog,
                 boolean needsUserAcceptance)
Dislplays a message for this type with the passed information.

Parameters:
message - message text
classification - category (info, warning,...)
showDialog - defines if message should be shown as dialog
needsUserAcceptance - defines if user needs to accept message or not

setTreeIcon

void setTreeIcon(java.lang.String gifName)
Set the tree icon for this type.

Parameters:
gifName - name of the gif for the tree icon

getName

java.lang.String getName()
Returns the name witout namespace previx.


getSerializationName

java.lang.String getSerializationName()

isUserInstanciated

boolean isUserInstanciated()

setUserInstanciated

void setUserInstanciated(boolean userTriggered)

unChoosenBranch

boolean unChoosenBranch()

isReleased

boolean isReleased()

getSchemaType

SchemaType getSchemaType()

getStyle

StyleDefinition getStyle()