<COMPOUND_ACTION> : Compound action

Java class : leon.info.LyCompoundAction

ROLE

This tag defines an action composed of other actions (usually two). It allows to create views that are composed of other views and to define the interactions among them.

ATTRIBUTES

<!ATTLIST COMPOUND_ACTION
	  id ID #REQUIRED
	  template IDREF #IMPLIED
	  builder CDATA #IMPLIED
	  controller CDATA #IMPLIED
	  behavior CDATA #IMPLIED
	  style ( HORIZONTAL | VERTICAL | GRID) "HORIZONTAL"
	  sizes CDATA #IMPLIED
	  context ( FIRST | SECOND | NONE) "FIRST"
	  clientContext ( FIRST | SECOND | NONE | BOTH) "BOTH"
	  target CDATA #IMPLIED
	  abstract ( true | false) "false">
Attribute Mand. Description Default
id yes Identifier of the compound 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.LyCompoundAreaBuilder class. If both attributes view and builder are filled in, the builder information is discarded.  
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.LyCompoundAreaController 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.LyBehavior class.  
style no This attribute indicates how the views of the sub-actions are combined. If there are only two sub-actions : one on top of the other (HORIZONTAL) or side by side (VERTICAL). If there are more than two actions, the style has to be set to GRID. HORIZONTAL
sizes no This attributes indicates the ratio taken by each view of the sub-actions inside the whole view. A ratio "40 60" indicates that the view related to the first action will have a size equals to 40 percent of the size of the global view. In the same way, the view related to the second action will have a size equals to 60 percent of the size of the global view. A negative number indicates that one view must have its preferred size. If the style is GRID, the sizes string gives the way to arrange sub-actions. The string is something like : " 2 1 | 2 1 || 1 2", where figures give the rowspan and the colspan for each cell of the grid, the | indicates a new cell, the || a new row.  
context no This attribute indicates how the context is managed between the views that compose the global view. FIRST indicates that the first view is the context, SECOND says that the context is given by the second view, NONE that there's no context. FIRST
clientContext no This attribute is used to specify which action of the compound action is contextual (its content depends on of the context). FIRST indicates that the first one is contextual, SECOND means that the second one is contextual, NONE that neither of them is contextual and BOTH that they are both contextual. BOTH is the default value. BOTH
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. false

ELEMENTS

<!ELEMENT COMPOUND_ACTION 
	  (NAME?,
	   ALIAS?,
	   MENU?,
	   GROUP?,
	   PREFIX?,
	   MIN?,
	   MAX?,
	   A_MARKS*,
	   (FILTER | FILTER_REF)?,
	   DATA*,
	   TIP?,
	   SHORTCUT?,
	   GEOMETRY?,
	   PARAMETER_DECL*,
	   PARAMETER*,
	   ACTIONS*,
	   RESOURCE*,
	   (%AN_ACTION; | ACTION_REF),
	   (%AN_ACTION; | ACTION_REF)+)>
Element Mand. Mult. Description
NAME no no Name of the compound action.
ALIAS no no Short name of the compound action.
MENU no no Name of the menu in which the action is added.
GROUP no no Name of the group to which the compound action belongs.
PREFIX no no Prefix of the names of the files associated to the compound action.
MIN no no Minimum number of selected objects, which is required to authorize the compound action to be executed.
MAX no no Maximum number of selected objects, which is required to authorize the compound 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 compound 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 compound action.
DATA no yes Specific data of the compound action.
TIP no no Help on the compound action.
SHORTCUT no no Key shortcut for executing the compound action.
GEOMETRY no no Geometry of the compound 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 compound action.
RESOURCE no yes Resources of the compound action.
AN_ACTION
yes no Define the first action that compose the current compound action.
ACTION_REF yes no Define the first action that compose the current compound action.
AN_ACTION
yes no Define the second action that compose the current compound action.
ACTION_REF yes no Define the second action that compose the current compound action.

SAMPLE 1

<COMPOUND_ACTION id="treeTablePort" sizes="30 70">
	<NAME value="Tree + Table"/>
	<GROUP value="TAB_NETWORK"/>
	<PREFIX value="network"/>
	<ACTION_REF idref="treeNetwork"/>
	<ACTION_REF idref="_table" class="portClass"/>
</COMPOUND_ACTION>

SAMPLE 2

<COMPOUND_ACTION id="threeTables" sizes="30 70" style='VERTICAL'>
	<NAME value="Triple liste"/>
	<GROUP value="TAB_NETWORK"/>
	<PREFIX value="network"/>
	<ACTION_REF idref="_table" class="muxClass"/>
	<COMPOUND_ACTION id="twoTables" sizes="50 50" style='VERTICAL'>
		<ACTION_REF idref="_table" class="cardClass"/>
		<ACTION_REF idref="_table" class="portClass"/>
	</COMPOUND_ACTION>
</COMPOUND_ACTION>