Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be 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/ToolButton"

(→‎Description)
Line 1: Line 1:
 
{{ScoutPage|cat=Component Model}}
 
{{ScoutPage|cat=Component Model}}
  
−
Special type of {{ScoutLink|Concepts|Action|Action}} that is usually rendered as element of a tool bar.  
+
Special type of {{ScoutLink|Concepts|Action|Action}} that is usually rendered as an element in a tool bar.  
  
 
* implements: {{ScoutJavadoc|IToolButton|I}}
 
* implements: {{ScoutJavadoc|IToolButton|I}}
Line 7: Line 7:
  
 
== Description ==
 
== Description ==
−
{{note|TODO|Add a description}}
+
Tool Button are used to proposed actions in a tool bar of the main windows of an {{ScoutLink|Concepts|Outline based application}}.
−
Tool components are used to group or divide different views. This can be used to build business views on datas or just to structure the application.
+
  
−
* normally appear in the gui on the toolbar.
+
=== FormToolButton ===
−
* with menus ??
+
The form tools buttons are used to open form. Usually these forms are displayed on the right part of the main windows. They can contain some fields to perform searches, or quick access to global functions (bookmarks, task list, action list...)
 +
 
 +
* implements: {{ScoutJavadoc|IFormToolButton<T>|I}}
 +
* extends: {{ScoutJavadoc|AbstractFormToolButton<T>|C}}
 +
 
 +
The generic parameter <T> needs to extend {{ScoutLink|Concepts|Form}}.
  
  
 
== Screenshot ==
 
== Screenshot ==
−
Here an example with the Swing Nimbus look and feel:
+
On the screenshot, you see the ToolButtons (in green) and the FormToolButtons (in red).
 +
 
 +
Swing Nimbus look and feel:
  
 
[[Image:Scout ToolButtons Nimbus.png]]
 
[[Image:Scout ToolButtons Nimbus.png]]
  
  
−
Here an example with the {{ScoutLink|Concepts|Rayo|Swing Rayo}} look and feel:
+
Same example with the {{ScoutLink|Concepts|Rayo|Swing Rayo}} look and feel:
  
 
[[Image:Scout ToolButtons Rayo.png]]
 
[[Image:Scout ToolButtons Rayo.png]]
  
−
== Screenshot ==
+
For the moment the normal ToolButtons are not rendered with the Rayo look and feel.
−
{{note|TODO|Add a screenshot (or remove this section, if there is no screenshot to make)}}
+
 
 +
 
 +
== SDK Support ==
 +
Since the Kepler Release of Eclipse Scout, the SDK provide support for these buttons: A folder is located under the Desktop node:
 +
 
 +
[[Image:ScoutSdk New Tool item.png]]
 +
 
 +
== Example ==
 +
ToolButton:
 +
<source lang="java">
 +
@Order(10.0)
 +
public class DrawLineTool extends AbstractToolButton {
 +
 
 +
  @Override
 +
  protected String getConfiguredIconId() {
 +
    return Icons.DrawLine;
 +
  }
 +
 
 +
  @Override
 +
  protected String getConfiguredText() {
 +
    return TEXTS.get("DrawLine");
 +
  }
 +
 
 +
  @Override
 +
  protected String getConfiguredTooltipText() {
 +
    return TEXTS.get("DrawLineTooltip");
 +
  }
 +
 
 +
  @Override
 +
  protected void execAction() throws ProcessingException {
 +
    MessageBox.showOkMessage(TEXTS.get("DrawLineTitle"), TEXTS.get("DrawLineInfo"), null);
 +
  }
 +
}
 +
</source>
 +
 
 +
FormToolButton:
 +
<source lang="java">
 +
@Order(40.0)
 +
public class GroupFormTool extends AbstractFormToolButton<GroupForm> {
 +
 
 +
  @Override
 +
  protected String getConfiguredIconId() {
 +
    return Icons.Group;
 +
  }
 +
 
 +
  @Override
 +
  protected String getConfiguredText() {
 +
    return TEXTS.get("Group");
 +
  }
  
 +
  @Override
 +
  protected void execAction() throws ProcessingException {
 +
    GroupForm form = new GroupForm();
 +
    decorateForm(form);
 +
    form.startDisplay();
 +
    setForm(form);
 +
  }
 +
}
 +
</source>
  
 
== Properties ==
 
== Properties ==
Line 42: Line 105:
 
== See Also ==
 
== See Also ==
 
* {{ScoutLink|Concepts|Client Plug-In|Client Plug-In}}
 
* {{ScoutLink|Concepts|Client Plug-In|Client Plug-In}}
 +
* {{ScoutLink|Concepts|ViewButton}}

Revision as of 10:46, 2 May 2013

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

Special type of The Scout documentation has been moved to https://eclipsescout.github.io/. that is usually rendered as an element in a tool bar.

Description

Tool Button are used to proposed actions in a tool bar of the main windows of an The Scout documentation has been moved to https://eclipsescout.github.io/..

FormToolButton

The form tools buttons are used to open form. Usually these forms are displayed on the right part of the main windows. They can contain some fields to perform searches, or quick access to global functions (bookmarks, task list, action list...)

The generic parameter <T> needs to extend The Scout documentation has been moved to https://eclipsescout.github.io/..


Screenshot

On the screenshot, you see the ToolButtons (in green) and the FormToolButtons (in red).

Swing Nimbus look and feel:

Scout ToolButtons Nimbus.png


Same example with the The Scout documentation has been moved to https://eclipsescout.github.io/. look and feel:

Scout ToolButtons Rayo.png

For the moment the normal ToolButtons are not rendered with the Rayo look and feel.


SDK Support

Since the Kepler Release of Eclipse Scout, the SDK provide support for these buttons: A folder is located under the Desktop node:

ScoutSdk New Tool item.png

Example

ToolButton: 

@Order(10.0)
public class DrawLineTool extends AbstractToolButton {
 
  @Override
  protected String getConfiguredIconId() {
    return Icons.DrawLine;
  }
 
  @Override
  protected String getConfiguredText() {
    return TEXTS.get("DrawLine");
  }
 
  @Override
  protected String getConfiguredTooltipText() {
    return TEXTS.get("DrawLineTooltip");
  }
 
  @Override
  protected void execAction() throws ProcessingException {
    MessageBox.showOkMessage(TEXTS.get("DrawLineTitle"), TEXTS.get("DrawLineInfo"), null);
  }
}

FormToolButton: 

@Order(40.0)
public class GroupFormTool extends AbstractFormToolButton<GroupForm> {
 
  @Override
  protected String getConfiguredIconId() {
    return Icons.Group;
  }
 
  @Override
  protected String getConfiguredText() {
    return TEXTS.get("Group");
  }
 
  @Override
  protected void execAction() throws ProcessingException {
    GroupForm form = new GroupForm();
    decorateForm(form);
    form.startDisplay();
    setForm(form);
  }
}

Properties

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

Note.png
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.


Events

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

Note.png
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.


See Also

Retrieved from "https://wiki.eclipse.org/index.php?title=Scout/Concepts/ToolButton&oldid=335389"

Back to the top