|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This configuration interface of the Gui aspect defines all the methods that handle the appearence of the classes in the GUI.
GuiAC
,
View
Method Summary | |
void |
selectWithIndexedField(ClassItem cl,
CollectionItem collection,
String repositoryName)
Tells the gui to use a primary key field to select instances of a class, instead of a combobox. |
void |
setAttributesOrder(ClassItem cl,
String[] attributeNames)
Sets the order in which the attributes of a class are to be rendered. |
void |
setAttributesOrder(ClassItem cl,
String viewName,
String[] attributeNames)
Sets the order in which the attributes of a class are to be rendered for a given view. |
void |
setCategories(ClassItem cl,
String[] categories)
This configuration method sets some categories for a class. |
void |
setCategoriesIcons(ClassItem cli,
String[] icons)
This configuration method sets categories icons for a class. |
void |
setCategoriesLabels(ClassItem cli,
String[] labels)
This configuration method sets categories labels for a class. |
void |
setCreationAttributesOrder(ClassItem cl,
String[] attributeNames)
Sets the order in which the attributes of a class are to be rendered when an instance is created. |
void |
setDefaultsAttributesOrder(ClassItem cl,
String[] attributeNames)
Sets the attributes to be displayed for editable default values in tables |
void |
setDefaultSortedColumn(ClassItem cl,
String column)
Sets a default sorted column for a class. |
void |
setDescription(ClassItem cl,
String description)
Sets the description of a class. |
void |
setDesktopCustomizedView(ClassItem classItem,
ClassItem type)
This configuration method allows the programmer to tell that the given class should be viewed with a given customized view when it is opened in a desktop panel. |
void |
setDisplayLabel(String virtualClass,
boolean value)
Wether to display a label containing the name of the field in views. |
void |
setDynamicClassChoice(String className,
MethodItem targetMethod)
Defines a method that returns instances of a class that should be displayed in comboboxes. |
void |
setDynamicIcon(ClassItem cli,
MethodItem iconMethod)
Defines a method to dynamically compute the icon for a class. |
void |
setFormat(String className,
String format)
Sets the display format of a class. |
void |
setIcon(ClassItem cli,
String name)
This configuration method attaches an icon to a given class so that the iconized instances of this class will be represented by this icon (for instance in a treeview). |
void |
setLabel(ClassItem cl,
String label)
Sets the label of a class. |
void |
setLineBreaks(ClassItem cli,
String[] fields)
Defines which fields should start on a new line. |
void |
setMenu(ClassItem classItem,
String[] menu)
This configuration method attaches a contextual menu to a given class so that the instances of this class will show the menu when the user performs a right click on it (by default the menu shows all the methods). |
void |
setMethodsOrder(ClassItem cl,
String[] methodNames)
Sets the order in which the methods of a class are to be rendered for the default view. |
void |
setMethodsOrder(ClassItem cl,
String viewName,
String[] methodNames)
Sets the order in which the methods of a class are to be rendered for a view. |
void |
setMnemonics(ClassItem cli,
String mnemonics)
Defines preferred mnemonics for class. |
void |
setReadOnly(ClassItem cli,
String viewName,
boolean readOnly)
|
void |
setStyle(ClassItem cli,
String style)
Set the style for a class |
void |
setTableMembersOrder(ClassItem cl,
String[] memberNames)
Sets the order in which the attributes of a class are to be rendered when their instance are placed within a table of the a default view. |
void |
setTableMembersOrder(ClassItem cl,
String viewName,
String[] memberNames)
Sets the order in which the attributes of a class are to be rendered when their instance are placed within a table of a given view. |
void |
setToolTipText(ClassItem classItem,
ClassItem selector,
String formatExpression)
Defines a contextual string tooltip for the instances of the class that will override the default one in some cases, depending on the selector parameter. |
void |
setToolTipText(ClassItem classItem,
MemberItem selector,
String formatExpression)
Defines a contextual string tooltip for the instances of the class that will override the default one in some cases, depending on the selector parameter. |
void |
setToolTipText(ClassItem classItem,
String formatExpression)
Defines a contextual string tooltip for the instances of a class. |
void |
setToString(ClassItem classItem,
ClassItem selector,
String formatExpression)
Defines a contextual string representation of the instances of the class that will override the default one in some cases, depending on the selector parameter. |
void |
setToString(ClassItem classItem,
MemberItem selector,
String formatExpression)
Defines a contextual string representation of the instances of the class that will override the default one in some cases, depending on the selector parameter. |
void |
setToString(ClassItem classItem,
String formatExpression)
Defines the string representation of the instances of the class. |
void |
setTreeAttributesOrder(ClassItem cl,
String[] attributeNames)
Sets the order in which the attributes of a class are to be rendered when their instance are placed within a tree. |
Method Detail |
public void setToString(ClassItem classItem, String formatExpression)
classItem
- the classformatExpression
- a string that contains field references
of the form %field_name%
. All the field references
are replaced by their value when a string representation of the
instance is needed. When you need to print out a %
,
then you must double it (%%
).setToString(ClassItem,MemberItem,String)
,
setToolTipText(ClassItem,MemberItem,String)
,
setToolTipText(ClassItem,ClassItem,String)
public void setToString(ClassItem classItem, MemberItem selector, String formatExpression)
classItem
- the classselector
- tells when the formatExpression should be
applied.formatExpression
- a string that contains field references
of the form %field_name%
. All the field references
are replaced by their value when a string representation of the
instance is needed. When you need to print out a %
,
then you must double it (%%
).setToString(ClassItem,String)
,
setToString(ClassItem,MemberItem,String)
,
setToolTipText(ClassItem,MemberItem,String)
,
setToolTipText(ClassItem,ClassItem,String)
public void setToString(ClassItem classItem, ClassItem selector, String formatExpression)
classItem
- the classselector
- tells when the formatExpression should be
applied.formatExpression
- a string that contains field references
of the form %field_name%
. All the field references
are replaced by their value when a string representation of the
instance is needed. When you need to print out a %
,
then you must double it (%%
).setToString(ClassItem,String)
,
setToString(ClassItem,MemberItem,String)
,
setToolTipText(ClassItem,MemberItem,String)
,
setToolTipText(ClassItem,ClassItem,String)
public void setIcon(ClassItem cli, String name)
cli
- the classname
- the icon's resource namesetDynamicIcon(ClassItem,MethodItem)
public void setDynamicIcon(ClassItem cli, MethodItem iconMethod)
cli
- a classiconMethod
- a static method which must take an object as
parameter and return a String or null. It will be invoked with
the object for which an icon must be determined.setIcon(ClassItem,String)
public void setToolTipText(ClassItem classItem, String formatExpression)
classItem
- the classformatExpression
- a string that contains field references
of the form %field_name%
. All the field references
are replaced by their value when a string representation of the
instance is needed. When you need to print out a %
,
then you must double it (%%
).setToolTipText(ClassItem,ClassItem,String)
,
setToolTipText(ClassItem,MemberItem,String)
public void setToolTipText(ClassItem classItem, MemberItem selector, String formatExpression)
classItem
- the classselector
- tells when the formatExpression should be
applied.formatExpression
- a string that contains field references
of the form %field_name%
. All the field references
are replaced by their value when a string representation of the
instance is needed. When you need to print out a %
,
then you must double it (%%
).setToolTipText(ClassItem,String)
,
setToolTipText(ClassItem,ClassItem,String)
public void setToolTipText(ClassItem classItem, ClassItem selector, String formatExpression)
classItem
- the classselector
- tells when the formatExpression should be
applied.formatExpression
- a string that contains field references
of the form %field_name%
. All the field references
are replaced by their value when a string representation of the
instance is needed. When you need to print out a %
,
then you must double it (%%
).setToolTipText(ClassItem,String)
,
setToolTipText(ClassItem,MemberItem,String)
public void setMenu(ClassItem classItem, String[] menu)
classItem
- the classmenu
- an array containing the names of the methods that
form the menu (must be declared in the class item), if an
element is an empty string, then a menu item separator is addedpublic void setCategories(ClassItem cl, String[] categories)
The GUI will interpret this categories to split the views of this class instances to be separated into several subviews. For instance, the Swing GUI will show the object in several parts placed into several tabs.
When this method has been called, each meta-item of the class
must be categorized with one of the categories by using the
setCategory
method.
cl
- the class itemcategories
- the categories for this classFieldAppearenceGuiConf.setCategory(MemberItem,String)
public void setCategoriesIcons(ClassItem cli, String[] icons)
cli
- the classicons
- the icons for the categoriessetCategories(ClassItem,String[])
public void setCategoriesLabels(ClassItem cli, String[] labels)
cli
- the classlabels
- the labels for the categoriessetCategories(ClassItem,String[])
public void setDesktopCustomizedView(ClassItem classItem, ClassItem type)
classItem
- the class of the viewed objectstype
- the class of the view componentpublic void setAttributesOrder(ClassItem cl, String[] attributeNames)
Attributes not listed here will not be rendered. This order
is also used for tableView rendered collections if the
setTableMembersOrder
method is not used.
cl
- the classattributeNames
- the name of the attributes in the
rendering ordersetAttributesOrder(ClassItem,String,String[])
,
setTableMembersOrder(ClassItem,String[])
,
setMethodsOrder(ClassItem,String[])
,
FieldAppearenceGuiConf.setMembersOrder(CollectionItem,ClassItem,String[])
public void setAttributesOrder(ClassItem cl, String viewName, String[] attributeNames)
Attributes not listed here will not be rendered. This order
is also used for tableView rendered collections if the
setTableMembersOrder
method is not used.
cl
- the classviewName
- the name of the viewattributeNames
- the name of the attributes in the
rendering ordersetAttributesOrder(ClassItem,String[])
,
setTableMembersOrder(ClassItem,String[])
,
FieldAppearenceGuiConf.setMembersOrder(CollectionItem,ClassItem,String[])
public void setDefaultsAttributesOrder(ClassItem cl, String[] attributeNames)
cl
- the classattributeNames
- the name of the attributesBehaviorGuiConf.setEditableDefaultValues(CollectionItem,boolean)
public void setLineBreaks(ClassItem cli, String[] fields)
cli
- the classfields
- the names fields which should start on a
new line.public void setMethodsOrder(ClassItem cl, String[] methodNames)
Methods not listed here will not be rendered.
cl
- the class namemethodNames
- the name of the methods in the
rendering ordersetMethodsOrder(ClassItem,String,String[])
public void setMethodsOrder(ClassItem cl, String viewName, String[] methodNames)
Methods not listed here will not be rendered.
cl
- the class nameviewName
- the view for which to set the methods ordermethodNames
- the name of the methods in the
rendering ordersetMethodsOrder(ClassItem,String[])
,
setAttributesOrder(ClassItem,String,String[])
public void setCreationAttributesOrder(ClassItem cl, String[] attributeNames)
cl
- the class nameattributeNames
- the name of the attributes in the
rendering ordersetAttributesOrder(ClassItem,String[])
public void setTableMembersOrder(ClassItem cl, String[] memberNames)
Attributes not listed here will not be rendered.
cl
- the class namememberNames
- the name of the member in the
rendering ordersetTableMembersOrder(ClassItem,String,String[])
,
setAttributesOrder(ClassItem,String[])
,
FieldAppearenceGuiConf.setMembersOrder(CollectionItem,ClassItem,String[])
public void setTableMembersOrder(ClassItem cl, String viewName, String[] memberNames)
Attributes not listed here will not be rendered.
cl
- the class nameviewName
- the name of the viewmemberNames
- the name of the member in the
rendering ordersetTableMembersOrder(ClassItem,String[])
,
FieldAppearenceGuiConf.setMembersOrder(CollectionItem,ClassItem,String[])
public void setTreeAttributesOrder(ClassItem cl, String[] attributeNames)
Attributes not listed here will not be rendered.
cl
- the class nameattributeNames
- the name of the attributes in the
rendering ordersetAttributesOrder(ClassItem,String[])
,
FieldAppearenceGuiConf.setMembersOrder(CollectionItem,ClassItem,String[])
public void setDefaultSortedColumn(ClassItem cl, String column)
cl
- the classcolumn
- the column used to sort (it is a fieldItem, watch
out for case). You may preprend a '-' to use the reverse order
of that column.public void setDescription(ClassItem cl, String description)
cl
- the classdescription
- the description of the classpublic void setLabel(ClassItem cl, String label)
cl
- the classlabel
- the label of the classpublic void setDisplayLabel(String virtualClass, boolean value)
virtualClass
- the name of the classvalue
- boolean indicating wether to display the label or notpublic void setFormat(String className, String format)
public void selectWithIndexedField(ClassItem cl, CollectionItem collection, String repositoryName)
cl
- the class whose instance to selectcollection
- the collection whose indexed field to userepositoryName
- name of the object holding the collectionRttiAC.setIndexedField(CollectionItem,FieldItem)
public void setStyle(ClassItem cli, String style)
cli
- the classstyle
- the CSS styleFieldAppearenceGuiConf.setStyle(FieldItem,String)
,
GuiConf.addStyleSheetURL(String)
,
GuiConf.addStyleSheetURL(String,String)
public void setReadOnly(ClassItem cli, String viewName, boolean readOnly)
public void setDynamicClassChoice(String className, MethodItem targetMethod)
className
- the class to configure (ClassItem or VirtualClassItem)targetMethod
- the static method that returns instances of
the class. It should take a ClassItem as a parameter and return
a CollectionFieldAppearenceGuiConf.setDynamicFieldChoice(FieldItem,Boolean,MethodItem)
public void setMnemonics(ClassItem cli, String mnemonics)
cli
- mnemonics
- the mnemonics
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |