| Chapter 4 GUIDesigner | ||
|---|---|---|
 | 4.7 Reference A: Guidesigner Model |  |
| Chapter 4 GUIDesigner | ||
|---|---|---|
| | 4.7 Reference A: Guidesigner Model | |
The following graphic is an overview about the underlying object model of the Guidesigner:
In addition there is a separate object model about validator mapping:
Last but not least there is a separate object model for Businessdata attachment:
The following table holds links to further description of the object in the model.
| Type | References to detailed Description |
XMA Component | XMA Component(XMA Component) |
XMA Page | Embedded Page(Embedded Page) |
Notebook Page(Notebook Page) | |
XMA DialogPage(XMA Dialog Page) | |
| AppShell(AppShell) | |
XMA Widget | CheckButton(Check Button) |
DatePicker(DatePicker) | |
Hidden Widget(Hidden Widget) | |
Page Composite(Page Composite) | |
Push Button(Push Button) | |
Radio Button(Radio Button) | |
Simple Combo(Simple Combo) | |
XMA Combo(XMA Combo) | |
XMA Composite(XMA Composite) | |
XMA Container(XMA Container) | |
XMA Grid(XMA Grid) | |
XMA Group(XMA Group) | |
XMA Label(XMA Label) | |
XMA List(XMA List) | |
XMA Sashform(XMA Sashform) | |
XMA Separator(XMA Separator) | |
XMA Scrolled Composite(XMA Scrolled Composite) | |
XMA Tabfolder(XMA Tabfolder) | |
XMA Table(XMA Table) | |
XMA Text(XMA Text) | |
XMA Tree(XMA Tree) | |
XMA Table | XMA Tablecolumn(XMA Tablecolumn) |
XMA CompProperty | XMA CompProperty(XMA CompProperty) |
Table 4.9. References
In the context of XMA, a component is a jar file consisting of java runtime ressources of the presentation component's client half. If you select a component you may see the information shown in the following table with the Property View.
The column editable provide information whether the property is editable in the Guidesigner. Learn more about correspondent SWT concepts in Standard Widget Toolkit
| Property | Type | Description | Editable |
| ClassName | String | The class name of this component. In the component wizard the component name is set as default. | X |
| HelpUri | XMAUri (String) | The Uri to the help content of this component which may be absolute or relative to the webapp. default relative uri to webapp: help/<packagename>/<classname>.html | X |
| Language | String | The language (Java ResourceBundle Extension), whereby the Resource Items and message text's will be specified in the GUIDesigner. | X |
| Package Name | String | The 'home package' of all class resources of this component. In the component wizard at.spardat is set as default package prefix. | X |
| YN Stateless | boolean | True, if the underlying component is stateless. If this attribute is true, all ynStateless attributes of the pages has to be true. | X |
Table 4.10. XMA Component Properties
Learn more about components in Chapter Implementing a Component(Programming a Component).
A Component is only selectable in the Outline View and uses the Property View to edit its Properties. In the PreView the component has no correspondence. If a component is selected in the OutlineView the first XMA Page is shown.
A Component may have the following Page Types as Childs:
|
Table 4.12. Children |
Table 4.11. XMA Component Children
Learn more about how to create a Component in Chapter Create a new Component(Create a new Component).
An Embedded Page represents a UI component, that could be reused from other pages. An Embedded Page is mapped to a SWT Composite. If you select an Embedded Page you may see the information shown in the following table with the Property View.
The column editable provide information whether the property is editable in the Guidesigner. At this time there exists no correspondent SWT concepts in Standard Widget Toolkit
| Property | Type | Description | Editable |
| ClassName | String | Name of the Class of the GUI Page. | X |
| Height | int | Height of the Page in pixel. This height is only used to design the page. At the time the page is embedded, the containers height is used. | X |
| HelpUri | XMAUri (String) | The relative Uri to the help content of this page. default: help/<packagename>/<classname> | X |
| Instance Name | String | The instance name of the of the page in the context of an component. | X |
| Width | int | Width of the Page in pixel. This width is only used to design the page. At the time the page is embedded, the containers width is used. | X |
| YN Export | boolean | True, if the embedded page should be exported by the component. A XMA component may have only one exported embedded page. | X |
| YN Model Lazy Generated | boolean | If true, the models of the underlying widgets are build at construction time. | X |
| YN Stateless | boolean | True, if the underlying page is stateless. | X |
Table 4.13. Embedded Page Properties
To use an Embedded Pages you have to contain the page in a XMA Container(XMA Container). Then the height and width of the Embedded Page is decided through the size of the container. Learn more about Embedded Pages in Chapter Embedded Page(Embedded Page) respective in chapter Embedded Component(Embedded Component).
An Embedded Page is only workable in the Outline View and uses the Property View to edit its Properties. In the PreView the Embedded Page has no correspondence. If a Embedded Page is selected in the OutlineView the content of it's Page Composite is shown in the PreView.
An Embedded Page may have the following Page Types as Childs:
Learn more about how to create an Page in ChapterCreate a new Page(Create a new Page).
A Notebook Page contains all Information that are logically assigned to one Tab Item of the Tab Control of the StyleGuide. A Notebook Page is always embedded in aXMA TabFolder(XMA Tabfolder).
A Notebook Page is mapped with SWT TabItem Widget and a SWT Composite. If you select an Notebook Page you may see the information shown in the following table with the Property View.
The column editable provide information whether the property is editable in the Guidesigner. Learn more about correspondent SWT concepts in Standard Widget Toolkit
| Property | Type | Description | Editable |
| ClassName | String | Name of the Class of the GUI Page. | X |
| Default Button | Selection List | Marks the Push Button that will be the Default Button of this Page. | X |
| HelpUri | XMAUri (String) | The relative Uri to the help content of this page. default: help/<packagename>/<classname> | X |
| ImageUri | Dialog | Relative Uri of the Image shown on the folder of the Notebook Page. As workaround push the 'Cancel' button in the Uri Dialog to remove an ImageUri. | X |
| Instance Name | String | The instance name of the of the page in the context of an component. | X |
| Page Label | String | The name of the Notebook Page. This Property was loaded/saved in the particular Resource bundle dependent of the actual Language of the Component. | X |
| Tooltip | String | The Tooltiptext of the Notebook Page. This Property was loaded/saved in the particular Resource bundle dependent of the actual Language of the Component. | X |
| YN Dynamic | boolean | If false, the Notebook Page will be added automatically to the TabFolder, else the page has to be added manually (e.g. in th enter() method of the outer page). | X |
| YN Model Lazy Generated | boolean | If true, the models of the underlying widgets are build at construction time. Caution: Embedding pages or components on lazy generated notebook pages is not supported currently. | X |
| YN Stateless | boolean | True, if the underlying page is stateless. | X |
Table 4.15. Notebook Page Properties
Learn more about Pages in Chapter Page Types(Page Types).
A Notebook Page is only workable in the Outline View and uses the Property View to edit its Properties. In the PreView the Notebook Page has no correspondence. If a Notebook Page is selected in the OutlineView the content of it's Page Composite is selected and shown in the PreView.
An Embedded Page may have the following Page Types as Childs:
Learn more about how to create an Page in Chapter Create a new Page(Create a new Page).
A DialogPage is mapped to a SWT Shell and represents the diolog concepts in the StyleGuide. Every Dialog Page has a Statusbar where messages to the User are presented. If you select a Dialog Page you may see the information shown in the following table with the Property View.
The column editable provide information whether the property is editable in the Guidesigner. Learn more about correspondent SWT concepts in Standard Widget Toolkit
| Property | Type | Description | Editable |
| ClassName | String | Name of the Class of the GUI Page. | X |
| Height | int | Height of the Dialog Page in pixel. If Height and Width are both 0, the size of the Dialog Page is determined by the size of its content, by using SWTs pack() method. If the Dialog Page is embedded, Height is used only at design time, at runtime the containers height is used. | X |
| HelpUri | XMAUri (String) | The Uri to the help content of this component which may be absolute or relative to the webapp. default relative uri to webapp: help/<packagename>/<classname>.html | X |
| Horizontal Start Position | int | X-Coordinate of the left upper position of the Dialog relative to the parent window or the display, when no parent window is available. Default: -1 means center of dialog is in the middle of screen used to set: org.eclipse.swt.widgets.Control.location | X |
| ImageUri | Dialog | The relative Uri to the image label of the title bar. As workaround push the 'Cancel' button in the Uri Dialog to remove an ImageUri. used to fill: org.eclipse.swt.widgets.Shell.Image | X |
| Initial Focus Widget | SelectionList | Used to set which widget of the dialogs page composite has the focus on dialog start. maps to: of org.eclipse.swt.widgets.Control.setFocus | X |
| Instance Name | String | The instance name of the of the page in the context of an component. | X |
| Label | String | Label of the Dialog. This property ise loaded/saved in the particular Resource bundle dependent of the actual language of the XMA Component. maps to: org.eclipse.swt.widgets.Shell.Text | X |
| Minimal Height | int | Minimal height of the Dialog in pixel. Resize events after reaching this value are ignored. | X |
| Minimal Width | int | Minimal width of the Dialog in pixel. Resize events after reaching this value are ignored. | X |
| Modality | SelectionList | The modality property of an dialog. style of org.eclipse.swt.widgets.Shell Possible Values:
| X |
| Vertical Start Position | int | Y-Coordinate of the left upper position of the Dialog relative to the parent window or the display, when no parent window available. Default: -1 means center of dialog is in the middle of screen used to set: org.eclipse.swt.widgets.Control.location | X |
| Width | int | Width of the Page in pixel. If Height and Width are both 0, the size of the Dialog Page is determined by the size of its content, by using SWTs pack() method. If the Dialog Page is embedded, Width is used only at design time, at runtime the containers width is used. | X |
| YN Close | boolean | True, if the Close window button is to be shown Style of org.eclipse.swt.widgets.Shell | X |
| YN Max TitleBar Button | boolean | True, if the maximize window button is to be shown Style of org.eclipse.swt.widgets.Shell | X |
| YN Min TitleBar Button | boolean | True, if the minimize window button is to be shown Style of org.eclipse.swt.widgets.Shell | X |
| YN Model Lazy Generated | boolean | If true, the models of the underlying widgets are build at construction time. | X |
| YN Resizeable Dialog | boolean | True, if the Dialog is resizeable Style of org.eclipse.swt.widgets.Shell | X |
| YN Stateless | boolean | True, if the underlying page is stateless. | X |
Table 4.17. XMA Dialog Page Properties
Learn more about Pages in Chapter Implementing a Client Page(Programming a Client Side Page)and other Chapters.
A Dialog Page is only workable in the Outline View and uses the Property View to edit its Properties. In the PreView the PageComposite of the Dialog Page and the StatusBar is shown.
A Dialog Page may have the following Page Types as Childs:
Learn more about how to create an Page in ChapterCreate a new Page(Create a new Page).
An AppShell represents a window with a menu, a header area showing context information and a client area where different components are embedded dynamically depending on the menu item currently selected. For information about how to use AppShell please read Application Shell.
AppShell is derived from XMA Dialog Page (XMA Dialog Page) and inherits all its properties. The
property specific for AppShell is Menu Type, which defines
how the menu is implemented.
| Property | Type | Description | Editable |
| ClassName | String | Name of the Class of the GUI Page. | X |
| Height | int | Height of the Page in pixel. This height is only used to design the page. At the time the page is embedded, the containers height is used. | X |
| HelpUri | XMAUri (String) | The Uri to the help content of this component which may be absolute or relative to the webapp. default relative uri to webapp: help/<packagename>/<classname>.html | X |
| Horizontal Start Position | int | X-Coordinate of the left upper position of the Dialog relative to the parent window or the display, when no parent window is available. Default: -1 means center of dialog is in the middle of screen used to set: org.eclipse.swt.widgets.Control.location | X |
| ImageUri | Dialog | The relative Uri to the image label of the title bar. As workaround push the 'Cancel' button in the Uri Dialog to remove an ImageUri. used to fill: org.eclipse.swt.widgets.Shell.Image | X |
| Initial Focus Widget | SelectionList | Used to set which widget of the dialogs page composite has the focus on dialog start. maps to: of org.eclipse.swt.widgets.Control.setFocus | X |
| Instance Name | String | The instance name of the of the page in the context of an component. | X |
| Label | String | Label of the Dialog. This property ise loaded/saved in the particular Resource bundle dependent of the actual language of the XMA Component. maps to: org.eclipse.swt.widgets.Shell.Text | X |
| Menu Type | SelectionList | Defines which kind of menu representation should be
used. The possibilities are:
| X |
| Minimal Height | int | Minimal height of the Dialog in pixel. Resize events after reaching this value are ignored. | X |
| Minimal Width | int | Minimal width of the Dialog in pixel. Resize events after reaching this value are ignored. | X |
| Modality | SelectionList | The modality property of an dialog. style of org.eclipse.swt.widgets.Shell Possible Values:
| X |
| Vertical Start Position | int | Y-Coordinate of the left upper position of the Dialog relative to the parent window or the display, when no parent window available. Default: -1 means center of dialog is in the middle of screen used to set: org.eclipse.swt.widgets.Control.location | X |
| Width | int | Width of the Page in pixel. This width is only used to design the page. At the time the page is embedded, the containers width is used. | X |
| YN Close | boolean | True, if the Close window button is to be shown Style of org.eclipse.swt.widgets.Shell | X |
| YN Max TitleBar Button | boolean | True, if the maximize window button is to be shown Style of org.eclipse.swt.widgets.Shell | X |
| YN Min TitleBar Button | boolean | True, if the minimize window button is to be shown Style of org.eclipse.swt.widgets.Shell | X |
| YN Model Lazy Generated | boolean | If true, the models of the underlying widgets are build at construction time. | X |
| YN Resizeable Dialog | boolean | True, if the Dialog is resizeable Style of org.eclipse.swt.widgets.Shell | X |
| YN Stateless | boolean | True, if the underlying page is stateless. | X |
Table 4.19. AppShell Properties
A Check Button is mapped to a SWT Button Control with Style CHECK and represents a Check box in the StyleGuide.
If you select a Check Button you may see the information shown in the following table with the Property View.
The column editable provide information whether the property is editable in the Guidesigner. Learn more about correspondent SWT concepts in Standard Widget Toolkit
| Property | Type | Description | Editable |
| Align Label | SelectionList | The alignment property of the check button widget. style of org.eclipse.swt.widgets.Button Values: LEFT CENTER RIGHT | X |
| Business Data | String | Shows the Businessdata Attribute to which the actual widget is mapped. | |
| FormData | Dialog | Shows the FormData settings of the actual widget. If you select this property theFormData Dialog(FormData Dialog)starts. | X |
| ImageUri | Dialog | The relative Uri to the image label. As workaround push the 'Cancel' button in the Uri Dialog to remove an ImageUri. maps to: org.eclipse.swt.widgets.Button.Image | X |
| Instance Name | String | Name of the instance of the model of this widget. | X |
| Label | String | The text of the Label. This Property was loaded/saved in the particular Resource bundle dependent of the actual Language of the Component. | X |
| Tooltip | String | Tooltip text in the components language. maps to: org.eclipse.swt.widgets.Control.TooltipText | X |
| YN Border | boolean | True, if the Widget has a border. Style of org.eclipse.swt.widgets.Control Default: false | X |
| YN Editable | boolean | If false, the control couldn't be edited. | X |
| YN Enabled | boolean | True, if the widget is enabled (can grab focus). Maps to: org.eclipse.swt.widgets.Control.Enabled | X |
| YN Selection Event | boolean | If true, a selection event method is generated for a checkbutton. | X |
| YN in Tab Sequence | boolean | False, if the widget doesn't attend in the tab sequence of the parent composite. Default: true | X |
| YN Visible | boolean | True, if the Widget is visible. Maps to: org.eclipse.swt.widgets.Control.Visible | X |
Table 4.20. Check Button Properties
A Check Button is workable in the Outline View and PreView and uses the Property View to edit its Properties.
Learn more about how to create a Widget in ChapterCreate a new Widget(Create a new Widget).
A DatePicker is a custom SWT Control designed for XMA to support date picking functionality. A DatePicker holds Date values. Formatting and validation occurs on basis of the DateValidator. A DatePicker consists of an SWT text widget (which is attached to a ISimpleWM ) and a SWT button of the style SWT.ARROW_DOWN. On button click a modal DatePicker dialog is started. By selecting a date the DatePicker dialog is closed and the selected date is written to the text widget, respectively to the attached ISimpleWM. Alternatively the DatePicker text widget itself can be edited, and the DatePicker dialog can also be started by pressing the arrow up and arrow down keys. The DatePicker and its dialog can be fully navigated by only using keys (tab, enter). If you select a DatePicker you may see the information shown in the following table with the Property View.
The column editable provide information whether the property is editable in the Guidesigner. At this time there exists no correspondent SWT concepts in Standard Widget Toolkit
| Property | Type | Description | Editable |
| Alignment | SelectionList | The alignment property of the Text widget. Default: for XMAText with BCDValidators assigned at the first time RIGHT else LEFT style of org.eclipse.swt.widgets.Text Values: LEFT CENTER RIGHT | X |
| Business Data | String | Shows the Businessdata Attribute to which the actual widget is mapped. | |
| Business Data Validator | String | Shows the Validator of the the Businessdata Attribute. Properties of this Validator may be cross-faded through the properties of the Validator Property (see below). The Infos are used to generate a Validator for the actual widget. Learn more about Validators in Chapter Formatter.(Formatters/Validators) | |
| FormData | Dialog | Shows the FormData settings of the actual widget. If you select this property theFormData Dialog(FormData Dialog)starts. | X |
| Instance Name | String | Name of the instance of the model of this widget. The instance name of the widget is the same name with a 'L' postfix for labels and a 'W' postfix for all other widgets. | X |
| Label | SelectionList | Contains the XMA Label widget, with which the actual widget is linked. | X |
| Tooltip | String | Tooltip text in the components language. maps to: org.eclipse.swt.widgets.Control.TooltipText | X |
| Validator | Dialog | Shows Infos about the Validator of this widget. This Infos cross-fade the properties of the BusinessData Validator Property (see above). The Infos are used to generate a Validator for the actual widget. Only a DateValidator ( ADateFmt ) can be chosen. Learn more about Validators in ChapterFormatter.(Formatters/Validators) | X |
| YN Border | boolean | True, if the Widget has a border. Style of org.eclipse.swt.widgets.Control Default: true | X |
| YN Editable | boolean | If false, the control couldn't be edited. | X |
| YN Enabled | boolean | True, if the widget is enabled (can grab focus). Maps to: org.eclipse.swt.widgets.Control.Enabled | X |
| YN in Tab Sequence | boolean | False, if the widget doesn't attend in the tab sequence of the parent composite. Default: true | X |
| YN Visible | boolean | True, if the Widget is visible. Maps to: org.eclipse.swt.widgets.Control.Visible | X |
| Weekend Style | SelectionList | Style which is used to change the color of saturday and Sunday at the DatePicker Dialog. Values: NONE_RED no day is marked red WEEKEND_RED Saturday and Sunday are marked red SUNDAY_RED only Sunday is marked red | X |
Table 4.21. DatePicker Properties
Learn more about Validators in ChapterFormatter.(Formatters/Validators)
A date picker is workable in the Outline View and PreView and uses the Property View to edit its Properties.
Learn more about how to create a Widget in ChapterCreate a new Widget(Create a new Widget).
A Hidden Widget may not be shown to the user. It is used to transport data between server and client to support additional gray logic.
If you select a Hidden Widget you may see the information shown in the following table with the Property View.
The column editable provide information whether the property is editable in the Guidesigner. Learn more about correspondent SWT concepts in Standard Widget Toolkit
| Property | Type | Description | Editable |
| Business Data | String | Shows the Businessdata Attribute to which the actual widget is mapped. | |
| Business Data Validator | String | Shows the Validator of the the Businessdata Attribute. Properties of this Validator may be cross-faded thru the properties of the Validator Property (see below). The Infos are used to generate a Validator for the actual widget. Learn more about Validators in ChapterFormatter.(Formatters/Validators) | |
| Instance Name | String | Name of the instance of the model of this widget. | X |
| Validator | Dialog | Shows Infos about the Validator of this widget. This Infos cross-fade the properties of the BusinessData Validator Property (see above). The Infos are used to generate a Validator for the actual widget. Learn more about Validators in ChapterFormatter.(Formatters/Validators) | X |
Table 4.22. Hidden Widget Properties
A Hidden Widget is workable in the Outline View and uses the Property View to edit its Properties. It isn't shown in the PreView.
Learn more about how to create a Widget in Chapter Create a new Widget(Create a new Widget).
A Page Composite is a special form of a XMA Composite(XMA Composite). A Page Composite contains all the widgets of a page. Because it may have no other widget as parent, there is no way to specify FormData to it. A Page Composite is mapped to a SWT Composite. If you select a Page Composite you may see the information shown in the following table with the Property View.
The column editable provide information whether the property is editable in the Guidesigner. Learn more about correspondent SWT concepts in Standard Widget Toolkit
| Property | Type | Description | Editable |
| Instance Name | String | Name of the instance of the model of this widget. The instance name of the widget is the same name with a 'L' postfix for labels and a 'W' postfix for all other widgets. | X |
| Margin Height | int | The vertical margin (top, bottom) of this composite in pixel. | X |
| Margin Width | int | The horizontal margin (left,right) of this composite in pixel. | X |
| Tooltip | String | Tooltip text in the components language. maps to: org.eclipse.swt.widgets.Control.TooltipText | X |
| YN Border | boolean | True, if the Widget has a border. Style of org.eclipse.swt.widgets.Control Default: false | X |
| YN Enabled | boolean | True, if the widget is enabled (can grab focus). Maps to: org.eclipse.swt.widgets.Control.Enabled | X |
| YN in Tab Sequence | boolean | False, if the widget doesn't attend in the tab sequence of the parent composite. Default: true | X |
| YN Visible | boolean | True, if the Widget is visible. Maps to: org.eclipse.swt.widgets.Control.Visible | X |
Table 4.23. Page Composite Properties
Learn more about the role of a composite in the layout in Chapter Layouting(Layouting with the Guidesigner).
A Page Composite is workable in the Outline View and PreView and uses the Property View to edit its Properties.
A Page Composite may have the following Widget Types as Childs(XMA Composite Views and Childs): (same as Childs of XMA Composite)
Learn more about how to create a Widget in Chapter Create a new Widget(Create a new Widget).
A Push Button is mapped to a SWT Button Control with Style PUSH and represents a Command Button in the StyleGuide.
If you select a Push Button you may see the information shown in the following table with the Property View.
The column editable provide information whether the property is editable in the Guidesigner. Learn more about correspondent SWT concepts in Standard Widget Toolkit
| Property | Type | Description | Editable |
| Align Label | SelectionList | The alignment property of the push button widget. style of org.eclipse.swt.widgets.Button Values: LEFT CENTER RIGHT | X |
| FormData | Dialog | Shows the FormData settings of the actual widget. If you select this property theFormData Dialog(FormData Dialog)starts. | X |
| ImageUri | Dialog | The relative Uri to the image label. As workaround push the 'Cancel' button in the Uri Dialog to remove an ImageUri. maps to: org.eclipse.swt.widgets.Button.Image | X |
| Instance Name | String | Name of the instance of the model of this widget. | X |
| Label | String | The text of the Label. This Property was loaded/saved in the particular Resource bundle dependent of the actual Language of the Component. | X |
| Tooltip | String | Tooltip text in the components language. maps to: org.eclipse.swt.widgets.Control.TooltipText | X |
| YN Border | boolean | True, if the Widget has a border. Style of org.eclipse.swt.widgets.Control Default: false | X |
| YN Enabled | boolean | True, if the widget is enabled (can grab focus). Maps to: org.eclipse.swt.widgets.Control.Enabled | X |
| YN Selection Event | boolean | If true a selection event method is generated. | X |
| YN in Tab Sequence | boolean | False, if the widget doesn't attend in the tab sequence of the parent composite. Default: true | X |
| YN Visible | boolean | True, if the Widget is visible. Maps to: org.eclipse.swt.widgets.Control.Visible | X |
Table 4.24. Push Button Properties
A Push Button is workable in the Outline View and PreView and uses the Property View to edit its Properties.
Learn more about how to create a Widget in Chapter Create a new Widget(Create a new Widget).
A Radio Button is mapped to a SWT Button Control with Style RADIO and represents a Option Button in the StyleGuide. Normally Radio Buttons are grouped together in a XMA Group(XMA Group) .
Radio Buttons in one group (actual Radio Buttons with the same parent) are building a single selection unit. The automatic single selection behauvior only works via the GUI, if a Radio Button is selected by an API call, the others have to be deselected.
Note a strange behauvior under Ms Windows: if a Radio Button is the very first widget in a page's tab order than it is automatically selected at Shell.open(), even if another Radio Button was selected before by an API call.
If you select a Radio Button you may see the information shown in the following table with the Property View.
The column editable provide information whether the property is editable in the Guidesigner. Learn more about correspondent SWT concepts in Standard Widget Toolkit
| Property | Type | Description | Editable |
| Align Label | SelectionList | The alignment property of the radio button widget. style of org.eclipse.swt.widgets.Button Values: LEFT CENTER RIGHT | X |
| FormData | Dialog | Shows the FormData settings of the actual widget. If you select this property the FormData Dialog(FormData Dialog) starts. | X |
| ImageUri | Dialog | The relative Uri to the image label. As workaround push the 'Cancel' button in the Uri Dialog to remove an ImageUri. maps to: org.eclipse.swt.widgets.Button.Image | X |
| Instance Name | String | Name of the instance of the model of this widget. | X |
| Label | String | The text of the Label. This Property was loaded/saved in the particular Resource bundle dependent of the actual Language of the Component. | X |
| Tooltip | String | Tooltip text in the components language. maps to: org.eclipse.swt.widgets.Control.TooltipText | X |
| YN Border | boolean | True, if the Widget has a border. Style of org.eclipse.swt.widgets.Control Default: false | X |
| YN Enabled | boolean | True, if the widget is enabled (can grab focus). Maps to: org.eclipse.swt.widgets.Control.Enabled | X |
| YN Selection Event | boolean | If true, a selection event method is generated for a radiobutton. | X |
| YN in Tab Sequence | boolean | False, if the widget doesn't attend in the tab sequence of the parent composite. Default: true | X |
| YN Visible | boolean | True, if the Widget is visible. Maps to: org.eclipse.swt.widgets.Control.Visible | X |
Table 4.25. Radio Button Properties
A Radio Button is workable in the Outline View and PreView and uses the Property View to edit its Properties.
Learn more about how to create a Widget in Chapter Create a new Widget(Create a new Widget).
A Simple Combo represents Combos that have to be filled per hand and is mapped to a SWT Combo Widget and represents a Drop-Down List Boxes in the StyleGuide. If you select a Simple Combo you may see the information shown in the following table with the Property View.
The column editable provide information whether the property is editable in the Guidesigner. Learn more about correspondent SWT concepts in Standard Widget Toolkit
| Property | Type | Description | Editable |
| Business Data | String | Shows the Businessdata Attribute to which the actual widget is mapped. | |
| Business Data Validator | String | Shows the Validator of the the Businessdata Attribute. Properties of this Validator may be cross-faded thru the properties of the Validator Property (see below). The Infos are used to generate a Validator for the actual widget. Learn more about Validators in Chapter Formatter.(Formatters/Validators) | |
| FormData | Dialog | Shows the FormData settings of the actual widget. If you select this property the FormData Dialog(FormData Dialog)starts. | X |
| Instance Name | String | Name of the instance of the model of this widget. The instance name of the widget is the same name with a 'L' postfix for labels and a 'W' postfix for all other widgets. | X |
| Label | SelectionList | Contains the XMA Label widget, with which the actual widget is linked. | X |
| Tooltip | String | Tooltip text in the components language. maps to: org.eclipse.swt.widgets.Control.TooltipText | X |
| Validator | Dialog | Shows Infos about the Validator of this widget. This Infos cross-fade the properties of the BusinessData Validator Property (see above). The Infos are used to generate a Validator for the actual widget. Learn more about Validators in Chapter Formatter.(Formatters/Validators) | X |
| YN Border | boolean | True, if the Widget has a border. Style of org.eclipse.swt.widgets.Control Default:true | X |
| YN DropDown | boolean | If true, the combo turned out to be a drop down list. style of org.eclipse.swt.widgets.Combo | X |
| YN Editable | boolean | If false, the control couldn't be edited. | X |
| YN Enabled | boolean | True, if the widget is enabled (can grab focus). Maps to: org.eclipse.swt.widgets.Control.Enabled | X |
| YN in Tab Sequence | boolean | False, if the widget doesn't attend in the tab sequence of the parent composite. Default: true | X |
| YN ReadOnly | boolean | Values can be only selected but not entered in the combo. style of org.eclipse.swt.widgets.Combo. Uses keyboard selection algorithm of windows combo box. | X |
| YN Selection Event | boolean | If true a selection event method is generated. | X |
| YN Strict | boolean | If true only values of the selection list may be selected/inputed. Uses prefix search algorithm of XMA. | X |
| YN Visible | boolean | True, if the Widget is visible. Maps to: org.eclipse.swt.widgets.Control.Visible | X |
Table 4.26. Simple Combo Properties
If the user should be able to enter values not contained in the drop down list, use YnReadOnly=false and YnStrict=false.
If the user should only be able to select values from the drop down list, the recommended way is to use YnReadOnly=true. It is also possible to achieve the same with YnStrict. If you want to know the differences, read on.
If YnReadOnly is set to false, the user can enter data into the text field of the combo box. The simple combo automatically performs a prefix search on every keystroke based on the currently entered data. If the drop down list of the combo contains an entry which starts with the current data of the text field, it is selected automatically. If more than one entry matches, the first matching is selected. The part of the data not entered by the user but determined by this prefix search is marked as selected and will be overwritten completely with the next keystroke leading to a new longer prefix for the next prefix search.
This is best shown by an example. Suppose you have created a simple combo with the following entries: 11235, 12345, 22222. Its properties are YnReadOnly=false, YnStrict=false. When the user presses the key "1", the combo will look like this:
With YnStrict=true, the prefix search works just the same. But the user is not allowed to enter data that can not be found in the drop down list of the combo. If no match can be found, the text field stays in the same state as before the keystroke. Suppose the same example as above again. The simple combo has the following entries: 11235, 12345, 22222. Its properties are YnReadOnly=false, YnStrict=true. The user again presses the following keys "1", "2". After the first two keys the result is the same:
Prefix search is case sensitive by default. This can be changed by calling the method IListWMClient.setPrefixSearchCaseSensitive(). Prefix search can be disabled by calling IListWMClient.setDoPrefixSearch(false). Do not disable prefix serach if YnStrict=true since YnStrict=true depends on prefix search to determine a valid selection.
If YnReadOnly is true, the text field of the combo box is read only. The user can only use the drop down list. No prefix search will be performed. The value of YnStrict is ignored. But keyboard entry is still possible. If the user presses a key, the next entry in the drop down list starting with this key is selected.
Now lets look at our example with this property setting. The simple combo still has the following entries: 11235, 12345, 22222. Its properties are YnReadOnly=false. The value of YnStrict is not relevant. When the user presses the key "1", the combo will look like this:
A Combo is workable in the Outline View and PreView and uses the Property View to edit its Properties.
Learn more about how to create a Widget in Chapter Create a new Widget(Create a new Widget).
A XMA Combo contains a selectable list of values with a short key value and a longer descriptive value. To see values you have to declare a Data Source.
The XMACombo is mapped to a SWT Combo Widget and represents a Drop-Down List Boxes in the StyleGuide.
If Displaytype is SHOW_LONG than Order has to be ORDER_LONG. If Displaytype is SHOW_SHORT_LONG than Order has to be ORDER_SHORT.
If you select a XMA Combo you may see the information shown in the following table with the Property View.
The column editable provide information whether the property is editable in the Guidesigner. Learn more about correspondent SWT concepts in Standard Widget Toolkit
| Property | Type | Description | Editable |
| Business Data | String | Shows the Businessdata Attribute to which the actual widget is mapped. | |
| Data Source | XMAUri | The URI to the datasource. | X |
| Displaytype | SelectionList | Specifies the possible display types of domain combos. Values: SHOW_LONG SHOW_SHORT_LONG SHOW_LONG | X |
| FormData | Dialog | Shows the FormData settings of the actual widget. If you select this property the FormData Dialog(FormData Dialog) starts. | X |
| Instance Name | String | Name of the instance of the model of this widget. The instance name of the widget is the same name with a 'L' postfix for labels and a 'W' postfix for all other widgets. | X |
| Label | SelectionList | Contains the XMA Label widget, with which the actual widget is linked. | X |
| Order | SelectionList | Specifies the possible order of domain values. Values: ORDER_SHORT ORDER_LONG ORDER_NATURAL | X |
| Tooltip | String | Tooltip text in the components language. maps to: org.eclipse.swt.widgets.Control.TooltipText | X |
| Validator | Dialog | Shows Infos about the Validator of this widget. This Infos cross-fade the properties of the BusinessData Validator Property (see above). The Infos are used to generate a Validator for the actual widget. Learn more about Validators in Chapter Formatter.(Formatters/Validators) | X |
| YN Border | boolean | True, if the Widget has a border. Style of org.eclipse.swt.widgets.Control Default: true | X |
| YN DropDown | boolean | If true, the combo turned out to be a drop down list. style of org.eclipse.swt.widgets.Combo | X |
| YN Dynamic | boolean | Specifies if the "Data Source" is determined at UI-design-time (the default) or dynamically at application-runtime (this is called "dynamic"). If "YN Dynamic" is set to false, the field "Data Source" specifies where the list of values displayed in the combo-box is drawn from. Otherwise, i.e., "YN Dynamic" is set to true, the value entered in "Data Source" is ignored and the application must set the data-source explicitely in code. The latter is done either by using the method IListDomWM.setDataSource() or connecting the widget-model to an ADomain-AtomicAttrVal, where the data-source is taken from the ADomain. | X |
| YN Editable | boolean | If false, the control couldn't be edited. | X |
| YN Enabled | boolean | True, if the widget is enabled (can grab focus). Maps to: org.eclipse.swt.widgets.Control.Enabled | X |
| YN in Tab Sequence | boolean | False, if the widget doesn't attend in the tab sequence of the parent composite. Default: true | X |
| YN Mandatory | boolean | True if one value has to be selected. | X |
| YN Selection Event | boolean | If true a selection event method is generated. | X |
| YN Visible | boolean | True, if the Widget is visible. Maps to: org.eclipse.swt.widgets.Control.Visible | X |
Table 4.27. XMA Combo Properties
Learn more about Data Sources in Chapter Data Source.(Data Sources)
A Combo is workable in the Outline View and PreView and uses the Property View to edit its Properties. If you map a XMA Combo to a BusinessData Attribute the attribute should be of type ADomX. The Data Source given in the ADomX constructor always overrides the content of the Data Source property.
Learn more about how to create a Widget in Chapter Create a new Widget(Create a new Widget).
A XMA Composite is a container that holds other widgets. It is used as an instrument of grouping widgets without a border. The composite is always the parent of the widget it holds. Therefore all layout infos of its widget that are given in percent of the parent are relative to the composite. A XMA Composite is mapped to a SWT Composite. If you select a XMA Composite you may see the information shown in the following table with the Property View.
The column editable provide information whether the property is editable in the Guidesigner. Learn more about correspondent SWT concepts in Standard Widget Toolkit
| Property | Type | Description | Editable |
| FormData | Dialog | Shows the FormData settings of the actual widget. If you select this property the FormData Dialog(FormData Dialog) starts. | X |
| Instance Name | String | Name of the instance of the model of this widget. The instance name of the widget is the same name with a 'L' postfix for labels and a 'W' postfix for all other widgets. | X |
| Margin Height | int | The vertical margin (top, bottom) of this composite in pixel. | X |
| Margin Width | int | The horizontal margin (left,right) of this composite in pixel. | X |
| Tooltip | String | Tooltip text in the components language. maps to: org.eclipse.swt.widgets.Control.TooltipText | X |
| YN Border | boolean | True, if the Widget has a border. Style of org.eclipse.swt.widgets.Control Default: false | X |
| YN Enabled | boolean | True, if the widget is enabled (can grab focus). Maps to: org.eclipse.swt.widgets.Control.Enabled | X |
| YN in Tab Sequence | boolean | False, if the widget doesn't attend in the tab sequence of the parent composite. Default: true | X |
| YN Visible | boolean | True, if the Widget is visible. Maps to: org.eclipse.swt.widgets.Control.Visible | X |
Table 4.28. XMA Composite Properties
Learn more about the role of a composite in the layout in Chapter Layouting(Layouting with the Guidesigner).
A Composite is workable in the Outline View and PreView and uses the Property View to edit its Properties.
A XMA Composite may have the following Widget Types as Childs:
|
Table 4.30. Children |
Table 4.29. XMA Composite Children
Learn more about how to create a Widget in Chapter Create a new Widget(Create a new Widget).
A XMAContainer holds embeddable pages.
If you select a XMA Container you may see the information shown in the following table with the Property View.
The column editable provide information whether the property is editable in the Guidesigner. Learn more about correspondent SWT concepts in Standard Widget Toolkit
| Property | Type | Description | Editable |
| Emmbedded Page | SelectionList | If the container shall hold an embedded page of the actual component, you have to select the page from the selection list. | X |
| FormData | Dialog | Shows the FormData settings of the actual widget. If you select this property the FormData Dialog(FormData Dialog) starts. | X |
| Instance Name | String | Name of the instance of the model of this widget. The instance name of the widget is the same name with a 'L' postfix for labels and a 'W' postfix for all other widgets. | X |
| Tooltip | String | This property has no relevance for XMA Container. | X |
| Component URI | String | Uniquely identifies the embedded component. For component which are part of the same web-application this is just the component name. | X |
| YN Border | boolean | This property has no relevance for XMA Container. | X |
| YN Enabled | boolean | This property has no relevance for XMA Container. | X |
| YN in Tab Sequence | boolean | This property has no relevance for XMA Container. | X |
| YN Local Component | boolean | Indicates if the embedded component is part of the same web-application. | X |
| YN Visible | boolean | This property has no relevance for XMA Container. | X |
Table 4.31. XMA Container Properties
The XMA Container decides the size of theEmbedded Pages(Embedded Page). Learn more about XMA Containers in Chapter Embedded Page(Embedded Page)respective in chapter Embedded Component(Embedded Component).
A XMA Container is workable in the Outline View and PreView thru the context menu and uses the Property View to edit its Properties. If the container embeds a Component URI the XMA Container is shown in magenta color.
If the container embeds a local Embedded Page, this Embedded Page is shown in the PreViewer. If you click in a widget in the container the corresponding widget in the Embedded of the Container is selected.
Learn more about how to create a Widget in Chapter Create a new Widget(Create a new Widget).
A XMA Grid represents an excel like grid control. This control allows the presentation of excel spreadsheets in XMA including simple formatting and formala evaluation(Grid Widget Models). The end user can enter data in individual cells of the grid. Formulas are automatically recalulated if there result may change.
Note: This is not a general purpose editable table. Its purpose is to present and manipulate execl sheets directly in XMA where this is needed. You have to conatact the architecture team before using this control.
The GUIDesigner shows an empty spreadsheet. The horizontal and vertical scroll bars are shown automatically by SWT if they are necessary. A Grid is mapped to a SWT Table.
If you select a XMA Grid you may see the information shown in the following table with the Property View.
The column editable provide information whether the property is editable in the Guidesigner. Learn more about correspondent SWT concepts in Standard Widget Toolkit
| Property | Type | Description | Editable |
| FormData | Dialog | Shows the FormData settings of the actual widget. If you select this property the FormData Dialog(FormData Dialog) starts. | X |
| Instance Name | String | Name of the instance of the model of this widget.
The instance name of the widget is the same name with a 'W'
postfix for the table widget and a 'WE' postfix for the
| X |
| Tooltip | String | Tooltip text in the components language. maps to: org.eclipse.swt.widgets.Control.TooltipText | X |
| YN Border | boolean | True, if the Widget has a border. Style of org.eclipse.swt.widgets.Control Default: true | X |
| YN Enabled | boolean | True, if the widget is enabled (can grab focus). Maps to: org.eclipse.swt.widgets.Control.Enabled | X |
| YN Header Visible | boolean | True means the table header is visible. mapped to:org.eclipse.swt.widgets.Table.HeaderVisible | X |
| YN Grid Visible | boolean | True means that the table grid is shown. mapped to: org.eclipse.swt.widgets.Table.LinesVisible | X |
| YN in Tab Sequence | boolean | False, if the widget doesn't attend in the tab sequence of the parent composite. Default: true | X |
| YN Selection Event | boolean | If true a selection event method is generated. | X |
| YN Visible | boolean | True, if the Widget is visible. Maps to: org.eclipse.swt.widgets.Control.Visible | X |
Table 4.32. XMA Grid Properties
Learn more about XMA Grid in Chapter Grid Widget Models(Grid Widget Models).
Learn more about how to create a Widget in Chapter Create a new Widget(Create a new Widget).
A XMA Group is a special form of a XMA Composite(XMA Composite). Unlike a XMA Composite it has a border and a label. A Group is mapped to a SWT Group Composite and represents a Group Box in the StyleGuide. If you select a XMA Group you may see the information shown in the following table with the Property View.
The column editable provide information whether the property is editable in the Guidesigner. Learn more about correspondent SWT concepts in Standard Widget Toolkit
| Property | Type | Description | Editable |
| Instance Name | String | Name of the instance of the model of this widget. The instance name of the widget is the same name with a 'L' postfix for labels and a 'W' postfix for all other widgets. | X |
| Label | String | Label of the Group Composite in the actual language. Learn more about the actual language in XMA Component(XMA Component): maps to: org.eclipse.swt.widgets.Group.Text | X |
| Margin Height | int | The vertical margin (top, bottom) of this composite in pixel. | X |
| Margin Width | int | The horizontal margin (left,right) of this composite in pixel. | X |
| Tooltip | String | Tooltip text in the components language. maps to: org.eclipse.swt.widgets.Control.TooltipText | X |
| YN Border | boolean | True, if the Widget has a border. Style of org.eclipse.swt.widgets.Control Default: false | X |
| YN Enabled | boolean | True, if the widget is enabled (can grab focus). Maps to: org.eclipse.swt.widgets.Control.Enabled | X |
| YN in Tab Sequence | boolean | False, if the widget doesn't attend in the tab sequence of the parent composite. Default: true | X |
| YN Visible | boolean | True, if the Widget is visible. Maps to: org.eclipse.swt.widgets.Control.Visible | X |
Table 4.33. XMA Group Properties
Learn more about the role of a composite in the layout in Chapter Layouting(Layouting with the Guidesigner).
A Page Composite is workable in the Outline View and PreView and uses the Property View to edit its Properties.
A Page Composite may have the following Widget Types as Childs(XMA Composite Views and Childs): (same as Childs of XMA Composite)
Learn more about how to create a Widget in Chapter Create a new Widget(Create a new Widget).
A Label is mapped to a SWT Label Control and represents a Label and a read-only text Box in the StyleGuide.
If you select a XMA Label you may see the information shown in the following table with the Property View.
The column editable provide information whether the property is editable in the Guidesigner. Learn more about correspondent SWT concepts in Standard Widget Toolkit
| Property | Type | Description | Editable |
| Align Label | SelectionList | The alignment property of the Label widget. style of org.eclipse.swt.widgets.Label. Values: LEFT CENTER RIGHT | X |
| Belongs to Widget | SelectionList | For the following Widgets Labels are generated automatically when you create the widget:
| X |
| FormData | Dialog | Shows the FormData settings of the actual widget. If you select this property theFormData Dialog (FormData Dialog) starts. If the label is generated automatically with the widget the initial FormData settings of the appropriate label are made at the third page of the creation wizard. | X |
| ImageUri | Dialog | The relative Uri to the image label. As workaround push the 'Cancel' button in the Uri Dialog to remove an ImageUri. maps to: org.eclipse.swt.widgets.Label.Image | X |
| Instance Name | String | Name of the instance of the label. The Instancename is build of the Instancename of the widget model and a L' postfix. | X |
| Label | String | The text of the Label. This Property was loaded/saved in the particular Resource bundle dependent of the actual Language of the Component. | X |
| Tooltip | String | Tooltip text in the components language. maps to: org.eclipse.swt.widgets.Control.TooltipText | X |
| YN Bold | boolean | True, if the label has to be shown in bold style. style of org.eclipse.swt.graphics.FontData | X |
| YN Border | boolean | True, if the Widget has a border. Style of org.eclipse.swt.widgets.Control Default: false for label/seperator/xmacomposite's/button's true for all other | X |
| YN Enabled | boolean | True, if the widget is enabled (can grab focus). Maps to: org.eclipse.swt.widgets.Control.Enabled | X |
| YN in Tab Sequence | boolean | False, if the widget doesn't attend in the tab sequence of the parent composite. Default: false for label/seperator/radiobutton true for all other | X |
| YN Visible | boolean | True, if the Widget is visible. Maps to: org.eclipse.swt.widgets.Control.Visible | X |
| YN Wrap Label | boolean | True, if a line should be wrapped at the end of the control extent. style of org.eclipse.swt.widgets.Label | X |
Table 4.34. XMA Label Properties
A Label is workable in the Outline View and PreView and uses the Property View to edit its Properties.
Learn more about how to create a Widget in Chapter Create a new Widget(Create a new Widget).
A List is mapped to a SWT List Widget with Style and represents a Single- and Extended Selection List Box in the StyleGuide. If you select a XMA Composite you may see the information shown in the following table with the Property View.
The column editable provide information whether the property is editable in the Guidesigner. Learn more about correspondent SWT concepts in Standard Widget Toolkit
| Property | Type | Description | Editable |
| Business Data | String | Shows the Businessdata Attribute to which the actual widget is mapped. | |
| Business Data Validator | String | Shows the Validator of the the Businessdata Attribute. Properties of this Validator may be cross-faded thru the properties of the Validator Property (see below). The Infos are used to generate a Validator for the actual widget. Learn more about Validators in Chapter Formatter.(Formatters/Validators) | |
| FormData | Dialog | Shows the FormData settings of the actual widget. If you select this property the FormData Dialog(FormData Dialog) starts. | X |
| Instance Name | String | Name of the instance of the model of this widget. The instance name of the widget is the same name with a 'L' postfix for labels and a 'W' postfix for all other widgets. | X |
| Label | SelectionList | Contains the XMA Label widget, with which the actual widget is linked. | X |
| Tooltip | String | Tooltip text in the components language. maps to: org.eclipse.swt.widgets.Control.TooltipText | X |
| Validator | Dialog | Shows Infos about the Validator of this widget. This Infos cross-fade the properties of the BusinessData Validator Property (see above). The Infos are used to generate a Validator for the actual widget. Learn more about Validators in Chapter Formatter.(Formatters/Validators) | X |
| YN Border | boolean | True, if the Widget has a border. Style of org.eclipse.swt.widgets.Control Default: true | X |
| YN DoubleClick Event | boolean | If true a default selection event method is generated. | X |
| YN Editable | boolean | If false, the control couldn't be edited. | X |
| YN Enabled | boolean | True, if the widget is enabled (can grab focus). Maps to: org.eclipse.swt.widgets.Control.Enabled | X |
| YN Horizontal Scrollbar | boolean | If true, the list is presented with a horizontal scrollbar. style of org.eclipse.swt.widgets.List | X |
| YN Multi Selection Enabled | boolean | If true, the multiple selection model is supported. style of org.eclipse.swt.widgets.List | X |
| YN in Tab Sequence | boolean | False, if the widget doesn't attend in the tab sequence of the parent composite. Default: true | X |
| YN Selection Event | boolean | If true a selection event method is generated. | X |
| YN Vertical Scrollbar | boolean | if true, the list is preseneted with a vertical scrollbar. style of org.eclipse.swt.widgets.List | X |
| YN Visible | boolean | True, if the Widget is visible. Maps to: org.eclipse.swt.widgets.Control.Visible | X |
Table 4.35. XMA List Properties
Learn more about Lists in Chapter List Widget Model(List Widget Models)
A List is workable in the Outline View and PreView and uses the Property View to edit its Properties.
Learn more about how to create a Widget in Chapter Create a new Widget(Create a new Widget).
A SashForm is analogous a Swing JSplitPanel and is mapped to a SWT SashForm Composite. It has no representation in the StyleGuide. A SahForm does'nt need a LayoutManager. Therefore the childs of the immediate Sashform don't need any FormData Information.
If you select a XMA Sashform you may see the information shown in the following table with the Property View.
The column editable provide information whether the property is editable in the Guidesigner. Learn more about correspondent SWT concepts in Standard Widget Toolkit
| Property | Type | Description | Editable |
| FormData | Dialog | Shows the FormData settings of the actual widget. If you select this property the FormData Dialog(FormData Dialog) starts. | X |
| Instance Name | String | Name of the instance of the model of this widget. The instance name of the widget is the same name with a 'L' postfix for labels and a 'W' postfix for all other widgets. | X |
| Left Child Size (%) | int | Size of the left child of the Split pane in percent (value between 1 - 100) of the sash form size. | X |
| Split Direction | SelectionList | Values: HORIZONTAL VERTICAL | X |
| Tooltip | String | Tooltip text in the components language. maps to: org.eclipse.swt.widgets.Control.TooltipText | X |
| YN Border | boolean | True, if the Widget has a border. Style of org.eclipse.swt.widgets.Control Default: false for label/seperator/xmacomposite's/button's true for all other | X |
| YN Enabled | boolean | True, if the widget is enabled (can grab focus). Maps to: org.eclipse.swt.widgets.Control.Enabled | X |
| YN in Tab Sequence | boolean | False, if the widget doesn't attend in the tab sequence of the parent composite. Default: false for label/seperator/radiobutton true for all other | X |
| YN Visible | boolean | True, if the Widget is visible. Maps to: org.eclipse.swt.widgets.Control.Visible | X |
Table 4.36. XMA Sashform Properties
A Sashform is workable in the Outline View and uses the Property View to edit its Properties. A Sashform isn't selectable or editable in a PreView.
A XMA Sashform may have the following Widget Types as left or right Child. There is always only one left and one right child selectable.
|
Table 4.38. Children |
Table 4.37. XMA SashForm Children
Learn more about how to create a Widget in Chapter Create a new Widget(Create a new Widget).
A XMAScrolledComposite is a container which automatically shows scroll bars if the content of the inner Composite grows larger then the size of the scrolled composite. The size of the inner composite is determined the following way:
If a height is entered in the FormData of the inner composite, it is taken as the minimal height of the inner composite. If a width is entered in the FormData of the inner composite, it is taken as the minimal width of the inner composite.
If no height is entered in the FormData of the inner composite, its minimal height is calculated from its contents by SWT layout manager. If no width is entered in the FormData of the inner composite, its minimal width is calculated from its contents by SWT layout manager.
If the property "YN Expand child" is set to "true" and the size of the inner composite is smaller than the scrolled composite, the inner composite is expanded accordingly. If the height is smaller, the height is expanded. If the width is smaller, the width is expanded. If "YN Expand child" is set to "false", the minimal size determined by 1. and 2. is used as fixed size of the inner composite.
In a typical usage of XMA Scrolled Composite, you will leave "YN Expand child" to "true" (its default), so the user can enlarge the contained controls. The height of the inner composite can be left empty, so the SWT layout manager will calculate the needed minimal height. A vertical scrollbar will appear if the scrolled composite is not high enough. You will probably enter a small minimal width of the inner composite to prevent unnecessary horizontal scrollbars.
If the inner composite has some Formdata information only the FormData's height and width are used. Any Formdata Attachments of the inner composite have no effect on the layout.
The column editable provide information whether the property is editable in the Guidesigner. Learn more about correspondent SWT concepts in Standard Widget Toolkit
| Property | Type | Description | Editable |
| FormData | Dialog | Shows the FormData settings of the actual widget. If you select this property the FormData Dialog(FormData Dialog) starts. | X |
| Instance Name | String | Name of the instance of the model of this widget. The instance name of the widget is the same name with a 'L' postfix for labels and a 'W' postfix for all other widgets. | X |
| Tooltip | String | Tooltip text in the components language. maps to: org.eclipse.swt.widgets.Control.TooltipText | X |
| YN Border | boolean | True, if the Widget has a border. Style of org.eclipse.swt.widgets.Control Default: false | X |
| YN Enabled | boolean | True, if the widget is enabled (can grab focus). Maps to: org.eclipse.swt.widgets.Control.Enabled | X |
| YN Expand Child | boolean | If true, and the ScrolledComposite is greater than the inner Composite, the child control will be expanded. If false, the size of the inner composite is considerd fixed. | X |
| YN in Tab Sequence | boolean | False, if the widget doesn't attend in the tab sequence of the parent composite. Default: true | X |
| YN Visible | boolean | True, if the Widget is visible. Maps to: org.eclipse.swt.widgets.Control.Visible | X |
Table 4.39. XMA Scrolled Composite Properties
Learn more about the role of a composite in the layout in ChapterLayouting(Layouting with the Guidesigner).
A ScrolledComposite is workable in the Outline View and PreView and uses the Property View to edit its Properties.
A XMA Scrolled Composite may have exactly one child, which has to be one of the following Widget Types as Childs:
Learn more about how to create a Widget in Chapter Create a new Widget(Create a new Widget).
A Separator s used to separate widget with horizontal and vertical lines and is mapped to a SWT Label Control with Style HORIZONTAL or VERTICAL. A Separator is often used to simplify the Formlayout. Learn more about Layouting in Chapter Layouting with the Guidesigner(Layouting with the Guidesigner).
If you select a XMA Combo you may see the information shown in the following table with the Property View.
The column editable provide information whether the property is editable in the Guidesigner. Learn more about correspondent SWT concepts in Standard Widget Toolkit
| Property | Type | Description | Editable |
| Align Seperator | SelectionList | The Style of the separator. style of org.eclipse.swt.widgets.Separator Values: HORIZONTAL VERTICAL | X |
| FormData | Dialog | Shows the FormData settings of the actual widget. If you select this property the FormData Dialog(FormData Dialog) starts. | X |
| Instance Name | String | Name of the instance of the model of this widget. | X |
| Tooltip | String | Tooltip text in the components language. maps to: org.eclipse.swt.widgets.Control.TooltipText | X |
| YN Border | boolean | True, if the Widget has a border. Style of org.eclipse.swt.widgets.Control Default: false | X |
| YN Enabled | boolean | True, if the widget is enabled (can grab focus). Maps to: org.eclipse.swt.widgets.Control.Enabled | X |
| YN in Tab Sequence | boolean | False, if the widget doesn't attend in the tab sequence of the parent composite. Default: false | X |
| YN Visible | boolean | True, if the Widget is visible. Maps to: org.eclipse.swt.widgets.Control.Visible | X |
Table 4.42. XMA Seperator Properties
Learn more about Data Sources in Chapter Data Source.(How data sources work)
A Separator is workable in the Outline View and PreView and uses the Property View to edit its Properties.
Learn more about how to create a Widget in Chapter Create a new Widget(Create a new Widget).
A XMA Tabfolder is mapped to a SWT Tabfolder and represents a Tab Control in the StyleGuide. A Tabfolder contains Notebook Pages(Notebook Page).
If you select a XMA Tabfolder you may see the information shown in the following table with the Property View.
The column editable provide information whether the property is editable in the Guidesigner. Learn more about correspondent SWT concepts in Standard Widget Toolkit
| Property | Type | Description | Editable |
| FormData | Dialog | Shows the FormData settings of the actual widget. If you select this property the FormData Dialog(FormData Dialog) starts. | X |
| Instance Name | String | Name of the instance of the model of this widget. The instance name of the widget is the same name with a 'L' postfix for labels and a 'W' postfix for all other widgets. | X |
| Tooltip | String | Tooltip text in the components language. maps to: org.eclipse.swt.widgets.Control.TooltipText | X |
| YN Border | boolean | True, if the Widget has a border. Style of org.eclipse.swt.widgets.Control Default: true | X |
| YN Enabled | boolean | True, if the widget is enabled (can grab focus). Maps to: org.eclipse.swt.widgets.Control.Enabled | X |
| YN in Tab Sequence | boolean | False, if the widget doesn't attend in the tab sequence of the parent composite. Default: true | X |
| YN Visible | boolean | True, if the Widget is visible. Maps to: org.eclipse.swt.widgets.Control.Visible | X |
Table 4.43. XMA Tabfolder Properties
A XMA Tabfolder is workable in the Outline View and PreView and uses the Property View to edit its Properties. A Tabfolder is not selectable in the PreView.
A Tabfolder may have the following Childs:
Learn more about how to create a Widget in Chapter Create a new Widget(Create a new Widget).
A XMA Table represents a multi column lists respective a list view control of the StyleGuide. For this reason a XMA Table holds XMA Tablecolumns(XMA Tablecolumn).
The GUIDesigner only supports FULL_SELECTION style (the whole row is marked) on the table. In a Table the horizontal and vertical scroll bars are set as recently as they are necessary. A Table is mapped to a SWT Table.
If you select a XMA Table you may see the information shown in the following table with the Property View.
The column editable provide information whether the property is editable in the Guidesigner. Learn more about correspondent SWT concepts in Standard Widget Toolkit
| Property | Type | Description | Editable |
| Business Data | String | Shows the Businessdata Attribute to which the key of the table is mapped. Every table must have a key specified in the mapper tool. | |
| FormData | Dialog | Shows the FormData settings of the actual widget. If you select this property the FormData Dialog(FormData Dialog) starts. | X |
| Instance Name | String | Name of the instance of the model of this widget. The instance name of the widget is the same name with a 'L' postfix for labels and a 'W' postfix for all other widgets. | X |
| Selection Type | SelectionList | Defines the Selection Mode. style of org.eclipse.swt.widgets. Table Values:
| X |
| Tooltip | String | Tooltip text in the components language. maps to: org.eclipse.swt.widgets.Control.TooltipText | X |
| YN Border | boolean | True, if the Widget has a border. Style of org.eclipse.swt.widgets.Control Default: true | X |
| YN DoubleClick Event | boolean | If true a default selection event method is generated. | X |
| YN Enabled | boolean | True, if the widget is enabled (can grab focus). Maps to: org.eclipse.swt.widgets.Control.Enabled | X |
| YN Header Visible | boolean | True means the table header is visible. mapped to:org.eclipse.swt.widgets.Table.HeaderVisible | X |
| YN Grid Visible | boolean | True means that the table grid is shown. mapped to: org.eclipse.swt.widgets.Table.LinesVisible | X |
| YN in Tab Sequence | boolean | False, if the widget doesn't attend in the tab sequence of the parent composite. Default: true | X |
| YN Oneway | boolean | A one way table has the property that its rows are never transmitted from client to server, only from server to client. | X |
| YN Selection Event | boolean | If true a selection event method is generated. | X |
| YN Sort Indicator | boolean | True, if a sort indicator on the column has to be visible. As the icon is placed on the left side of the header's title, all titles are shifted slightly to the right. It is not recommended to set a graphic file for a row/column and to use sort indicators, as all graphic objects on the table will have the size of the graphic object which is set first. Maps to: org.eclipse.swt.widgets.Control.Visible Default: false | X |
| YN Visible | boolean | True, if the Widget is visible. Maps to: org.eclipse.swt.widgets.Control.Visible | X |
| Column MinWidth Limit | int | No column can ever be resized to a smaller width. If the end user tries to make the size of a column smaller than ColumnMinWidthLimit, ColumnMinWidthLimit is used as new size of the column. (Table Layout Manager) | X |
| Default Column MaxWidth | int | The maximum width of columns without MaxWidth property. (Table Layout Manager) | X |
| Default Column MinWidth | int | The minimum width of columns without MinWidth property. (Table Layout Manager) | X |
| Default Column Width | int | The absolute width of columns without Width or Percent property. (Table Layout Manager) | X |
| Strech Column | int | The index of the column to stretch over the space of the table not occupied by the other columns. Its absolute width and percentage are ignored. Only its limits are respected. (Table Layout Manager) It overrules ynAutoPack, too. | X |
Table 4.45. XMA Table Properties
Learn more about XMA Table in Chapter Table Widget Models(Table Widget Models). Learn more about flexible layouting column widths in (Table Layout Manager).
A XMA Table is workable in the Outline View and PreView and uses the Property View to edit its Properties.
A XMA Table may have the following Types as Childs:
Learn more about how to create a Widget in Chapter Create a new Widget(Create a new Widget).
A Text is mapped to a SWT Control Text and represents a Text Field and a Static Text Field in the StyleGuide. A Text may hold Numeric, Money, Date and String values. Formatting and validation occurs on basis of the BusinessData Validator and Validator properties. If you select a XMA Text you may see the information shown in the following table with the Property View.
The column editable provide information whether the property is editable in the Guidesigner. Learn more about correspondent SWT concepts in Standard Widget Toolkit
| Property | Type | Description | Editable |
| Alignment | SelectionList | The alignment property of the Text widget. Default: for XMAText with BCDValidators assigned at the first time RIGHT else LEFT style of org.eclipse.swt.widgets.Text Values: LEFT CENTER RIGHT | X |
| Business Data | String | Shows the Businessdata Attribute to which the actual widget is mapped. | |
| Business Data Validator | String | Shows the Validator of the the Businessdata Attribute. Properties of this Validator may be cross-faded thru the properties of the Validator Property (see below). The Infos are used to generate a Validator for the actual widget. Learn more about Validators in Chapter Formatter.(Formatters/Validators) | |
| FormData | Dialog | Shows the FormData settings of the actual widget. If you select this property the FormData Dialog(FormData Dialog) starts. | X |
| Instance Name | String | Name of the instance of the model of this widget. The instance name of the widget is the same name with a 'L' postfix for labels and a 'W' postfix for all other widgets. | X |
| Label | SelectionList | Contains the XMA Label widget, with which the actual widget is linked. | X |
| Tooltip | String | Tooltip text in the components language. maps to: org.eclipse.swt.widgets.Control.TooltipText | X |
| Validator | Dialog | Shows Infos about the Validator of this widget. This Infos cross-fade the properties of the BusinessData Validator Property (see above). The Infos are used to generate a Validator for the actual widget. Learn more about Validators in Chapter Formatter.(Formatters/Validators) | X |
| YN Border | boolean | True, if the Widget has a border. Style of org.eclipse.swt.widgets.Control Default: true | X |
| YN Editable | boolean | If false, the control couldn't be edited. | X |
| YN Enabled | boolean | True, if the widget is enabled (can grab focus). Maps to: org.eclipse.swt.widgets.Control.Enabled | X |
| YN Horizontal Scrollbar | boolean | True, if a horizontal scrollbar has to be shown. style of org.eclipse.swt.widgets.Text | X |
| YN in Tab Sequence | boolean | False, if the widget doesn't attend in the tab sequence of the parent composite. Default: true | X |
| YN Multiline | boolean | True, if the text may have multiple lines. style of org.eclipse.swt.widgets.Text | X |
| YN Vertical Scroll | boolean | True, if a vertical scrollbar has to be shown. style of org.eclipse.swt.widgets.Text | X |
| YN Visible | boolean | True, if the Widget is visible. Maps to: org.eclipse.swt.widgets.Control.Visible | X |
| YN Wrap LineEnds | boolean | True, if a line should be wrapped at the end of the control. style of org.eclipse.swt.widgets.Text | X |
Table 4.48. XMA Text Properties
Learn more about Validators in Chapter Formatter.(Formatters/Validators)
A Text is workable in the Outline View and PreView and uses the Property View to edit its Properties.
Learn more about how to create a Widget in Chapter Create a new Widget(Create a new Widget).
A Tree is mapped to a SWT Tree and represents a Tree View in the StyleGuide. In a SWT Tree the horizontal and vertical scrolls are set as recently as they are neccesary. For Trees no databinding is supported. The Treemodel has to be build by hand.
If you select a XMA Tree you may see the information shown in the following table with the Property View.
The column editable provide information whether the property is editable in the Guidesigner. Learn more about correspondent SWT concepts in Standard Widget Toolkit
| Property | Type | Description | Editable |
| FormData | Dialog | Shows the FormData settings of the actual widget. If you select this property the FormData Dialog(FormData Dialog) starts. | X |
| Instance Name | String | Name of the instance of the model of this widget. The instance name of the widget is the same name with a 'L' postfix for labels and a 'W' postfix for all other widgets. | X |
| Selection Mode | SelectionList | Defines the Selection Mode. style of org.eclipse.swt.widgets.Table Values:
| X |
| Tooltip | String | Tooltip text in the components language. maps to: org.eclipse.swt.widgets.Control.TooltipText | X |
| YN Border | boolean | True, if the Widget has a border. Style of org.eclipse.swt.widgets.Control Default: true | X |
| YN Collapse Event | boolean | If true a default collapse tree node event method is generated. | X |
| YN DoubleClick Event | boolean | If true a default selection event method is generated. | X |
| YN Enabled | boolean | True, if the widget is enabled (can grab focus). Maps to: org.eclipse.swt.widgets.Control.Enabled | X |
| YN Expand Event | boolean | If true a default expand tree node event method is generated. | X |
| YN in Tab Sequence | boolean | False, if the widget doesn't attend in the tab sequence of the parent composite. Default: true | X |
| YN Selection Event | boolean | If true a selection event method is generated. | X |
| YN Visible | boolean | True, if the Widget is visible. Maps to: org.eclipse.swt.widgets.Control.Visible | X |
Table 4.49. XMA Tree Properties
A Tree is workable in the Outline View and PreView and uses the Property View to edit its Properties.
Learn more about how to create a Widget in Chapter Create a new Widget(Create a new Widget).
A XMA Tablecolumn could only appear as child of aXMA Table(XMA Table). A XMA TableColumn is mapped to a SWT TableColumn.
If you select a XMA Tablecolumn you may see the information shown in the following table with the Property View.
The column editable provide information whether the property is editable in the Guidesigner. Learn more about correspondent SWT concepts in Standard Widget Toolkit
| Property | Type | Description | Editable |
| Align Column | SelectionList | The alignment property of the table. default: for columns with BCDValidators assigned at the first time RIGHT else LEFT style of org.eclipse.swt.widgets.TableColumn Values: LEFT CENTER RIGHT | X |
| Business Data | String | Shows the Businessdata Attribute to which the actual widget is mapped. | |
| Business Data Validator | String | Shows the Validator of the the Businessdata Attribute. Properties of this Validator may be cross-faded thru the properties of the Validator Property (see below). The Infos are used to generate a Validator for the actual widget. Learn more about Validators in Chapter Formatter.(Formatters/Validators) | |
| Column Label | String | Contains the label of the column. This Property was loaded/saved in the particular Resource bundle dependent of the actual Language of the Component. | X |
| Image URI | Dialog | URI of the image for the column. mapped to: org.eclipse.swt.widgets.TableColumn.Image | X |
| Instance Name | String | Name of the instance of the model of this widget. The instance name of the widget is the same name with a 'L' postfix for labels and a 'W' postfix for all other widgets. | X |
| Validator | Dialog | Shows Infos about the Validator of this widget. This Infos cross-fade the properties of the BusinessData Validator Property (see above). The Infos are used to generate a Validator for the actual widget. Learn more about Validators in Chapter Formatter.(Formatters/Validators) | X |
| YN AutoPack | boolean | Makes the width of the column as wide as the column label. This property overrules the other layout properties of the column. | X |
| YN Hiden | boolean | If true, this column is a hidden field and not visible in the table. For hidden table columns, only the Instancename is used for generation. All other attributes are not be considered. | X |
| YN Resizeable | boolean | True means, that the column is resizable. mapped to: org.eclipse.swt.widgets.TableColumn.Resizeable | X |
| YN Sortable | boolean | If true, this column could be sorted. | X |
| MaxWidth | int | The maximum width of the column in pixel. (Table Layout Manager) This property is not used if Width is specified. | X |
| MinWidth | int | The minimum width of the column in pixel. (Table Layout Manager) This property is not used if Width is specified. | X |
| Percent | float | The width of the column as percentage of the width of the table. (Table Layout Manager) Only Width or Percent may be specified. | X |
| Width | int | The absolute width of the column in pixel. (Table Layout Manager) Only Width or Percent may be specified. | X |
Table 4.50. XMA TableColumn Properties
Learn more about Tables in Chapter XMA Table(XMA Table). Learn more about flexible layouting column widths in (Table Layout Manager)
A XMA Tablecolumn is only workable in the Outline View and uses the Property View to edit its Properties. In the PreView the Tablecolumn is show but it is not selectable there.
Learn more about how to create a Widget in Chapter Create a new Widget(Create a new Widget).
| |  | |
| 4.6 Guidesigner Customization |  | 4.8 Reference B: Guidesigner Properties |
