com.leafdigital.ui.api
Interface SimpleTool

All Superinterfaces:
Tool

public interface SimpleTool
extends Tool

A tool that's just a button.


Method Summary
 void clicked()
          Called when tool is clicked.
 java.lang.String getLabel()
           
 java.lang.String getThemeType()
          Obtains theme type.
 
Methods inherited from interface com.leafdigital.ui.api.Tool
getDefaultPosition, removed
 

Method Detail

getLabel

java.lang.String getLabel()
Returns:
Text label for tool button

getThemeType

java.lang.String getThemeType()
Obtains theme type. Used for tool information. Also used for default filename - three images should be provided in the same folder as the implementing class, called themeType.normal.png, themeType.hover.png, and themeType.pressed.png.

Returns:
Theme type string

clicked

void clicked()
             throws GeneralException
Called when tool is clicked.

Throws:
GeneralException - Any error


Copyright © 2011 Samuel Marshall. All rights reserved.