<TOOL> : Action button

Java class : leon.view.LyTool

ROLE

An action button allows executing an action.
In the case where the button contains an area (AREA), this area is displayed in a new window when launching the action.

ATTRIBUTES

<!ATTLIST TOOL
	  id NMTOKEN #REQUIRED
	  template NMTOKEN #IMPLIED
	  label CDATA #REQUIRED
	  tooltip CDATA #IMPLIED
	  overview CDATA #IMPLIED
	  image CDATA #IMPLIED
	  style ( DEFAULT | TOGGLE) "DEFAULT"
	  pressed ( true | false) "false"
	  enabled ( true | false) "true"
	  dialog ( true | false) "false"
	  width NMTOKEN #IMPLIED
	  height NMTOKEN #IMPLIED
	  font CDATA #IMPLIED
	  color CDATA #IMPLIED
	  fontColor CDATA #IMPLIED
	  clickColor CDATA #IMPLIED>
Attribute Mand. Description Default
id yes Identifier of the action button.  
template no TOOL.template  
label yes Text of the action button.  
tooltip no Tooltip associated to the action button.  
overview no Overview label.  
image no Image of the action button.  
style no Style of the tool
The following styles are supported:
DEFAULT The viewer decides the style that will be attributed to the tool.
TOGGLE The tool is a two-state button.
DEFAULT
pressed no Indicates whether the tool is pressed or not (TOGGLE style only). false
enabled no Indicates whether the action button is enabled or disabled (true if is enabled).
Disabled means that no interaction is possible on the corresponding graphical component.
true
dialog no Indicates whether the action launched by the button opens a dialog window or not.
In dialog mode, the text of the action is followed by suspension points.
false
width no Width of the tool in pixels. -1
height no Height of the tool in pixels. -1
font no TOOL.font  
color no TOOL.color  
fontColor no TOOL.fontColor  
clickColor no Color associated to the click action (mobile only)  

ELEMENTS

<!ELEMENT TOOL 
	  ((AREA | POPUP_MENU)?,
	   CONSTRAINT?,
	   DATA*)>
Element Mand. Mult. Description
AREA yes no Area displayed when selecting the tool.
POPUP_MENU yes no Popup menu displayed when selecting the tool.
CONSTRAINT no no Positioning constraints in the including area.
DATA no yes TOOL.DATA

SAMPLE

<!-- Action button opening a dialog window -->
<TOOL id="tool1" label="Button 1" tooltip="This button opens a dialog window"
	image="bouton1.gif" dialog="true"/>

<!-- Action button displaying an area containing a title bar -->
<TOOL id="tool2" label="Button 2" tooltip="This button contains an area"
		image="bouton2.gif">
	<AREA>
		<TITLEBAR leftLabel="Area under the action button"/>
	</AREA>
</TOOL>