4.8 Reference B: Guidesigner Properties

Guidesigner can be customized by properties in the file script/guidesign.properties in your project directory. The following properties customize the generation of java code by the guidesigner.

namemeaningdefault
Page.include

The package to import for the base classes of the pages. Guidesigner generate this import statement in all generated page *Gen.java files

 
DialogPage

Client side base class of all dialog pages. Guidesigner derives the client/*Gen.java class from this class

DialogPage
EmbeddedPage

Client side base class of all embedded pages. Guidesigner derives the client/*Gen.java class from this class

EmbeddedPage
NotebookPage

Client side base class of all notebook pages. Guidesigner derives the client/*Gen.java class from this class

NotebookPage
PageServer

Server side base class of all pages. Guidesigner derives all page server/*Gen.java from this class

PageServer
Component.include

The package to import for the base classes of the components. Guidesigner generate this import statement in all generated component *Gen.java files

 
ComponentClient

Client side base class for all components which are not embeddable. Guidesigner derives all client/*Gen.java which ar not embeddabele from this class.

ComponentClient
Embeddable Component

Client side base class for all embeddable components. Guidesigner derives all embeddable client/*Gen.java from this class.

Embeddable Component
ComponentServer

Server side base class for all components. Guidesigne derives all server/*Gen.java from this class

ComponentServer
allComponents EmbeddableIf true all component classes are derived from the class defined in the property 'EmbeddableComponent'. With this setting components consisting of dialog pages can be embedded, too.false
doGenBDMapCSVIf true an additional comma seperated value file containing the business data mappings of all controls of the component is generated. The file is named mapping.csv and is generated in the same directory where the component .xma-file exists.false
doGenIdCSVIf true an additional comma seperated value file containing all model ids of the component is generated. The file is named id.csv and is generated in the same directory where the component .xma-file exists.false
doUseTable LayoutManagerIf false, no code for TableLayoutManager is generated. You have set this property to false, if you want to generate code for XMA Runtime before 2.0.0. (see Compatibility with XMA Runtime versions before 2.0.0)true
doGenerateAuthorIf true a javadoc @author tag is generated into every generated java class. If you do not like this (it may be annoying in Gen-classes if nothing else changed), set this property to false.true
application.shellWith this property one page of the project can be defined to be the application shell. The page is named in the format <componentname>/<pagename> 
AppShell

Client side base class of the application shell page. Guidesigner derives the client/*Gen.java class from this class. The runtime provides the classes AppShell, ContextAppShell, MenuAppShell and TreeMenuAppShell

AppShell
ISimpleWMServer

Interface class used by Guidesigner to declare all simple widget model fields in server side pages.

ISimpleWMServer
SimpleWMServer

Class used by Guidesigner to instantiate all simple widget models in server side pages.

SimpleWMServer
IListWMServer

Interface class used by Guidesigner to declare all list widget model fields in server side pages.

IListWMServer
ListWMServer

Class used by Guidesigner to instantiate all list widget models in server side pages.

ListWMServer
IListDomWMServer

Interface class used by Guidesigner to declare all domain list widget model fields in server side pages.

IListDomWMServer
ListDomWMServer

Class used by Guidesigner to instantiate all domain list widget models in server side pages.

ListDomWMServer
ITableWMServer

Interface class used by Guidesigner to declare all table widget model fields in server side pages.

ITableWMServer
TableWMServer

Class used by Guidesigner to instantiate all table widget models in server side pages.

TableWMServer
ITreeWMServer

Interface class used by Guidesigner to declare all tree widget model fields in server side pages.

ITreeWMServer
TreeWMServer

Class used by Guidesigner to instantiate all tree widget models in server side pages.

TreeWMServer
IGridWMServer

Interface class used by Guidesigner to declare all grid widget model fields in server side pages.

IGridWMServer
GridWMServer

Class used by Guidesigner to instantiate all grid widget models in server side pages.

GridWMServer

Table 4.51. GUIDesigner Properties