com.jaxfront.core.xui
Class StyleDefinition

java.lang.Object
  extended by com.jaxfront.core.xui.AbstractXUIElement
      extended by com.jaxfront.core.xui.StyleDefinition
All Implemented Interfaces:
XUIElementPaths, XUITypes, java.io.Serializable, java.lang.Cloneable

public class StyleDefinition
extends AbstractXUIElement
implements XUITypes, XUIElementPaths

The StyleDefinition encapsulate all graphical layout definitions of a XUI component. For a detailed description look at the xui.xsd Schema [/XUI/component/style].

Version:
1.60
See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.jaxfront.core.xui.AbstractXUIElement
COMPONENT_BEHAVIOR_BRANCH, COMPONENT_STYLE_BRANCH, GLOBAL_BEHAVIOR_BRANCH, GLOBAL_BRANCH, GLOBAL_GENERAL_BRANCH, GLOBAL_STYLE_BRANCH, UNDEFINED_BRANCH
 
Fields inherited from interface com.jaxfront.core.xui.XUIElementPaths
BEHAVIOUR_DEFINITION_PATH, CAPTION_INDENT_APPLYONDESC, CAPTION_INDENT_APPLYONDESC_APPLYON, CAPTION_INDENT_APPLYONDESC_INDENTNESTED, CAPTION_INDENT_APPLYONDESC_NESTED, CAPTION_INDENT_VALUE, CAPTION_STYLE, CAPTION_STYLE_ALLOW_COPY_PASTE, CAPTION_STYLE_HEADERIMAGE, CAPTION_STYLE_OCCURRENCE, CAPTION_STYLE_OCCURRENCE_APPLYONDESC, CAPTION_STYLE_OCCURRENCE_VISIBILITY, CAPTION_STYLE_OCCURRENCE_VISIBILITY_DEPENDSON, CAPTION_STYLE_OCCURRENCE_VISIBILITY_DEPENDSON_XPATH, CAPTION_STYLE_TYPE, CAPTION_STYLE_TYPE_BORDER_COLLAPSED, CAPTION_STYLE_TYPE_BORDER_STYLE, CAPTION_STYLE_TYPE_SEPARATOR_STYLE, CAPTION_STYLE_TYPE_SEPARATOR_STYLE_FULL, CAPTION_USERMODIFIEDSERIALIZATION, CAPTION_USERMODIFIEDSERIALIZATION_COLLAPSED, CHOICE_DEFAULTSELECTION, CHOICE_DEFAULTSELECTION_FULL, CHOICE_ORIENTATION, CHOICE_SINGLECHOICEANDSERIALIZE, CHOICE_TYPE, COMPOSITE_COMPONENT_COLUMNWIDTH, COMPOSITE_EDITORCOMPONENT_VISIBLE, COMPOSITE_LABEL_COLUMNWIDTH, COMPOSITE_LABEL_INDENT, COMPOSITE_LABEL_MULTI, COMPOSITE_LABEL_UNDERLINE, COMPOSITE_LABEL_VISIBLE, FULL_BEHAVIOUR_DEFINITION_PATH, FULL_STYLE_DEFINITION_PATH, GENERAL, GENERAL_LANGUAGE, GLOABAL_CAPTION, GLOABAL_CAPTION_TAB_BOTTOMSPACE, GLOBAL_CAPTION_BORDER, GLOBAL_CAPTION_HEADER, GLOBAL_CAPTION_HEADER_BOTTOMSPACE, GLOBAL_CAPTION_SEPARATOR, GLOBAL_CAPTION_SEPARATOR_CLASSIC, GLOBAL_CAPTION_SEPARATOR_MODERN, GLOBAL_CAPTION_SEPARATORCLASSIC_BOTTOMSPACE, GLOBAL_CAPTION_SEPARATORMODERN_BOTTOMSPACE, GLOBAL_CAPTION_TAB, GLOBAL_DEFINITION, GLOBAL_STYLE, GLOBAL_STYLE_BOTTOMSPACE, GLOBAL_STYLE_CAPTION, GLOBAL_STYLE_CHOICEANDENUMERATION, GLOBAL_STYLE_COMPONENT, GLOBAL_STYLE_COMPONENT_BOOLEANVISUALIZER, GLOBAL_STYLE_COMPONENT_COLUMNWIDTH, GLOBAL_STYLE_EDITORPANEL, GLOBAL_STYLE_ERRORDISPLAY, GLOBAL_STYLE_LABEL, GLOBAL_STYLE_NAVIGATIONTREE, GLOBAL_STYLE_NAVIGATIONTREE_ROOT, GLOBAL_STYLE_NAVIGATIONTREE_SELECTION, HELP, KEY_CONTEXT, KEY_CONTEXT_DIALOG_BUTTONSEQUENCE, KEY_CONTEXT_DIALOG_LOCATION, KEY_CONTEXT_LOCATION, KEYREF_CONDITION_FORMULAEXPRESSION, KEYREF_SELECTIONLINEINFO_FORMULAEXPRESSION, LAYOUT_LABELCOMPONENT_STARTELEMENT, LEAF_COMPONENT, LEAF_COMPONENT_BOOLEANVISUALIZER, LEAF_COMPONENT_COLUMNWIDTH, LEAF_COMPONENT_HREF, LEAF_COMPONENT_MASK, LEAF_COMPONENT_MASK_ALLOWINVALID, LEAF_COMPONENT_MASK_MASK, LEAF_COMPONENT_MASK_OVERWRITEMODE, LEAF_COMPONENT_MASK_PLACEHOLDER, LEAF_COMPONENT_MASK_VALIDCHARS, LEAF_COMPONENT_MASKCOMMITONVALIDEND, LEAF_COMPONENT_MASKINVALIDCHARS, LEAF_COMPONENT_MULTILINE, LEAF_COMPONENT_SHOWASLABEL, LEAF_COMPONENT_SHOWBACKLINKBUTTON, LEAF_COMPONENT_SHOWDETAILSBUTTON, LEAF_COMPONENT_SHOWNEWBUTTON, LEAF_COMPONENT_TIMEFORMAT, LEAF_COMPONENT_USEGROUPDELIM, LEAF_COMPONENT_VALUE_DATATYPE, LEAF_COMPONENT_VALUE_ENUMERATION, LEAF_COMPONENT_VALUE_ENUMERATION_CODESET, LEAF_COMPONENT_VALUE_ENUMERATION_CODESET_CLASS, LEAF_COMPONENT_VALUE_ENUMERATION_CODESET_NAME, LEAF_COMPONENT_VALUE_ENUMERATION_CODESET_URL, LEAF_COMPONENT_VALUE_ENUMERATION_CODESETALLOWINVALIDCODES, LEAF_COMPONENT_VALUE_ENUMERATION_CODESETSHOWERRORFORINVALIDCODE, LEAF_COMPONENT_VALUE_ENUMERATION_DEFAULT, LEAF_COMPONENT_VALUE_ENUMERATION_DEFAULT_FULL, LEAF_COMPONENT_VALUE_ENUMERATION_LIST_ENTRIES, LEAF_COMPONENT_VALUE_ENUMERATION_ORIENTATION, LEAF_COMPONENT_VALUE_ENUMERATION_TYPE, LEAF_COMPONENT_VALUE_ENUMERATION_TYPE_ISENUMERATIONTYPE, LEAF_COMPONENT_VALUE_ENUMERATION_TYPE_ISENUMERATIONTYPE_FULL, LEAF_COMPONENT_VALUE_SERIALIZECONTENTCDATA, LEAF_COMPONENT_VALUE_SINGLE_DEFAULT, LEAF_COMPONENT_VALUE_SINGLE_DEFAULT_FULL, LEAF_EDITORCOMPONENT_VISIBLE, LEAF_LABEL_COLUMNWIDTH, LEAF_LABEL_INDENT, LEAF_LABEL_MULTI, LEAF_LABEL_UNDERLINE, LEAF_LABEL_VISIBLE, LIST_COMPONENT_COLUMNWIDTH, LIST_EDITORCOMPONENT_VISIBLE, LIST_LABEL_COLUMNWIDTH, LIST_LABEL_INDENT, LIST_LABEL_MULTI, LIST_LABEL_UNDERLINE, LIST_LABEL_VISIBLE, LIST_LABELCOMPONENT_STARTELEMENT, MODE_APPLY_VIEWHOLDER, MODE_APPLY_VIEWHOLDER_FULL, MODE_CHILDRENVIEW, MODE_DISPLAYVALUE, MODE_EDITABLE, MODE_EDITABLE_TEMPORARY, MODE_ISREQUIRED, MODE_ISREQUIRED_FULL, MODE_MANDATORYEXPRESSION, MODE_MESSAGE_CLASSIFICATION, MODE_MESSAGE_NEEDUSERACCEPTANCE, MODE_READONLY, MODE_SERIALIZE, MODE_VIEWHOLDER, MODE_VISIBLE, PLUGIN_FORMULAEXPRESSION, PRINTING_CHOICEASHEADER, PRINTING_LISTPRINTMODE, PRINTING_PRINTABLE, RULE_EVENT_SCOPE, TREEENTRY_ICON, TREEENTRY_LABEL, TREEENTRY_OCCURRENCE_ISFOCUSABLE, TREEENTRY_OCCURRENCE_SHOWCHILDSOPTIONAL, TREEENTRY_OCCURRENCE_SHOWOPTIONAL, TREEENTRY_OCCURRENCE_VISIBILITY, TREEENTRY_OCCURRENCE_VISIBILITY_APPLYONDESC, TREEENTRY_OCCURRENCE_VISIBILITY_DEPENDSON, TREEENTRY_POPUPCLASS, TREEENTRY_SHOW_SEARCH, VIEW_HOLDER_TYPE
 
Constructor Summary
StyleDefinition(XUIDefinition xuiDefinition, StyleDefinition styleDefinition)
          Creates a StyleDefinition for the given XUIDefintion based on an other StyleDefinition.
StyleDefinition(XUIDefinition xuiDefinition, Type xuiType)
          Creates a StyleDefinition for the given XUIDefintion based on information provided by the xuiType
 
Method Summary
 boolean applyViewHolderOnDirectDescendants()
           
static ButtonEnabling checkEnabling(Type forType)
           
 java.lang.String getActAs()
          Returns the user overwritten datatype, this change has only an effect if the jaxfront type will become visible within a gui.
 java.awt.Color getBackgroundColor()
          Returns the background color for the current type.
 java.lang.String getBooleanVisualizer()
           
 float getCaptionIndentValue()
           
 java.lang.String getCaptionOccurrenceDependsOnXPath()
           
 java.lang.String getCaptionTitleID()
          Returns the caption label id (for a help system).
 java.lang.String getCaptionTitleLabel()
          Returns the caption label in the current language.
 java.lang.String getCaptionTitleToolTip()
           
 java.lang.String getCaptionType()
           
 java.lang.String getCaptionVisibility()
           
 java.lang.String getChildrenView()
           
 java.lang.String getChoiceDefaultSelection()
           
 java.lang.String getChoiceLabel()
           
 java.lang.String getChoiceOrientation()
           
 java.lang.String getChoiceType()
           
 java.lang.String getCodeSetClass()
          Returns the codeSet class name.
 java.lang.String getCodeSetName()
           
 java.lang.String getCodeSetURL()
          Returns the codeSet URL location.
 java.lang.String[] getCodeSetValuesFromClass(java.lang.String classURL, java.lang.String codeSetName)
           
 java.lang.String[] getCodeSetValuesFromFile(java.lang.String fileURL, java.lang.String codeSetName)
           
 java.lang.String getCodeSetXPointer()
          Returns the codeSet URL location.
 float getComponentColumnWidth()
          Returns the component column width.
 float getComponentIndent()
          Returns the indent for the component.
 float getComponentSize()
          Returns the size (long/middle/short) for the component.
 java.lang.String getContextDialogBounds()
           
 java.lang.String getContextDialogButtonSequence()
           
 java.awt.Point getContextDialogLocation()
           
 java.awt.Dimension getContextDialogSize()
           
 java.lang.String getDeletionConfirmationMessageText()
          Returns the message text that will be displayed in the confirmation message dialog to confirm deletion of the selected list item.
 java.lang.String getDialogLabel()
           
 java.lang.String getDisplayValue()
          Returns a specified text that acts as a display value for the current node.
 java.lang.String[] getEnumeration()
           
 ListEntry[] getEnumerationEntries()
           
 java.lang.String getEnumerationSortOrder()
           
 java.awt.Color getForegroundColor()
          Returns the foreground color for the current type.
 java.lang.String getHeaderImageURL()
           
 java.lang.String getHelpText()
           
 java.lang.String getHelpText(java.lang.String language)
           
 java.awt.Color getHintColor()
           
 java.lang.String getHintText()
           
 java.lang.String getKeyContextDialogLabel()
          Returns the key context dialog label in the current language.
 java.lang.String getKeyContextLocation()
           
 java.lang.String getKeyRefConditionFE()
           
 java.lang.String getKeyRefSelectionLineInfoFE()
           
 java.lang.String getLabelChoiceText()
           
 java.awt.Color getLabelColor()
          Returns the label color for the current type.
 float getLabelColumnWidth()
          Returns the label column width.
 java.lang.String getLabelIcon()
          Returns the name of the label icon.
 java.lang.String getLabelIconPosition()
          Returns the position of the label icon.
 float getLabelIndent()
           
 java.lang.String getLabelText()
          Returns the visual label in the current language.
 java.lang.String getLabelToolTip()
           
 java.util.Vector getLayoutInfos()
           
 LayoutInfo getLayoutManager()
          Returns the layout info (default is null).
 LayoutInfo getLayoutManager(java.lang.String id)
          Returns the id of the tableLayout.
 java.lang.String getLeafComponentHRef()
           
 java.lang.String getLeafDefaultValue()
           
 java.lang.String getLeafEnumerationDefaultSelection()
           
 java.lang.String getLeafEnumerationOrientation()
           
 java.lang.String getLeafEnumerationType()
           
 java.lang.String getLeafLabelHRef()
          Returns the href of the label.
 java.lang.String getLeafMask()
           
 boolean getLeafMaskAllowInvalid()
           
 boolean getLeafMaskCommitOnValidEnd()
           
 java.lang.String getLeafMaskInvalidChars()
           
 boolean getLeafMaskOverwriteMode()
           
 java.lang.String getLeafMaskPlaceHolder()
           
 java.lang.String getLeafMaskValidChars()
           
 ListInfo getListInfo()
           
 java.lang.String getListPrintMode()
          Returns the print mode for this list type.
 java.lang.String getMandatoryExpression()
           
 int getMultiLineNumberComponent()
           
 java.lang.Float getNestedCaptionIndent()
           
 java.lang.String getNLS(java.lang.String context, java.lang.String subId, java.lang.String classification)
           
 java.lang.String getNLS(java.lang.String defaultNLS, java.lang.String context, java.lang.String subId, java.lang.String classification)
           
 java.lang.String getPageTitle(Type pageType, int pageIndex)
           
 float getPDFCaptionFontSize()
           
 int getPDFCaptionIndent()
           
 float getPDFComponentFontSize()
           
 float getPDFLabelFontSize()
           
 int getPDFLabelIndent()
           
 PluginBean getPluginBean()
          Returns a PluginBean if available.
 java.lang.String getPlugInFormulaExpressionByID(java.lang.String id)
           
 Type getPlugInFormulaExpressions()
           
 boolean getPrimitiveBooleanProperty(java.lang.String fullPath, java.lang.String relativePath)
           
 java.lang.String getPrintable()
          Returns wether this type should be printed out or not.
 boolean getSerializable()
          Returns true if the value of the correspondent component should be serialized into an xml instance.
 java.lang.Boolean getSerializableDefault()
          Returns true if the value of the correspondent component should be serialized into an xml instance. null if nothing is defined.
 java.lang.String getSplitterLayoutDefinition()
           
 java.lang.Integer getTabIndex()
          Sets the tab index if this type is visualized as a tab.
 java.lang.String getTableModelClass()
          Returns the table model class (default: com.jaxfront.core.ui.FlipOrientationTableModel)
 java.lang.String getTablePosition()
          Returns the table position (north [default], south, east, west).
 java.lang.String getTimeFormat()
           
 int getTotalNumberOfPages()
           
 java.lang.String getTreeEntryDependsOnXPath()
          Returns the xpath of the node on which this treeEntry depends.
 java.lang.String getTreeEntryMode()
          Returns the selected treeEntry mode as String.
 java.lang.String getTreeEntryToolTip()
           
 java.lang.String getTreeIcon()
           
 java.lang.Object getTreeLabelFormulaResult()
           
 java.lang.String getTreeLabelText()
           
 java.lang.String getTreePopUpClass()
           
 java.util.List getUserListActions()
           
 java.lang.String getValidationErrorClassification()
          Returns the classification of the validation error message.
 java.lang.String getValidationErrorMessage()
          Returns the validation error message as defined in the xui.
 Type getViewContextType()
           
 java.lang.String getViewHolder()
           
 boolean hasCaption()
          Returns true if this component uses a caption.
 boolean hasDisplayValue()
           
 boolean hasHeader()
          Returns true if this definition defines a header for a list.
 boolean hasHeaderImageURL()
          Returns true if an url of a header image has been defined.
 boolean hasHint()
           
 boolean hasKeyContextLocation()
          Returns if a context location path has been defined for a key.
 boolean hasKeyRefConditionFormulaExpression()
          Returns if a selection lineInfo formula expression has been defined for a keyRef type.
 boolean hasKeyRefSelectionLineInfoFE()
          Returns if a selection lineInfo formula expression has been defined for a keyRef type.
 boolean hasTableLayoutParent()
           
 boolean hasTreeIconFormula()
           
 boolean hasTreeLabelFormulaExpression()
           
 boolean hasUserModfiedSerialization()
          Returns true if a xui style exists for global style caption usermodifiedserilization
 boolean isAllowingCopyPaste()
           
 boolean isApplicationRequired()
          Returns true if this component should be drawn as required for the application (not schema required).
 boolean isBooleanViewCheckBox()
           
 boolean isBooleanViewRadioButton()
           
 boolean isBooleanViewRadioButtonUnselected()
           
 boolean isBorderCollapsed()
           
 boolean isCaptionIndentApplyOnAllDescendants()
           
 boolean isCaptionIndentApplyOnBoth()
           
 boolean isCaptionIndentApplyOnComponent()
           
 boolean isCaptionIndentApplyOnDirectDescendants()
           
 boolean isCaptionIndentApplyOnLabel()
           
 boolean isCaptionOccurrenceAlways()
           
 boolean isCaptionOccurrenceApplyOnAllDescendants()
           
 boolean isCaptionOccurrenceApplyOnDirectDescendants()
           
 boolean isCaptionOccurrenceDependsOn()
           
 boolean isCaptionOccurrenceNever()
           
 boolean isCaptionTypeBorder()
           
 boolean isChoiceAsComboBox()
          Returns true if this is a choice component displayed as a combobox.
 boolean isChoiceAsRadioButton()
          Returns true if this is a choice component displayed as a radioButton group.
 boolean isChoiceOrientationHorizontal()
          Returns true if the choice orientation is set to HORIZONTAL, false otherwise
 boolean isComponentMulti()
          Returns true if this component uses more than one line to display.
 boolean isDefaultLayout()
          Returns true if this definition uses no special layout.
 boolean isDialogMode()
          Returns true if this definition defines a dialog mode to edit childs within a list.
 boolean isEditable()
          Returns true if this component is editable which means that the editor component will be displayed as enabled but without the functionality to enter any values.
 boolean isEditorComponentVisible()
          Returns true if the editor component of the current type is visible.
 boolean isEnabled()
          Disables this component.
 boolean isEnumeration()
          Returns true if this definition defines a choice (choice list,codeset or schema enumeration).
 boolean isEnumerationAllowingInvalidCodes()
          Returns true if an enumeration allows to show invalid codes of a codeset.
 boolean isEnumerationAsComboBox()
          Returns true if this is an enumeration component displayed as a radioButton group.
 boolean isEnumerationAsListBox()
          Returns true if this is an enumeration component displayed as a list box.
 boolean isEnumerationAsRadioButton()
          Returns true if this is an enumeration component displayed as a radioButton group.
 boolean isEnumerationOrientationHorizontal()
          Returns true if the enumeration orientation is set to HORIZONTAL, false otherwise
 boolean isEnumerationShowErrorForInvalidCodes()
          Returns true if an error will be thrown when selecting an invalid code set value
 boolean isHierarchyEnabled(Type startType)
           
 boolean isHintTextBold()
           
 boolean isHintTextFormula()
           
 boolean isInTableLayoutContext()
          Returns true if this component uses the table layout.
 boolean isKeyRefShowingBackLinkButton()
          Returns true if a keyRef component shows its "backLink" button.
 boolean isKeyRefShowingDetailsButton()
          Returns true if a keyRef component shows its "details" button.
 boolean isKeyRefShowingNewButton()
          Returns true if a keyRef component shows its "new" button.
 boolean isLabelIconPositionBottom()
          Returns true if the position of the label icon is set to bottom.
 boolean isLabelIconPositionLeft()
          Returns true if the position of the label icon is set to left.
 boolean isLabelIconPositionRight()
          Returns true if the position of the label icon is set to right.
 boolean isLabelIconPositionTop()
          Returns true if the position of the label icon is set to top.
 boolean isLabelMulti()
          Returns true if this component uses more than one line to display.
 boolean isLabelUnderlined()
          Returns true if this component uses more than one line to display.
 boolean isLabelVisible()
          Returns true if the label of the current type is visible.
 boolean isListPrintModeSerial()
          Returns true if the list print mode is serial.
 boolean isListPrintModeTable()
          Returns true if the list print mode is table.
 boolean isListPrintModeTableAndSerial()
          Returns true if the list print mode is table and serial.
 boolean isMarkedAsError()
          Returns true if this type is marked as an error.
 boolean isPagingLayout()
          Returns true if this component uses the paging layout.
 boolean isPanelMode()
          Returns true if this definition defines a dialog mode to edit childs within a list.
 boolean isParentViewHolder()
          Returns true if this component is displayed within its parent view and not within its own context.
 boolean isReadOnly()
          Returns true if this component is readOnly (disabled).
 byte isReadOnlyNoHash()
           
 boolean isRepresentedAsHeader()
          Returns true if this component is displayed with a header separator.
 boolean isRepresentedAsTab()
          Returns true if this component is displayed within a tab on a tabbed pane.
 boolean isRepresentedAsTreeNode()
           
 boolean isSelectionOnly()
          Same like Tableinfo but take count of isEditable and isReadOnly
 boolean isSelfViewHolder()
          Returns true if this component is displayed in its own context, not within its parent view.
 boolean isSerializableAsCDATA()
          Returns true if the content value is serializable as CDATA section.
 boolean isSerialView()
          Returns true if this component is displayed as a serial view.
 boolean isSingleChoiceAndSerialize()
          Returns true if the current choice does not allow an "empty selection" after a selection has been made.
 boolean isTabHolder()
          Returns true if this component displays its composites as separate tabs.
 boolean isTableLayout()
          Returns true if this component uses the table layout.
 boolean isTreeEntryAllowSearch()
          Returns whether the tree entry can show a search dialog or not.
 boolean isTreeEntryAlways()
          Returns true if this component is always displayed in the tree.
 boolean isTreeEntryApplyOnAllDescendants()
          Returns true if the current treeEntry settings will be applied to all its childs.
 boolean isTreeEntryApplyOnDirectDescendants()
          Returns true if the current treeEntry settings will be applied only to its direct childs.
 boolean isTreeEntryDependingOn()
          Returns true if this component's node is displayed depending on a other node's treeEntry.
 boolean isTreeEntryFocusable()
          Returns whether the tree entry can gain the focus by clicking the function keys F7 or F8.
 boolean isTreeEntryNever()
          Returns true if this component is never displayed in the tree.
 boolean isTreeEntryShowAsOptional()
          Returns true if the tree node of the current type should be visualized with a checkbox that allows to show/hide the corresponding component on the workspace.
 boolean isTreeEntryShowChildrenAsOptional()
          Returns true if the tree nodes of the children of the current type should be visualized with a checkbox that allows to show/hide the corresponding component on the workspace.
 boolean isUnlocked()
          Returns true if this component or an ancestor of myself is marked as an unlocked field.
 boolean isUserModifiedSerialization()
           
 boolean isUserModifiedSerializationCollapsed()
           
 boolean isUsingCodeSet()
          Returns true if using a codeSet definition.
 boolean isUsingGroupingDelimiters()
           
 boolean isUsingPlugIn()
          Returns true if this component is represented through a plugin bean.
 boolean isUsingTab()
           
 boolean isValidationErrorNeedingUserAcceptance()
          Returns true if the validation error message requires any user acceptance.
 boolean isVisible()
          Returns true if the current type is visible.
 boolean isVisibleAtRuntime()
           
 boolean isVisibleInOptionalTreeMode()
           
 byte isVisibleNoHash()
           
 boolean isXLinkCodeset()
           
 void markAsError(boolean markAsError)
          Marks this type as an error (e.q. based on a occured rule definition).
 void markAsUnlockedField()
          Mark field as temporarly editable (if field is an unlocked field).
 java.lang.Boolean printChoiceAsHeader()
          Returns true if this type is a choice and if it should be printed out as header.
 void reinitializeCodeSetValues()
           
 void release()
           
 void removeHint()
           
 boolean serializeAsXLink()
           
 void setActAs(java.lang.String actAs)
          Overwrites the datatype specified in the schema.
 void setApplicationRequired(boolean applicationRequired)
          Sets the editor component required within the application (not schema-required).
 void setBackgroundColor(java.awt.Color color)
          Sets the background color for the current type.
 void setBorderCollapsed(boolean collapsed)
           
 void setCaptionIndentValue(float newCaptionIndent)
           
 void setCaptionOccurrence(boolean hasCaption, java.lang.String applyOnDescendants)
           
 void setCodeSetClass(java.lang.String className)
          Sets the codeSet class name.
 void setCodeSetName(java.lang.String name)
          Sets the codeSet name.
 void setCodeSetURL(java.lang.String codesetURL)
          Sets the codeSet URL location.
 void setCodeSetValuesFromClass(java.lang.String classURL, java.lang.String codeSetName, java.lang.String[] values)
          Sets the codeset values from a java class.
 void setCodeSetValuesFromFile(java.lang.String fileURL, java.lang.String codeSetName, java.lang.String[] codes)
          Sets the codeset values from a codeset file.
 void setComponentColumnWidth(float width)
           
 void setComponentIndent(float newComponentIndent)
           
 void setEditable(boolean editable)
          Sets if the component is editable or not.
 void setEnabled(boolean enabled)
          Disables this component.
 void setEnumeration(java.lang.String[] selection)
           
 void setEnumerationEntries(ListEntry[] listEntries)
           
 void setForegroundColor(java.awt.Color color)
          Sets the foreground color for the current type.
 void setHint(java.lang.String text, boolean isFormula, java.awt.Color color, boolean isBold)
           
 void setIsVisibleInOptionalTreeMode(boolean isVisible)
           
 void setLabelColor(java.awt.Color color)
          Sets the label color for the current type.
 void setLabelColumnWidth(float width)
           
 void setLabelIndent(float newLabelIndent)
           
 void setLabelText(java.lang.String text)
          Sets the label text
 void setLabelVisible(boolean visible)
          Sets the label visible or invisible.
 void setNestedCaptionIndent(float newCaptionIndent)
           
 void setPDFCaptionFontSize(float fontSize)
           
 void setPDFCaptionIndent(int captionIndent)
           
 void setPDFComponentFontSize(float fontSize)
           
 void setPDFLabelFontSize(float fontSize)
           
 void setPDFLabelIndent(int labelIndent)
           
 void setPrintable(boolean printable)
           
 void setProperty(java.lang.Object fullKey, java.lang.Object relativeKey, java.lang.Boolean value)
           
 void setSerializableAsCDATA(boolean isCDATA)
          Sets if the content value is serializable as CDATA section.
 void setShowAsLabel(boolean show)
          Sets the codeSet name.
 void setTabIndex(int tabIndex)
          Sets the tab index if this type is visualized as a tab.
 void setTreeEntry(boolean hasTreeEntry)
          Sets if the current type has a tree entry.
 void setTreeEntry(boolean hasTreeEntry, java.lang.String applyOnDescendants)
          Sets if the current type has a tree entry.
 void setTreeIcon(java.lang.String gifName)
          Sets the tree icon for the treeEntry of the current type.
 void setUserModifiedSerializationCollapsed(boolean collapsed)
           
 void setUsingGroupingDelimiters(boolean useDelims)
          Set true if jaxfront should use grouping delimiters to display numbers!
 void setViewContextType(Type viewHolder)
           
 void setVisible(boolean visible)
           
 void setVisibleAtRuntime(boolean visible)
           
 boolean showAsLabel()
           
 java.lang.String toString()
           
 java.lang.String translateToCodeSetValue(Type type, java.lang.String key)
          Returns the codeset decription value if this type is using a codeset enumeration otherwise return the normal value.
 void update(StyleDefinition styleDefinition)
           
 void update(Type aType)
           
 void updateLayoutManager(LayoutInfo info)
           
 
Methods inherited from class com.jaxfront.core.xui.AbstractXUIElement
addPropertyChangeListener, getBooleanProperty, getBooleanProperty, getPropertyChangeSupport, getSerialListInfo, getTableInfo, getTableInfoPDF, getTabListInfo, hasProperties, initAction, initializeDefaultProperties, isListTableVisible, isUsingSerialList, isUsingTableList, isUsingTabList, removeProperty, setProperty
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

StyleDefinition

public StyleDefinition(XUIDefinition xuiDefinition,
                       Type xuiType)
Creates a StyleDefinition for the given XUIDefintion based on information provided by the xuiType

Parameters:
XUIDefinition - xuiDefinition
Type - xuiType

StyleDefinition

public StyleDefinition(XUIDefinition xuiDefinition,
                       StyleDefinition styleDefinition)
Creates a StyleDefinition for the given XUIDefintion based on an other StyleDefinition.

Parameters:
XUIDefinition - xuiDefinition
styleDefinition - style information to copy
Method Detail

update

public void update(StyleDefinition styleDefinition)

setCaptionOccurrence

public void setCaptionOccurrence(boolean hasCaption,
                                 java.lang.String applyOnDescendants)

update

public void update(Type aType)

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

isRepresentedAsTreeNode

public boolean isRepresentedAsTreeNode()

getBooleanVisualizer

public java.lang.String getBooleanVisualizer()

isUsingGroupingDelimiters

public boolean isUsingGroupingDelimiters()

setUsingGroupingDelimiters

public void setUsingGroupingDelimiters(boolean useDelims)
Set true if jaxfront should use grouping delimiters to display numbers!


getTimeFormat

public java.lang.String getTimeFormat()

getChildrenView

public java.lang.String getChildrenView()

getChoiceDefaultSelection

public java.lang.String getChoiceDefaultSelection()

getChoiceLabel

public java.lang.String getChoiceLabel()

getChoiceOrientation

public java.lang.String getChoiceOrientation()

getLeafMask

public java.lang.String getLeafMask()

getLeafMaskValidChars

public java.lang.String getLeafMaskValidChars()

getLeafMaskInvalidChars

public java.lang.String getLeafMaskInvalidChars()

getLeafMaskPlaceHolder

public java.lang.String getLeafMaskPlaceHolder()

getLeafMaskAllowInvalid

public boolean getLeafMaskAllowInvalid()

getLeafMaskCommitOnValidEnd

public boolean getLeafMaskCommitOnValidEnd()

getLeafMaskOverwriteMode

public boolean getLeafMaskOverwriteMode()

isChoiceOrientationHorizontal

public boolean isChoiceOrientationHorizontal()
Returns true if the choice orientation is set to HORIZONTAL, false otherwise


isEnumerationOrientationHorizontal

public boolean isEnumerationOrientationHorizontal()
Returns true if the enumeration orientation is set to HORIZONTAL, false otherwise


getChoiceType

public java.lang.String getChoiceType()

getCodeSetName

public java.lang.String getCodeSetName()

setCodeSetName

public void setCodeSetName(java.lang.String name)
Sets the codeSet name.


setShowAsLabel

public void setShowAsLabel(boolean show)
Sets the codeSet name.


showAsLabel

public boolean showAsLabel()

getCodeSetURL

public java.lang.String getCodeSetURL()
Returns the codeSet URL location.


getCodeSetXPointer

public java.lang.String getCodeSetXPointer()
Returns the codeSet URL location.


setCodeSetURL

public void setCodeSetURL(java.lang.String codesetURL)
Sets the codeSet URL location.

Parameters:
codesetURL - the URL location of the codeSet

getCodeSetValuesFromFile

public java.lang.String[] getCodeSetValuesFromFile(java.lang.String fileURL,
                                                   java.lang.String codeSetName)

setCodeSetValuesFromFile

public void setCodeSetValuesFromFile(java.lang.String fileURL,
                                     java.lang.String codeSetName,
                                     java.lang.String[] codes)
Sets the codeset values from a codeset file.

Parameters:
fileURL - the url that points to the codeset file
codeSetName - the name of the codeset
codes - an array that contains the values of the codeset

setCodeSetValuesFromClass

public void setCodeSetValuesFromClass(java.lang.String classURL,
                                      java.lang.String codeSetName,
                                      java.lang.String[] values)
Sets the codeset values from a java class.

Parameters:
classURL - the path of the codeset class
codeSetName - the name of the codeset
values - an array that contains the values of the codeset

getCodeSetValuesFromClass

public java.lang.String[] getCodeSetValuesFromClass(java.lang.String classURL,
                                                    java.lang.String codeSetName)

getCodeSetClass

public java.lang.String getCodeSetClass()
Returns the codeSet class name.


setCodeSetClass

public void setCodeSetClass(java.lang.String className)
Sets the codeSet class name.

Parameters:
className - the name of the codeSet class

getLabelText

public java.lang.String getLabelText()
Returns the visual label in the current language.


getLabelChoiceText

public java.lang.String getLabelChoiceText()

getLabelToolTip

public java.lang.String getLabelToolTip()

getTreeEntryToolTip

public java.lang.String getTreeEntryToolTip()

getCaptionTitleToolTip

public java.lang.String getCaptionTitleToolTip()

getPageTitle

public java.lang.String getPageTitle(Type pageType,
                                     int pageIndex)

hasTreeLabelFormulaExpression

public boolean hasTreeLabelFormulaExpression()

getTreeLabelFormulaResult

public java.lang.Object getTreeLabelFormulaResult()

getTreeLabelText

public java.lang.String getTreeLabelText()

getCaptionTitleLabel

public java.lang.String getCaptionTitleLabel()
Returns the caption label in the current language.


getDialogLabel

public java.lang.String getDialogLabel()
Returns:

getDeletionConfirmationMessageText

public java.lang.String getDeletionConfirmationMessageText()
Returns the message text that will be displayed in the confirmation message dialog to confirm deletion of the selected list item.

Returns:

getKeyContextDialogLabel

public java.lang.String getKeyContextDialogLabel()
Returns the key context dialog label in the current language.


hasKeyRefSelectionLineInfoFE

public boolean hasKeyRefSelectionLineInfoFE()
Returns if a selection lineInfo formula expression has been defined for a keyRef type.

Returns:
true, if a formula expression has been defined

hasKeyRefConditionFormulaExpression

public boolean hasKeyRefConditionFormulaExpression()
Returns if a selection lineInfo formula expression has been defined for a keyRef type.

Returns:
true, if a formula expression has been defined

getKeyRefSelectionLineInfoFE

public java.lang.String getKeyRefSelectionLineInfoFE()

getKeyRefConditionFE

public java.lang.String getKeyRefConditionFE()

getKeyContextLocation

public java.lang.String getKeyContextLocation()

hasKeyContextLocation

public boolean hasKeyContextLocation()
Returns if a context location path has been defined for a key.

Returns:
true if a context location path has been defined for a key

getLabelColumnWidth

public float getLabelColumnWidth()
Returns the label column width.


setLabelColumnWidth

public void setLabelColumnWidth(float width)

getComponentColumnWidth

public float getComponentColumnWidth()
Returns the component column width.


setComponentColumnWidth

public void setComponentColumnWidth(float width)

getLabelIndent

public float getLabelIndent()

setLabelIndent

public void setLabelIndent(float newLabelIndent)

getCaptionVisibility

public java.lang.String getCaptionVisibility()

isUserModifiedSerialization

public boolean isUserModifiedSerialization()

isUserModifiedSerializationCollapsed

public boolean isUserModifiedSerializationCollapsed()

setUserModifiedSerializationCollapsed

public void setUserModifiedSerializationCollapsed(boolean collapsed)

hasUserModfiedSerialization

public boolean hasUserModfiedSerialization()
Returns true if a xui style exists for global style caption usermodifiedserilization


isCaptionOccurrenceAlways

public boolean isCaptionOccurrenceAlways()

isCaptionOccurrenceNever

public boolean isCaptionOccurrenceNever()

isCaptionOccurrenceDependsOn

public boolean isCaptionOccurrenceDependsOn()

getCaptionOccurrenceDependsOnXPath

public java.lang.String getCaptionOccurrenceDependsOnXPath()

getCaptionTitleID

public java.lang.String getCaptionTitleID()
Returns the caption label id (for a help system).


getCaptionIndentValue

public float getCaptionIndentValue()

setCaptionIndentValue

public void setCaptionIndentValue(float newCaptionIndent)

setNestedCaptionIndent

public void setNestedCaptionIndent(float newCaptionIndent)

getCaptionType

public java.lang.String getCaptionType()

isCaptionTypeBorder

public boolean isCaptionTypeBorder()

isBorderCollapsed

public boolean isBorderCollapsed()

setBorderCollapsed

public void setBorderCollapsed(boolean collapsed)

isCaptionOccurrenceApplyOnAllDescendants

public boolean isCaptionOccurrenceApplyOnAllDescendants()

isCaptionOccurrenceApplyOnDirectDescendants

public boolean isCaptionOccurrenceApplyOnDirectDescendants()

getComponentSize

public float getComponentSize()
Returns the size (long/middle/short) for the component.


setComponentIndent

public void setComponentIndent(float newComponentIndent)

getComponentIndent

public float getComponentIndent()
Returns the indent for the component.


getLayoutManager

public LayoutInfo getLayoutManager()
Returns the layout info (default is null).


getLayoutInfos

public java.util.Vector getLayoutInfos()

updateLayoutManager

public void updateLayoutManager(LayoutInfo info)

getLayoutManager

public LayoutInfo getLayoutManager(java.lang.String id)
Returns the id of the tableLayout.


getMandatoryExpression

public java.lang.String getMandatoryExpression()

getMultiLineNumberComponent

public int getMultiLineNumberComponent()

getPlugInFormulaExpressions

public Type getPlugInFormulaExpressions()

getPlugInFormulaExpressionByID

public java.lang.String getPlugInFormulaExpressionByID(java.lang.String id)

getPluginBean

public PluginBean getPluginBean()
Returns a PluginBean if available.


getTableModelClass

public java.lang.String getTableModelClass()
Returns the table model class (default: com.jaxfront.core.ui.FlipOrientationTableModel)


getTablePosition

public java.lang.String getTablePosition()
Returns the table position (north [default], south, east, west).


getLabelIcon

public java.lang.String getLabelIcon()
Returns the name of the label icon.

Returns:
the name (or path) of the label icon

getLabelIconPosition

public java.lang.String getLabelIconPosition()
Returns the position of the label icon.

Returns:
left, right, top or bottom for the label icon position

getLeafLabelHRef

public java.lang.String getLeafLabelHRef()
Returns the href of the label.


isLabelIconPositionLeft

public boolean isLabelIconPositionLeft()
Returns true if the position of the label icon is set to left.

Returns:
true, if the position of the label icon is set to left, false otherwise

isLabelIconPositionRight

public boolean isLabelIconPositionRight()
Returns true if the position of the label icon is set to right.

Returns:
true, if the position of the label icon is set to right, false otherwise

isLabelIconPositionTop

public boolean isLabelIconPositionTop()
Returns true if the position of the label icon is set to top.

Returns:
true, if the position of the label icon is set to top, false otherwise

isLabelIconPositionBottom

public boolean isLabelIconPositionBottom()
Returns true if the position of the label icon is set to bottom.

Returns:
true, if the position of the label icon is set to bottom, false otherwise

getSplitterLayoutDefinition

public java.lang.String getSplitterLayoutDefinition()

hasTreeIconFormula

public boolean hasTreeIconFormula()

getTreeIcon

public java.lang.String getTreeIcon()

getTreePopUpClass

public java.lang.String getTreePopUpClass()

getHeaderImageURL

public java.lang.String getHeaderImageURL()

hasHeaderImageURL

public boolean hasHeaderImageURL()
Returns true if an url of a header image has been defined.


applyViewHolderOnDirectDescendants

public boolean applyViewHolderOnDirectDescendants()

getViewHolder

public java.lang.String getViewHolder()

hasHeader

public boolean hasHeader()
Returns true if this definition defines a header for a list.


getUserListActions

public java.util.List getUserListActions()

getHelpText

public java.lang.String getHelpText(java.lang.String language)

getHelpText

public java.lang.String getHelpText()

getLeafDefaultValue

public java.lang.String getLeafDefaultValue()

getLeafComponentHRef

public java.lang.String getLeafComponentHRef()

getLeafEnumerationDefaultSelection

public java.lang.String getLeafEnumerationDefaultSelection()

getLeafEnumerationType

public java.lang.String getLeafEnumerationType()

getLeafEnumerationOrientation

public java.lang.String getLeafEnumerationOrientation()

isUsingTab

public boolean isUsingTab()

getContextDialogBounds

public java.lang.String getContextDialogBounds()

getContextDialogLocation

public java.awt.Point getContextDialogLocation()

getContextDialogSize

public java.awt.Dimension getContextDialogSize()

getContextDialogButtonSequence

public java.lang.String getContextDialogButtonSequence()

getNestedCaptionIndent

public java.lang.Float getNestedCaptionIndent()

isCaptionIndentApplyOnDirectDescendants

public boolean isCaptionIndentApplyOnDirectDescendants()

isCaptionIndentApplyOnAllDescendants

public boolean isCaptionIndentApplyOnAllDescendants()

isCaptionIndentApplyOnLabel

public boolean isCaptionIndentApplyOnLabel()

isCaptionIndentApplyOnComponent

public boolean isCaptionIndentApplyOnComponent()

isCaptionIndentApplyOnBoth

public boolean isCaptionIndentApplyOnBoth()

isComponentMulti

public boolean isComponentMulti()
Returns true if this component uses more than one line to display.


isBooleanViewRadioButton

public boolean isBooleanViewRadioButton()

isBooleanViewRadioButtonUnselected

public boolean isBooleanViewRadioButtonUnselected()

isBooleanViewCheckBox

public boolean isBooleanViewCheckBox()

isAllowingCopyPaste

public boolean isAllowingCopyPaste()

isEnumeration

public boolean isEnumeration()
Returns true if this definition defines a choice (choice list,codeset or schema enumeration).


isEnumerationAllowingInvalidCodes

public boolean isEnumerationAllowingInvalidCodes()
Returns true if an enumeration allows to show invalid codes of a codeset.


isEnumerationShowErrorForInvalidCodes

public boolean isEnumerationShowErrorForInvalidCodes()
Returns true if an error will be thrown when selecting an invalid code set value


isDefaultLayout

public boolean isDefaultLayout()
Returns true if this definition uses no special layout.


isDialogMode

public boolean isDialogMode()
Returns true if this definition defines a dialog mode to edit childs within a list.


isKeyRefShowingNewButton

public boolean isKeyRefShowingNewButton()
Returns true if a keyRef component shows its "new" button.


isKeyRefShowingDetailsButton

public boolean isKeyRefShowingDetailsButton()
Returns true if a keyRef component shows its "details" button.


isKeyRefShowingBackLinkButton

public boolean isKeyRefShowingBackLinkButton()
Returns true if a keyRef component shows its "backLink" button.


isLabelMulti

public boolean isLabelMulti()
Returns true if this component uses more than one line to display.


isLabelUnderlined

public boolean isLabelUnderlined()
Returns true if this component uses more than one line to display.


isParentViewHolder

public boolean isParentViewHolder()
Returns true if this component is displayed within its parent view and not within its own context.

Returns:
true, if this component is displayed within its parent view and not within its own context, false otherwise

isEnumerationAsRadioButton

public boolean isEnumerationAsRadioButton()
Returns true if this is an enumeration component displayed as a radioButton group.


isEnumerationAsListBox

public boolean isEnumerationAsListBox()
Returns true if this is an enumeration component displayed as a list box.


isEnumerationAsComboBox

public boolean isEnumerationAsComboBox()
Returns true if this is an enumeration component displayed as a radioButton group.


isChoiceAsRadioButton

public boolean isChoiceAsRadioButton()
Returns true if this is a choice component displayed as a radioButton group.


isChoiceAsComboBox

public boolean isChoiceAsComboBox()
Returns true if this is a choice component displayed as a combobox.


isReadOnly

public boolean isReadOnly()
Returns true if this component is readOnly (disabled).


isTreeEntryShowChildrenAsOptional

public boolean isTreeEntryShowChildrenAsOptional()
Returns true if the tree nodes of the children of the current type should be visualized with a checkbox that allows to show/hide the corresponding component on the workspace.


isTreeEntryShowAsOptional

public boolean isTreeEntryShowAsOptional()
Returns true if the tree node of the current type should be visualized with a checkbox that allows to show/hide the corresponding component on the workspace.


isEditable

public boolean isEditable()
Returns true if this component is editable which means that the editor component will be displayed as enabled but without the functionality to enter any values.


isUnlocked

public boolean isUnlocked()
Returns true if this component or an ancestor of myself is marked as an unlocked field. This maybe the case if the hole document is not editable & the lock() method was called with a number of 'not locked' components.


setEditable

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

Parameters:
editable - true if the component is editable, false otherwise

markAsUnlockedField

public void markAsUnlockedField()
Mark field as temporarly editable (if field is an unlocked field).


isRepresentedAsHeader

public boolean isRepresentedAsHeader()
Returns true if this component is displayed with a header separator.


getPrimitiveBooleanProperty

public boolean getPrimitiveBooleanProperty(java.lang.String fullPath,
                                           java.lang.String relativePath)

isApplicationRequired

public boolean isApplicationRequired()
Returns true if this component should be drawn as required for the application (not schema required).

Returns:
true if is required

setApplicationRequired

public void setApplicationRequired(boolean applicationRequired)
Sets the editor component required within the application (not schema-required).

Parameters:
applicationRequired - true, if the editor component should be application required

isRepresentedAsTab

public boolean isRepresentedAsTab()
Returns true if this component is displayed within a tab on a tabbed pane.


isSelfViewHolder

public boolean isSelfViewHolder()
Returns true if this component is displayed in its own context, not within its parent view.

Returns:
true, if this component is displayed in its own context, false otherwise.

isSerialView

public boolean isSerialView()
Returns true if this component is displayed as a serial view.


isSelectionOnly

public boolean isSelectionOnly()
Same like Tableinfo but take count of isEditable and isReadOnly


isHierarchyEnabled

public boolean isHierarchyEnabled(Type startType)

isTabHolder

public boolean isTabHolder()
Returns true if this component displays its composites as separate tabs.


isTableLayout

public boolean isTableLayout()
Returns true if this component uses the table layout.


isPagingLayout

public boolean isPagingLayout()
Returns true if this component uses the paging layout.


isInTableLayoutContext

public boolean isInTableLayoutContext()
Returns true if this component uses the table layout.


hasTableLayoutParent

public boolean hasTableLayoutParent()

isTreeEntryAlways

public boolean isTreeEntryAlways()
Returns true if this component is always displayed in the tree.


getTreeEntryMode

public java.lang.String getTreeEntryMode()
Returns the selected treeEntry mode as String.


isTreeEntryDependingOn

public boolean isTreeEntryDependingOn()
Returns true if this component's node is displayed depending on a other node's treeEntry.


getTreeEntryDependsOnXPath

public java.lang.String getTreeEntryDependsOnXPath()
Returns the xpath of the node on which this treeEntry depends.


isTreeEntryNever

public boolean isTreeEntryNever()
Returns true if this component is never displayed in the tree.


isTreeEntryApplyOnAllDescendants

public boolean isTreeEntryApplyOnAllDescendants()
Returns true if the current treeEntry settings will be applied to all its childs.

Returns:
boolean

isTreeEntryApplyOnDirectDescendants

public boolean isTreeEntryApplyOnDirectDescendants()
Returns true if the current treeEntry settings will be applied only to its direct childs.

Returns:
boolean

isTreeEntryFocusable

public boolean isTreeEntryFocusable()
Returns whether the tree entry can gain the focus by clicking the function keys F7 or F8.

Returns:
boolean true if the tree entry of the current type is able to gain the focus

isTreeEntryAllowSearch

public boolean isTreeEntryAllowSearch()
Returns whether the tree entry can show a search dialog or not.

Returns:
boolean true

hasCaption

public boolean hasCaption()
Returns true if this component uses a caption.


getPDFCaptionIndent

public int getPDFCaptionIndent()

getPDFLabelIndent

public int getPDFLabelIndent()

setPDFCaptionIndent

public void setPDFCaptionIndent(int captionIndent)

setPDFLabelIndent

public void setPDFLabelIndent(int labelIndent)

getPDFCaptionFontSize

public float getPDFCaptionFontSize()

setPDFCaptionFontSize

public void setPDFCaptionFontSize(float fontSize)

getPDFLabelFontSize

public float getPDFLabelFontSize()

setPDFLabelFontSize

public void setPDFLabelFontSize(float fontSize)

getPDFComponentFontSize

public float getPDFComponentFontSize()

setPDFComponentFontSize

public void setPDFComponentFontSize(float fontSize)

isUsingPlugIn

public boolean isUsingPlugIn()
Returns true if this component is represented through a plugin bean.


setVisible

public void setVisible(boolean visible)

setVisibleAtRuntime

public void setVisibleAtRuntime(boolean visible)

isVisibleAtRuntime

public boolean isVisibleAtRuntime()

setEnabled

public void setEnabled(boolean enabled)
Disables this component.


isEnabled

public boolean isEnabled()
Disables this component.


isVisibleNoHash

public byte isVisibleNoHash()

isReadOnlyNoHash

public byte isReadOnlyNoHash()

isVisible

public boolean isVisible()
Returns true if the current type is visible.


setIsVisibleInOptionalTreeMode

public void setIsVisibleInOptionalTreeMode(boolean isVisible)

isVisibleInOptionalTreeMode

public boolean isVisibleInOptionalTreeMode()

isLabelVisible

public boolean isLabelVisible()
Returns true if the label of the current type is visible.


setLabelVisible

public void setLabelVisible(boolean visible)
Sets the label visible or invisible.

Parameters:
visible - true if the label should be visible

isEditorComponentVisible

public boolean isEditorComponentVisible()
Returns true if the editor component of the current type is visible.


isSerializableAsCDATA

public boolean isSerializableAsCDATA()
Returns true if the content value is serializable as CDATA section.


getActAs

public java.lang.String getActAs()
Returns the user overwritten datatype, this change has only an effect if the jaxfront type will become visible within a gui.


setActAs

public void setActAs(java.lang.String actAs)
Overwrites the datatype specified in the schema.


setSerializableAsCDATA

public void setSerializableAsCDATA(boolean isCDATA)
Sets if the content value is serializable as CDATA section.

Parameters:
isCDATA - true if the content should be serialized as CDATA

setEnumeration

public void setEnumeration(java.lang.String[] selection)

getEnumerationEntries

public ListEntry[] getEnumerationEntries()

setEnumerationEntries

public void setEnumerationEntries(ListEntry[] listEntries)

translateToCodeSetValue

public java.lang.String translateToCodeSetValue(Type type,
                                                java.lang.String key)
Returns the codeset decription value if this type is using a codeset enumeration otherwise return the normal value.


getEnumeration

public java.lang.String[] getEnumeration()

setTreeEntry

public void setTreeEntry(boolean hasTreeEntry)
Sets if the current type has a tree entry.

Parameters:
hasTreeEntry - true if the current type has a tree entry

setTreeEntry

public void setTreeEntry(boolean hasTreeEntry,
                         java.lang.String applyOnDescendants)
Sets if the current type has a tree entry.

Parameters:
hasTreeEntry - true if the current type has a tree entry

setTreeIcon

public void setTreeIcon(java.lang.String gifName)
Sets the tree icon for the treeEntry of the current type.

Parameters:
gifName - a file name (gif)

setTabIndex

public void setTabIndex(int tabIndex)
Sets the tab index if this type is visualized as a tab.

Parameters:
tabIndex - the index of the tab

getTabIndex

public java.lang.Integer getTabIndex()
Sets the tab index if this type is visualized as a tab.

Returns:
the tab index

isSingleChoiceAndSerialize

public boolean isSingleChoiceAndSerialize()
Returns true if the current choice does not allow an "empty selection" after a selection has been made. The selected item will be serialized anyway.


isUsingCodeSet

public boolean isUsingCodeSet()
Returns true if using a codeSet definition.


setBackgroundColor

public void setBackgroundColor(java.awt.Color color)
Sets the background color for the current type.

Parameters:
color - a new background color

getBackgroundColor

public java.awt.Color getBackgroundColor()
Returns the background color for the current type.

Returns:
the background color

setForegroundColor

public void setForegroundColor(java.awt.Color color)
Sets the foreground color for the current type.

Parameters:
color - a new foreground color

getForegroundColor

public java.awt.Color getForegroundColor()
Returns the foreground color for the current type.

Returns:
the foreground color

setLabelColor

public void setLabelColor(java.awt.Color color)
Sets the label color for the current type.

Parameters:
color - a new label color

setLabelText

public void setLabelText(java.lang.String text)
Sets the label text

Parameters:
text -

getLabelColor

public java.awt.Color getLabelColor()
Returns the label color for the current type.

Returns:
the label color

setHint

public void setHint(java.lang.String text,
                    boolean isFormula,
                    java.awt.Color color,
                    boolean isBold)

removeHint

public void removeHint()

hasHint

public boolean hasHint()

getHintText

public java.lang.String getHintText()

isHintTextFormula

public boolean isHintTextFormula()

isHintTextBold

public boolean isHintTextBold()

getHintColor

public java.awt.Color getHintColor()

getEnumerationSortOrder

public java.lang.String getEnumerationSortOrder()

getDisplayValue

public java.lang.String getDisplayValue()
Returns a specified text that acts as a display value for the current node. This may be used to define a user specific node value only for display purposes. If no definition has been made in a xui then the default node value will be returned by using the method toTableString().

Returns:
a specified text that acts as a display value for the current node

hasDisplayValue

public boolean hasDisplayValue()

isXLinkCodeset

public boolean isXLinkCodeset()

serializeAsXLink

public boolean serializeAsXLink()

reinitializeCodeSetValues

public void reinitializeCodeSetValues()

isPanelMode

public boolean isPanelMode()
Returns true if this definition defines a dialog mode to edit childs within a list.


isMarkedAsError

public boolean isMarkedAsError()
Returns true if this type is marked as an error.


markAsError

public void markAsError(boolean markAsError)
Marks this type as an error (e.q. based on a occured rule definition).


getValidationErrorMessage

public java.lang.String getValidationErrorMessage()
Returns the validation error message as defined in the xui.

Returns:
the validation error message

isValidationErrorNeedingUserAcceptance

public boolean isValidationErrorNeedingUserAcceptance()
Returns true if the validation error message requires any user acceptance.

Returns:
true if the validation error message requires any user acceptance, false otherwise

getValidationErrorClassification

public java.lang.String getValidationErrorClassification()
Returns the classification of the validation error message.

Returns:
the classification of the validation error message

getPrintable

public java.lang.String getPrintable()
Returns wether this type should be printed out or not.

Returns:
null, "always" or "never"

setPrintable

public void setPrintable(boolean printable)

printChoiceAsHeader

public java.lang.Boolean printChoiceAsHeader()
Returns true if this type is a choice and if it should be printed out as header. If null is returned, the global defined pdf xui setting will be applied.

Returns:
true if this choice should be printed out as header, false otherwise

getListPrintMode

public java.lang.String getListPrintMode()
Returns the print mode for this list type.

Returns:
serial, table or tableAndSerial

isListPrintModeSerial

public boolean isListPrintModeSerial()
Returns true if the list print mode is serial.

Returns:
true if the list print mode is serial

isListPrintModeTable

public boolean isListPrintModeTable()
Returns true if the list print mode is table.

Returns:
true if the list print mode is table

isListPrintModeTableAndSerial

public boolean isListPrintModeTableAndSerial()
Returns true if the list print mode is table and serial.

Returns:
true if the list print mode is table and serial

getViewContextType

public Type getViewContextType()

setViewContextType

public void setViewContextType(Type viewHolder)

getSerializable

public boolean getSerializable()
Returns true if the value of the correspondent component should be serialized into an xml instance.


getSerializableDefault

public java.lang.Boolean getSerializableDefault()
Returns true if the value of the correspondent component should be serialized into an xml instance. null if nothing is defined.


getNLS

public java.lang.String getNLS(java.lang.String context,
                               java.lang.String subId,
                               java.lang.String classification)

getNLS

public java.lang.String getNLS(java.lang.String defaultNLS,
                               java.lang.String context,
                               java.lang.String subId,
                               java.lang.String classification)

setProperty

public void setProperty(java.lang.Object fullKey,
                        java.lang.Object relativeKey,
                        java.lang.Boolean value)

getListInfo

public ListInfo getListInfo()

checkEnabling

public static ButtonEnabling checkEnabling(Type forType)

release

public void release()
Overrides:
release in class AbstractXUIElement

getTotalNumberOfPages

public int getTotalNumberOfPages()