<ACTION> : Action

Java class : leon.info.LyAction

ROLE

This element defines an action. It defines a treatment that can be invoked from a view inside the graphical user interface, and that is applied to a selection of objects, which could be empty. The conditions and accessibility of these actions can also be defined. Predefined actions and their associated treatment exist inside Application Engine. Those actions are described inside the "Predefined elements" chapter.

ATTRIBUTES

<!ATTLIST ACTION
	  id ID #REQUIRED
	  template IDREF #IMPLIED
	  builder CDATA #IMPLIED
	  view CDATA #IMPLIED
	  controller CDATA #IMPLIED
	  behavior CDATA #IMPLIED
	  defaultAction IDREF #IMPLIED
	  target CDATA #IMPLIED
	  abstract ( true | false) "false">
Attribute Mand. Description Default
id yes Identifier of the action  
template no Reference to the action used as a pattern.  
builder no Full name of the Java class that builds the view at the start of the action. This class should inherit from the leon.control.builder.LyBuilder class. If both attributes view and builder are filled in, the builder information is discarded.  
view no Path to the XML file that describe the view, which is displayed when the action is invoked. This path could be absolute or relative to the current CLASSPATH. The file should follow the rules defined inside the instruction manual of the views descriptive grammar.  
controller no Full name of the Java class, this is responsible for the whole procedure for the action. This class should inherit from the leon.control.LyController class. The use of this attribute is reserved for new actions that do not inherit from generic actions. Otherwise, it is recommended to use the behavior attribute to define a class that describe specific behaviours.  
behavior no Full name of the Java class that defines specific behaviours for this action. This class should inherit from the leon.app.behavior.LyActionBehavior class.  
defaultAction no Reference to the action that is invoked when the user performs a double click inside the view associated to the current action.  
target no Target area of the action.  
abstract no Indicates whether the action is abstract or not. An abstract action is replaced for a given class by the real corresponding action. This one is determined by searching on the given class an action with this abstract action as a template. When an abstract action is used in a view, this action is enabled only if the context of the view (selection) contains objects whose class (or its ancestors) contains a real action (with the abstract action as a template). false

ELEMENTS

<!ELEMENT ACTION 
	  (NAME?,
	   ALIAS?,
	   MENU?,
	   GROUP?,
	   PREFIX?,
	   MIN?,
	   MAX?,
	   A_MARKS*,
	   (FILTER | FILTER_REF)?,
	   DATA*,
	   TIP?,
	   SHORTCUT?,
	   GEOMETRY?,
	   PARAMETER_DECL*,
	   PARAMETER*,
	   ACTIONS*,
	   RESOURCE*)>
Element Mand. Mult. Description
NAME no no Action name
ALIAS no no Short name of the action
MENU no no Name of the menu in which the action is added.
GROUP no no Name of the group to which the action belongs.
PREFIX no no Prefix of the names of the files associated to the action.
MIN no no Minimum number of selected objects, which is required to authorize the action to be executed.
MAX no no Maximum number of selected objects, which is required to authorize the action to be executed.
A_MARKS no yes Marks of the action.
FILTER yes no Filter. This element sets a condition for the selected objects to be allowed as targets of the current action.
FILTER_REF yes no Reference to a filter. This element sets a condition for the selected objects to be allowed as targets of the current action.
DATA no yes Specific data of the action.
TIP no no Help on the action.
SHORTCUT no no Key shortcut for executing the action.
GEOMETRY no no Geometry of the action view.
PARAMETER_DECL no yes Declaration of parameters of the action.
PARAMETER no yes Setting of parameters of the action.
ACTIONS no yes List of the available actions that can be invoked from the view of the current action.
RESOURCE no yes Resources of the action.

SAMPLE 1

<ACTION id="br_set2" behavior="BrSet2Behavior" template="_set">
	<PREFIX value="set"/>
	<MAX value="3"/>
	<A_MARKS>
		<MARK name="PROJECT_MANAGER"/>
		<MARK name="PROJECT_USER"/>
	</A_MARKS>
	<FILTER id="filter0" type='AND'>
		<EXP idref="obj_ver" not='true' condition='EQUALS' value="1"/>
	</FILTER>
</ACTION>

SAMPLE 2

<ACTION id="brDashboard" template="_dashboard">
	<NAME value="MAIN_WINDOW_TITLE"/>
	<PREFIX value="br"/>
	<ACTIONS>
		<ACTION_REF idref="brTable" class="brClass"/>
		<ACTION_REF idref="brTable" class="sysClass"/>
		<ACTION_REF idref="brTable" class="ssyClass"/>
		<ACTION_REF idref="brTable" class="verClass"/>
		<ACTION_REF idref="brTable" class="usrClass"/>
		<ACTION_REF idref="brTable" class="cusClass"/>
		<ACTION_REF idref="brTable" class="keyClass"/>
	</ACTIONS>
</ACTION>