org.eclipse.gef.palette
Class MarqueeToolEntry

java.lang.Object
  org.eclipse.gef.palette.PaletteEntry
      org.eclipse.gef.palette.ToolEntry
          org.eclipse.gef.palette.MarqueeToolEntry

public class MarqueeToolEntry

extends ToolEntry

A palette ToolEntry for a MarqueeSelectionTool.

Since:

2.1

Field Summary

static int	SELECT_CONNECTIONS For marquee tools that should select connections
static int	SELECT_NODES For marquee tools that should select nodes.

Fields inherited from class org.eclipse.gef.palette.ToolEntry

PALETTE_TYPE_TOOL

Fields inherited from class org.eclipse.gef.palette.PaletteEntry

listeners, PALETTE_TYPE_UNKNOWN, PERMISSION_FULL_MODIFICATION, PERMISSION_HIDE_ONLY, PERMISSION_LIMITED_MODIFICATION, PERMISSION_NO_MODIFICATION, PROPERTY_DEFAULT, PROPERTY_DESCRIPTION, PROPERTY_LABEL, PROPERTY_LARGE_ICON, PROPERTY_PARENT, PROPERTY_SMALL_ICON, PROPERTY_TYPE, PROPERTY_VISIBLE

Constructor Summary

MarqueeToolEntry()
Creates a new MarqueeToolEntry that can select nodes

MarqueeToolEntry(int type)
Creates a new MarqueeToolEntry of the given type

MarqueeToolEntry(String label)
Constructor for MarqueeToolEntry.

MarqueeToolEntry(String label, String shortDesc)
Constructor for MarqueeToolEntry.

MarqueeToolEntry(String label, String shortDesc, int type)
Constructor

Method Summary

Tool	createTool() Handles the creation of a new Tool.

Methods inherited from class org.eclipse.gef.palette.PaletteEntry

addPropertyChangeListener, getDescription, getId, getLabel, getLargeIcon, getParent, getSmallIcon, getType, getUserModificationPermission, isVisible, removePropertyChangeListener, setDescription, setId, setLabel, setLargeIcon, setParent, setSmallIcon, setType, setUserModificationPermission, setVisible, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SELECT_NODES

public static final int SELECT_NODES

For marquee tools that should select nodes. This is the default type for this tool.

Since:

3.1

See Also:

Constant Field Values

SELECT_CONNECTIONS

public static final int SELECT_CONNECTIONS

For marquee tools that should select connections

Since:

3.1

See Also:

Constant Field Values

Constructor Detail

MarqueeToolEntry

public MarqueeToolEntry()

Creates a new MarqueeToolEntry that can select nodes

MarqueeToolEntry

public MarqueeToolEntry(int type)

Creates a new MarqueeToolEntry of the given type

Parameters:

type - SELECT_NODES and/or SELECT_CONNECTIONS

Since:

3.1

MarqueeToolEntry

public MarqueeToolEntry(String label)

Constructor for MarqueeToolEntry.

Parameters:

label - the label

MarqueeToolEntry

public MarqueeToolEntry(String label,
                        String shortDesc)

Constructor for MarqueeToolEntry.

Parameters:

label - the label

shortDesc - the description (can be null)

MarqueeToolEntry

public MarqueeToolEntry(String label,
                        String shortDesc,
                        int type)

Constructor

Parameters:

label - the label (can be null)

shortDesc - the description (can be null)

type - SELECT_NODES and/or SELECT_CONNECTIONS

Since:

3.1

Method Detail

createTool

public Tool createTool()

Description copied from class: ToolEntry

Handles the creation of a new Tool. Subclasses must implement.

Specified by:

createTool in class ToolEntry

Returns:

the new Tool

See Also:

ToolEntry.createTool()