|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.jaxfront.core.type.VirtualType
public class VirtualType
This class represents a VirtualType which is a JAXFront type. VirtualTypes exist only within JAXFront, they cannot be defined in an XML Schema and cannot be bound to an XML instance. Virtual Types are used in placing a formula field within a table layout.
| Field Summary |
|---|
| Fields inherited from interface com.jaxfront.core.type.Type |
|---|
ComplexGroup, ComplexGroupList, CompositeType, DummyType, EmptyType, GroupType, ListType, NONE, SimpleGroup, SimpleGroupList, SimpleType, SimpleTypeList, VirtualType |
| Constructor Summary | |
|---|---|
VirtualType(Type sourceType)
Creates a VirtualType based on a holder type. |
|
| Method Summary | |
|---|---|
void |
addNotFiredInitializationRule(Rule initializationRule)
|
void |
addTreeNode(boolean shouldBeSerialized)
Adds this type to the tree. |
void |
bind(Document dOM,
org.w3c.dom.Element element)
Binds an existing W3C element and its value(s) to the underlying W3C element. |
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 includeData)
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 |
deepClone(Document dom,
boolean cloneChoices,
boolean includingData,
SchemaNode schemaNode,
org.w3c.dom.Element element)
|
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 child 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 for JTables. |
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 document (DOM) expressing axis position. |
int |
getLevel()
Gets the tree hierarchy level. |
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. |
java.util.LinkedHashMap |
getNotFiredInitializationRules()
|
Type |
getParent()
Returns the JAXFront type parent. |
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 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. |
Type |
getSourceType()
Gets the type that releases this VirtualType. |
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 |
getValue()
Gets the value of 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 lazyInitialization)
Gets the current XUI definition saying if a xui definition should be initialized lazy if it does not exist. |
boolean |
hasChoosenType()
|
boolean |
hasNotFiredInitializationRules()
|
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 |
isKeyField()
|
boolean |
isKeyRef()
Returns true if this type is a key ref selector. |
boolean |
isKeyRefField()
|
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 |
isRecursiveHolder()
|
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 |
serializeXOM(java.lang.StringBuffer sb,
int indent,
boolean writeName,
boolean recursive)
|
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)
Sets the codeSet values for the current type. |
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 |
setFormulaExpression(FormulaExpression formula)
|
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 |
setName(java.lang.String name)
|
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 |
setTempVisible(boolean visible,
boolean isTemp)
|
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 |
setValue(java.lang.String newValue)
Sets a new value for 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()
|
void |
validate()
Validates this type. |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public VirtualType(Type sourceType)
sourceType - a type that releases a VirtualType| Method Detail |
|---|
public Type getRepresentedTreeNodeHolder()
Type
getRepresentedTreeNodeHolder in interface Type
public void bind(java.lang.Object trigger,
Type type)
bind in interface TypeDOM - the current document to which this type belongstrigger - trigger object e.g. Clipboard,Button used to identify user triggered actionstype - the type to bind topublic void bind(Type type)
bind in interface TypeDOM - the current document to which this type belongstype - the type to bind to
public void bind(Document dOM,
org.w3c.dom.Element element)
bind in interface TypeDOM - the current document to which this type belongselement - the element to bind
public Type deepClone(Document dom,
boolean cloneChoices,
boolean includeData)
throws java.lang.CloneNotSupportedException
deepClone in interface Typedom - the current dom to which this type belongsincludeData - indicates if all binded data should be copied as well (default is false)
java.lang.CloneNotSupportedException
public Type deepClone(Document dom,
boolean cloneChoices,
boolean includingData,
SchemaNode schemaNode,
org.w3c.dom.Element element)
throws java.lang.CloneNotSupportedException
java.lang.CloneNotSupportedExceptionpublic Type getDirectChild(java.lang.String name)
getDirectChild in interface Typename - name of the child
public java.util.List getDirectChildren()
getDirectChildren in interface Typepublic boolean isVirtual()
Type
isVirtual in interface Typepublic java.util.List getDirectChildren(java.lang.String name)
getDirectChildren in interface Typename - the name of the child(s)
public java.lang.String getDirectChildValue(java.lang.String name)
getDirectChildValue in interface Typename - the name of the child
public Type getChoosenType()
getChoosenType in interface Typepublic java.lang.Object getClientProperty(java.lang.String key)
Type
getClientProperty in interface Typepublic Type getRepresentedTableLayoutParent()
Type
getRepresentedTableLayoutParent in interface Typepublic java.util.List getDerivedTypes()
getDerivedTypes in interface Typepublic Document getDOM()
getDOM in interface Typepublic short[] getId()
getId in interface Typepublic int getLevel()
public java.lang.String getName()
Type
getName in interface TypeType.getName()public void setName(java.lang.String name)
name - public java.lang.String getNamespace()
getNamespace in interface Typepublic Type getParent()
getParent in interface Typepublic Type getParent(java.lang.String parentName)
getParent in interface TypeparentName - the name of the parent type
public ListType getParentList()
getParentList in interface Typepublic java.beans.PropertyChangeSupport getPropertyChangeSupport()
getPropertyChangeSupport in interface Typepublic Type getRepresentedTabParent(boolean checkCurrentType)
getRepresentedTabParent in interface Typepublic Type getRepresentedTreeNodeParent()
getRepresentedTreeNodeParent in interface Typepublic SchemaNode getSchemaElement()
getSchemaElement in interface Typepublic Type getSourceType()
public XUIDefinition getXUIDefinition()
getXUIDefinition in interface Typepublic XUIDefinition getXUIDefinition(boolean lazyInitialization)
Type
getXUIDefinition in interface Typepublic java.lang.Object getUserObject()
getUserObject in interface Typepublic java.lang.String getValue()
public java.lang.String getXPathLocation()
getXPathLocation in interface Typepublic boolean hasRepresentableTreeChildren()
hasRepresentableTreeChildren in interface Typepublic boolean isAbstract()
isAbstract in interface Typepublic boolean isAnonymous()
isAnonymous in interface Typepublic boolean isAttribute()
isAttribute in interface Typepublic boolean isChoice()
isChoice in interface Typepublic boolean isComposite()
isComposite in interface Typepublic boolean isSerializable()
Type
isSerializable in interface TypeType.isSerializable()public boolean isSerializable(boolean checkValue)
Type
isSerializable in interface TypecheckValue - true if the serialize process should check if the type's value
is null
Type.isSerializable(boolean)public boolean isDerived()
isDerived in interface Typepublic boolean isDerivedFrom(Type type)
isDerivedFrom in interface Typetype - parent type
public boolean isEditingType()
isEditingType in interface Typepublic boolean isEmpty()
isEmpty in interface Typepublic boolean isList()
isList in interface Typepublic boolean isRepresentedAsHeader()
isRepresentedAsHeader in interface Typepublic boolean isRepresentedAsTab()
isRepresentedAsTab in interface Typepublic boolean isRepresentedAsTreeNode()
isRepresentedAsTreeNode in interface Typepublic boolean isRequired()
isRequired in interface Typepublic boolean isRoot()
isRoot in interface Typepublic boolean isSimple()
isSimple in interface Type
public void putClientProperty(java.lang.String key,
java.lang.Object object)
putClientProperty in interface TypeType.putClientProperty(java.lang.String, java.lang.Object)public void release()
Type
release in interface TypeType.release()public boolean remove()
remove in interface Typepublic void removeAll()
removeAll in interface Typepublic boolean removeChild(Type child)
removeChild in interface Typechild - a child type of this typepublic java.lang.StringBuffer serialize()
serialize in interface Typesb - a StringBuffer into which the subTree will be serializedindent - size of indentwriteName - true, if the name of the type should be serialized, false otherwise
public void serialize(java.lang.StringBuffer sb,
int indent,
boolean writeName,
boolean recursive)
serialize in interface Typesb - 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 serialized
public void serializeXOM(java.lang.StringBuffer sb,
int indent,
boolean writeName,
boolean recursive)
public void setDirectChildValue(java.lang.String childName,
java.lang.String value)
setDirectChildValue in interface TypechildName - the name of the childvalue - the value to setpublic void setChoosenType(Type choosenType)
setChoosenType in interface TypechoosenType - the type that is currently choosen
public void setChoosenType(Type choosenType,
boolean temporary)
setChoosenType in interface TypechoosenType - the type that is choosentemporary - true, if the choosen type acts temporarily as choosen type, false otherwisepublic void setDOM(Document dOM)
setDOM in interface TypeDOM - a JAXFront document (DOM)public void setId(short[] id)
setId in interface Typeid - a unique IDpublic void setSerializable(boolean isDefined)
setSerializable in interface TypeisDefined - true if this type should be serialized in the resulting W3C DOM, false otherwisepublic void setParent(Type parent)
setParent in interface Typeparent - the parent type of the current typepublic void setSchemaElement(SchemaNode element)
setSchemaElement in interface Typeelement - the meta information schema elementpublic void setUIDefinition(XUIDefinition uiDefinition)
setUIDefinition in interface TypeuiDefinition - a XUI definitionpublic void setUserObject(java.lang.Object object)
setUserObject in interface Typeobject - any user objectpublic void setValue(java.lang.String newValue)
newValue - a new valuepublic java.lang.String getDisplayValue()
getDisplayValue in interface Type
public void validate()
throws ValidationException
ValidationException - if this type is mandatorypublic boolean hasValidationError()
Type
hasValidationError in interface TypeType.hasValidationError()public boolean isKeyField()
Type.isKey()
public void setSerializable(boolean isDefined,
boolean checkForEmptyContent)
Type
setSerializable in interface TypeisDefined - 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
contentcom.jaxfront.core.type.Type#setIsDefined(boolean, boolean)public void setApplicationRequired(boolean required)
setApplicationRequired in interface Typerequired - true if an user input is required for this type
public void setCodeSetValues(java.lang.String url,
java.lang.String codeSetName,
java.lang.String[] values)
url - the url of the codeSet to be setcodeSetName - the name of the codeSet to be setvalues - the values of the codeSetpublic void setBackground(java.awt.Color color)
setBackground in interface TypeComponent.setBackground(java.awt.Color)publi