Skip to main content
Jump to: navigation, search

Difference between revisions of "Scout/Concepts/Action"

(Description: + HG)
Line 10: Line 10:
  
 
[[Image:HG Action.png]]
 
[[Image:HG Action.png]]
 
+
* {{ScoutLink|Concepts|KeyStroke}}
== Screenshot ==
+
* {{ScoutLink|Concepts|Menu}}
{{note|TODO|Add a screenshot (or remove this section, if there is no screenshot to make)}}
+
* {{ScoutLink|Concepts|ToolButton}}
 +
* {{ScoutLink|Concepts|ViewButton}}
  
  
Line 18: Line 19:
 
''Defined with {{ScoutLink|Concepts|GetConfigured Methods|getConfiguredXxxxxx()}} methods''.
 
''Defined with {{ScoutLink|Concepts|GetConfigured Methods|getConfiguredXxxxxx()}} methods''.
  
{{note|TODO|Add a description of important properties. The idea is not to recreate the JavaDoc of the getConfiguredXxxxxx() methods but to provide explanations, best practice, example... Group the properties by domain.}}
+
=== Defining the action ===
 +
Theses properties define the appearance of the action:
 +
* {{ScoutProp|IconId}}
 +
* {{ScoutProp|Text}}
 +
* {{ScoutProp|TooltipText}}
 +
* {{ScoutProp|Separator}}
 +
* {{ScoutProp|KeyStroke}}
 +
* {{ScoutProp|ToggleAction}}
 +
 
 +
=== Defining the state ===
 +
Several properties control the state of the action (e.g. if the action is visible and enabled).
 +
 
 +
Main properties:
 +
* {{ScoutProp|Visible}}
 +
* {{ScoutProp|Enabled}}
 +
 
 +
Considering or not the context when the state is computed:
 +
* {{ScoutProp|InheritAccessibility}}
 +
 
 +
These properties defines where the action is:
 +
* {{ScoutProp|SingleSelectionAction}}
 +
* {{ScoutProp|MultiSelectionAction}}
 +
* {{ScoutProp|EmptySpaceAction}}
 +
* {{ScoutProp|NonSelectionAction}}
  
  
Line 24: Line 48:
 
''Defined with {{ScoutLink|Concepts|Exec_Methods|execXxxxxx()}} methods''.
 
''Defined with {{ScoutLink|Concepts|Exec_Methods|execXxxxxx()}} methods''.
  
{{note|TODO|Add a description of important events. The idea is not to recreate the JavaDoc of the execXxxxxx() methods but to provide explanations, best practice, example... Group the events by domain.}}
+
* {{ScoutEvent|InitAction}}
 +
* {{ScoutEvent|PrepareAction}}
 +
* {{ScoutEvent|Action}}
 +
* {{ScoutEvent|ToggleAction}}
  
  
 
== See Also ==
 
== See Also ==
 
* {{ScoutLink|Concepts|Client Plug-In|Client Plug-In}}
 
* {{ScoutLink|Concepts|Client Plug-In|Client Plug-In}}

Revision as of 14:39, 25 October 2011


Scout
Wiki Home
Website
DownloadGit
Community
ForumsBlogTwitterG+
Bugzilla
Bugzilla


Generic type for Menus or ViewButtons

  • implements: I obj.pngIAction
  • extends: C obj.pngAbstractAction

Description

HG Action.png


Properties

Defined with getConfiguredXxxxxx() methods.

Defining the action

Theses properties define the appearance of the action:

  • IconId
  • Text
  • TooltipText
  • Separator
  • KeyStroke
  • ToggleAction

Defining the state

Several properties control the state of the action (e.g. if the action is visible and enabled).

Main properties:

  • Visible
  • Enabled

Considering or not the context when the state is computed:

  • InheritAccessibility

These properties defines where the action is:

  • SingleSelectionAction
  • MultiSelectionAction
  • EmptySpaceAction
  • NonSelectionAction


Events

Defined with execXxxxxx() methods.

  • InitAction
  • PrepareAction
  • Action
  • ToggleAction


See Also

Back to the top