echopointng
Class ImageMap

java.lang.Object
  nextapp.echo2.app.Component
      echopointng.ComponentEx
          echopointng.AbleComponent
              echopointng.ImageMap

All Implemented Interfaces:

AccessKeyable, Attributeable, Borderable, Delegateable, Heightable, Insetable, MouseCursorable, Sizeable, ToolTipable, Widthable, java.io.Serializable, RenderIdSupport

public class ImageMap
extends AbleComponent

The ImageMap class provides a Component that allows a user to click on region within a provided region.
A series of ImageMap.Coords are provided that indicate what areas on the region should produce an ActionEvent.
This ImageMap.Coords are stored in a map keyed by by their ActionCommand String. This means that their can be at most one set of coordinates for a given ActionCommand.

See Also:

Serialized Form

Nested Class Summary

static class

ImageMap.Coords The Coords object is a set of co-ordinates and an ActionCommand String.

Field Summary

static Style	DEFAULT_STYLE
static java.lang.String	PROPERTY_IMAGE Property Change Names

Fields inherited from class echopointng.ComponentEx

PROPERTY_HIDDEN

Fields inherited from class nextapp.echo2.app.Component

CHILDREN_CHANGED_PROPERTY, ENABLED_CHANGED_PROPERTY, FOCUS_TRAVERSAL_INDEX_CHANGED_PROPERTY, FOCUS_TRAVERSAL_PARTICIPANT_CHANGED_PROPERTY, LAYOUT_DIRECTION_CHANGED_PROPERTY, LOCALE_CHANGED_PROPERTY, PROPERTY_BACKGROUND, PROPERTY_FONT, PROPERTY_FOREGROUND, PROPERTY_LAYOUT_DATA, STYLE_CHANGED_PROPERTY, STYLE_NAME_CHANGED_PROPERTY, VISIBLE_CHANGED_PROPERTY

Fields inherited from interface echopointng.able.AccessKeyable

PROPERTY_ACCESS_KEY

Fields inherited from interface echopointng.able.Borderable

PROPERTY_BORDER

Fields inherited from interface echopointng.able.MouseCursorable

CURSOR_AUTO, CURSOR_CROSSHAIR, CURSOR_CUSTOM_URI, CURSOR_DEFAULT, CURSOR_E_RESIZE, CURSOR_HELP, CURSOR_MOVE, CURSOR_N_RESIZE, CURSOR_NE_RESIZE, CURSOR_NW_RESIZE, CURSOR_POINTER, CURSOR_S_RESIZE, CURSOR_SE_RESIZE, CURSOR_SW_RESIZE, CURSOR_TEXT, CURSOR_W_RESIZE, CURSOR_WAIT, PROPERTY_MOUSE_CURSOR, PROPERTY_MOUSE_CURSOR_URI

Fields inherited from interface echopointng.able.Insetable

DEFAULT_INSETS, DEFAULT_OUTSETS, PROPERTY_INSETS, PROPERTY_OUTSETS

Fields inherited from interface echopointng.able.Widthable

PROPERTY_WIDTH

Fields inherited from interface echopointng.able.Heightable

PROPERTY_HEIGHT

Fields inherited from interface echopointng.able.ToolTipable

PROPERTY_TOOL_TIP_TEXT

Constructor Summary

ImageMap()
Constructs a ImageMap with nothing in it

ImageMap(ImageReference image)
Constructs an ImageMap using the provided image.

Method Summary

void	addActionListener(ActionListener l) Adds an ActionListener.
void	addCoord(ImageMap.Coords coord) Adds a set of co-ordinate's to the ImageMap
void	addCoord(ImageMap.Coords coord, java.lang.String actionCommand) Adds a set of co-ordinate's to the ImageMap and sets the co-ordinate's action command at the same time.
void	fireActionPerformed(ActionEvent e) Notifies all listeners that have registered for this event type.
java.util.Set	getCoords() Returns the set of co-ordinates in the ImageMap
ImageReference	getImage()
void	processInput(java.lang.String inputName, java.lang.Object inputValue) Processes client input specific to the Component received from the UpdateManager.
void	removeActionListener(ActionListener l) Removes an ActionListener.
void	setImage(ImageReference newValue) Sets the ImageReference of the ImageMap.

Methods inherited from class echopointng.AbleComponent

getAccessKey, getBorder, getHeight, getInsets, getMouseCursor, getMouseCursorURI, getOutsets, getToolTipText, getWidth, setAccessKey, setBorder, setHeight, setInsets, setMouseCursor, setMouseCursorURI, setOutsets, setToolTipText, setWidth

Methods inherited from class echopointng.ComponentEx

getAttribute, getAttributeNames, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, isHidden, setAttribute, setHidden, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty

Methods inherited from class nextapp.echo2.app.Component

add, add, addPropertyChangeListener, dispose, firePropertyChange, getApplicationInstance, getBackground, getComponent, getComponent, getComponentCount, getComponents, getEventListenerList, getFocusTraversalIndex, getFont, getForeground, getId, getIndexedProperty, getLayoutData, getLayoutDirection, getLocale, getParent, getProperty, getRenderId, getRenderIndexedProperty, getRenderIndexedProperty, getRenderLayoutDirection, getRenderLocale, getRenderProperty, getRenderProperty, getStyle, getStyleName, getVisibleComponent, getVisibleComponentCount, getVisibleComponents, hasEventListenerList, indexOf, init, isAncestorOf, isEnabled, isFocusTraversalParticipant, isRegistered, isRenderEnabled, isRenderVisible, isValidChild, isValidParent, isVisible, remove, remove, removeAll, removePropertyChangeListener, setBackground, setEnabled, setFocusTraversalIndex, setFocusTraversalParticipant, setFont, setForeground, setId, setIndexedProperty, setLayoutData, setLayoutDirection, setLocale, setProperty, setStyle, setStyleName, setVisible, validate, verifyInput, visibleIndexOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface echopointng.able.Delegateable

getRenderProperty, getRenderProperty

Methods inherited from interface echopointng.able.Delegateable

getRenderProperty, getRenderProperty

Methods inherited from interface echopointng.able.Delegateable

getRenderProperty, getRenderProperty

Methods inherited from interface echopointng.able.Delegateable

getRenderProperty, getRenderProperty

Methods inherited from interface echopointng.able.Delegateable

getRenderProperty, getRenderProperty

Methods inherited from interface echopointng.able.Delegateable

getRenderProperty, getRenderProperty

Field Detail

PROPERTY_IMAGE

public static final java.lang.String PROPERTY_IMAGE

Property Change Names

See Also:

Constant Field Values

DEFAULT_STYLE

public static final Style DEFAULT_STYLE

Constructor Detail

ImageMap

public ImageMap()

Constructs a ImageMap with nothing in it

ImageMap

public ImageMap(ImageReference image)

Constructs an ImageMap using the provided image.

Method Detail

addActionListener

public void addActionListener(ActionListener l)

Adds an ActionListener.

Parameters:

l - The ActionListener to be added.

addCoord

public void addCoord(ImageMap.Coords coord)

Adds a set of co-ordinate's to the ImageMap

addCoord

public void addCoord(ImageMap.Coords coord,
                     java.lang.String actionCommand)

Adds a set of co-ordinate's to the ImageMap and sets the co-ordinate's action command at the same time.

processInput

public void processInput(java.lang.String inputName,
                         java.lang.Object inputValue)

Description copied from class: Component

Processes client input specific to the Component received from the UpdateManager. Derivative implementations should take care to invoke super.processInput().

Overrides:

processInput in class Component

Parameters:

inputName - the name of the input

inputValue - the value of the input

See Also:

Component.processInput(java.lang.String, java.lang.Object)

fireActionPerformed

public void fireActionPerformed(ActionEvent e)

Notifies all listeners that have registered for this event type.

Parameters:

e - The ActionEvent to send.

getCoords

public java.util.Set getCoords()

Returns the set of co-ordinates in the ImageMap

getImage

public ImageReference getImage()

Returns:

The ImageReference of the ImageMap.

removeActionListener

public void removeActionListener(ActionListener l)

Removes an ActionListener.

Parameters:

l - The ActionListener to be removed.

setImage

public void setImage(ImageReference newValue)

Sets the ImageReference of the ImageMap.