Difference between revisions of "Riena Navigation Element Reference"

Latest revision as of 03:38, 8 July 2011

{{#eclipseproject:rt.riena}}

assembly

use

attributes

• name - Used to display a friendly string within the PDE
• id - Unique id of the assembly.
• assembler - The assembler class to be used to create this assembly. The class must implement org.eclipse.riena.navigation.INavigationAssembler. If this attribute is missing class org.eclipse.riena.navigation.model.GenericNavigationAssembler will be used.
• parentTypeId - The type part of the default parents node id. If the user tries to create a navigation node this assembly is responsible for and no parent is provided, tha application is searched for a node with this type id and adds the node created by this assembly to that parent.
• autostartsequence - Automatically calls the associated assembler upon application startup thus creating the navigation nodes for this assembly. The attribute should be an integer indicating the index of this assembly within the startup sequence and therefore defines the position(s) of the associated node(s).
• ref - Reference to another assembly defined elsewhere with that id. If the assembly element is a child element of on of the oother elements except foreach this is the only legal attribute. This attribute has no meaning(and should therefore not be used) within a top level assembly definition.

subelements

Exactly one of subapplication or modulegroup or module or submodule is required if using a generic assembler. If a custom assembler is used none is required.

subapplication

use

attributes

• name - Used to display a friendly string within the PDE
• typeId - The type part of the navigation node id identifying the kind of dialog.
• instanceId - The instance part of the navigation node id is used in conjunction with the type part to uniquely identify instances of the same kind of dialog.
• label - Text to be displayed in the subapplications handle.
• view - Id of the perspective associated with this subapplication.

subelements

any combination of an arbitrary number of modulegroup and/or assembly elements

modulegroup

use

attributes

• name - Used to display a friendly string within the PDE
• typeId - The type part of the navigation node id identifying the kind of dialog.
• instanceId - The instance part of the navigation node id is used in conjunction with the type part to uniquely identify instances of the same kind of dialog.

subelements

any combination of an arbitrary number of module and/or assembly elements

module

use

attributes

• name - Used to display a friendly string within the PDE
• typeId - The type part of the navigation node id identifying the kind of dialog.
• instanceId - The instance part of the navigation node id is used in conjunction with the type part to uniquely identify instances of the same kind of dialog.
• label - Text to be displayed in the navigation tree module button.
• icon - Icon to be displayed in the navigation tree module button.
• unclosable - "true" if the module should not be closable. Defaults to "false".

subelements

any combination of an arbitrary number of submodule and/or assembly elements

submodule

use

attributes

• name - Used to display a friendly string within the PDE
• typeId - The type part of the navigation node id identifying the kind of dialog.
• instanceId - The instance part of the navigation node id is used in conjunction with the type part to uniquely identify instances of the same kind of dialog.
• label - Text to be displayed in the navigation tree and the submodule title.
• icon - Icon to be displayed in the navigation tree and the submodule title.
• view - Id of the org.eclipse.ui.views view element associated with this submodule.
• controller - Controller class to be used with this submodules view. Must implement org.eclipse.riena.ui.ridgets.controller.IController.
• shared - "true" if this is a shared view, ie the same view instance should be used with all submodule node instances with the same typeId. Defaults to "false".

subelements

any combination of an arbitrary number of submodule, foreach and/or assembly elements

foreach

use

attributes

• element - The variable name of the loop variable.
• in - A variable expression returning a collection or array.

subelements

exactly one submodule element