|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.jaxfront.core.xui.AbstractXUIElement
com.jaxfront.core.xui.StyleDefinition
public class StyleDefinition
The StyleDefinition encapsulate all graphical layout definitions of a XUI component. For a detailed description look at the xui.xsd Schema [/XUI/component/style].
| 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 |
| 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)
|