Scout/HowTo/3.7/Add an icon

Scout

Wiki Home

Website

Download • Git

Community

Forums • Blog • Twitter • G+

Bugzilla

Bugzilla

Add the icon file to the project

In the client Plug-In (e.g. tutorialMiniCrm.client.tutorialMiniCrm) add the icon file to the resources/icons folder.

Scout supports many different picture formats. You can use a PNG file that has a size of 16*16 pixels.

Link your file to your application

Open the Icons class in the shared (e.g. tutorialMiniCrm.shared.tutorialMiniCrm.Icons) and add a new line like this:

public static final String UserHome ="home_red";

• Name of the constant is the name that you will use in your application. (e.g. UserHome)
• Value is the name of your file without the extension. (e.g. home_red.png)

Use your icon

When you need to provide an Icon you can now use the Icons class. For example:

@Override
protected String getConfiguredIconId(){
  return Icons.UserHome;
 }

With the appropriate import:

import tutorialMiniCrm.shared.tutorialMiniCrm.Icons;

Of course the new icon is listed in the icon editor in the Scout SDK (Explorer View: Project > Shared > Icons, Object Properties View: Open icons editor).

It is also available in the icon chooser field in order to configure quickly your GUI.

Sub-icons

Eclipse Scout supports sub-icons for some states. Sub-icons are defined with their suffix:

• _open: for expanded / collapsed node-state (for example for pages in the page tree).
• _mouse_over or _rollover: for hoover effect on buttons (e.g. ToolButton)
• _active or _pressed or _selected: for pressed-state on buttons (e.g. ToolButton with toggle action)
• _disabled: for disabled icons

If no such icons are provided for the given state, the fallback icon without suffix is used instead. For disabled state, the icon is simply greyed out if missing.