draw.tools

Class Tools

java.lang.Object

draw.tools.Tools

All Implemented Interfaces:

java.lang.Iterable<PaletteEntry>

public class Tools
extends java.lang.Object
implements java.lang.Iterable<PaletteEntry>

Registry of all tools. Follows Singleton Design pattern. Only one tool is active at a time. The select tool is known in advance and is stored once it is registered.

Method Summary

Modifier and Type	Method and Description
PaletteEntry	getActiveTool() Get active tool.
static Tools	getInstance() Retrieve singleton instance of Tools.
PaletteEntry	getSelectTool() Access the selected tool.
PaletteEntry	getTool(java.lang.String name) Retrieves the desired tool by name.
java.util.Iterator<PaletteEntry>	iterator() Returns list of all registered actions.
void	register(PaletteEntry entry) Register a new entry with the tool repository.
void	setActiveTool(PaletteEntry entry) Set active tool.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getInstance

public static Tools getInstance()

Retrieve singleton instance of Tools.

Returns:

Singleton instance.

getSelectTool

public PaletteEntry getSelectTool()

Access the selected tool. This is a special tool that always exists.

Returns:

Return the (always available) Select action.

getTool

public PaletteEntry getTool(java.lang.String name)

Retrieves the desired tool by name.

Parameters:

name - desired tool

Returns:

PaletteEntry with the give name, should it exist.

setActiveTool

public void setActiveTool(PaletteEntry entry)

Set active tool.

Parameters:

entry - entry to select

Throws:

java.lang.IllegalArgumentException - if no entry already exists to matches entry

getActiveTool

public PaletteEntry getActiveTool()
                           throws java.lang.IllegalStateException

Get active tool.

Returns:

Action associated with the active tool.

Throws:

java.lang.IllegalStateException - if no active tool yet set.

register

public void register(PaletteEntry entry)

Register a new entry with the tool repository. The first added tool becomes the active one. When a tool with name Select.selectName is added, its entry is stored as being the special Select tool.

Parameters:

entry - new entry to be added

Throws:

java.lang.IllegalArgumentException - if entry already exists that matches entry.

iterator

public java.util.Iterator<PaletteEntry> iterator()

Returns list of all registered actions.

Specified by:

iterator in interface java.lang.Iterable<PaletteEntry>