Skip to main content

Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Scout/Concepts/Action"

m (Category changed)
(Replaced content with "The Scout documentation has been moved to https://eclipsescout.github.io/.")
 
Line 1: Line 1:
{{ScoutPage|cat=Component Model}}
+
The Scout documentation has been moved to https://eclipsescout.github.io/.
 
+
Generic type for {{ScoutLink|Concepts|Menu|Menus}} or {{ScoutLink|Concepts|ViewButton|ViewButtons}}
+
 
+
* implements: {{ScoutJavadoc|IAction|I}}
+
* extends: {{ScoutJavadoc|AbstractAction|C}}
+
 
+
== Description ==
+
{{note|TODO|Add a description}}
+
 
+
[[Image:HG Action.png]]
+
* {{ScoutLink|Concepts|KeyStroke}}
+
* {{ScoutLink|Concepts|Menu}}
+
* {{ScoutLink|Concepts|ToolButton}}
+
* {{ScoutLink|Concepts|ViewButton}}
+
 
+
 
+
== Properties ==
+
''Defined with {{ScoutLink|Concepts|GetConfigured Methods|getConfiguredXxxxxx()}} methods''.
+
 
+
=== 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}}
+
 
+
 
+
== Events ==
+
''Defined with {{ScoutLink|Concepts|Exec_Methods|execXxxxxx()}} methods''.
+
 
+
* {{ScoutEvent|InitAction}}
+
* {{ScoutEvent|PrepareAction}}
+
* {{ScoutEvent|Action}}
+
* {{ScoutEvent|ToggleAction}}
+
 
+
 
+
== See Also ==
+
* {{ScoutLink|Concepts|Client Plug-In|Client Plug-In}}
+

Latest revision as of 06:00, 14 March 2024

The Scout documentation has been moved to https://eclipsescout.github.io/.

Back to the top