ilog.views.maps.beans

Class IlvMapAnnotationToolBar

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JToolBar

ilog.views.maps.beans.IlvMapAnnotationToolBar

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, SwingConstants

public class IlvMapAnnotationToolBar
extends JToolBar

A toolbar displaying buttons for creating map annotations. Map annotations are graphic objects that are displayed on a map to provide additional visual information. By default this tool bar displays:

• A polyline button for creating polyline annotations
• A polygon button for creating polygon annotations
• A point button for creating point annotations
• A link button for creating link annotations. This last button will only be available if the grapherMode is true.

These buttons are associated with interactors that create graphic annotations on a map. These annotations can also be labeled.

Since:

JViews 8.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IlvMapAnnotationToolBar.AnnotationGraphic Interface that annotation graphic objects should implement.
static class	IlvMapAnnotationToolBar.MapGraphicPath An IlvMapGraphicPath for annotations.
static class	IlvMapAnnotationToolBar.MapLink An IlvMapCompositeLink with annotation extensions.
static class	IlvMapAnnotationToolBar.MapMarker An IlvMapMarker annotation extension.
static class	IlvMapAnnotationToolBar.MapPolyline An IlvMapPolyline with annotation extensions.
class	IlvMapAnnotationToolBar.ToolBarButton A JToggleButton that can be associated with and trigger an IlvManagerViewInteractor.

Nested classes/interfaces inherited from class javax.swing.JToolBar

JToolBar.AccessibleJToolBar, JToolBar.Separator

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANNOTATION_PROPERTY_NAME The name of the attribute displayed as a label by the annotation.
static String	EXT_ANNOTATION_PROPERTY_NAME The name of the attribute displayed as an extended description by the annotation.
static int	LINK_BUTTON The index of the link annotation button.
static int	POINT_BUTTON The index of the point annotation button.
static int	POLYGON_BUTTON The index of the polygon annotation button.
static int	POLYLINE_BUTTON The index of the polyline annotation button.

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
IlvMapAnnotationToolBar() Creates a new IlvMapAnnotationToolBar with the default set of buttons: A polyline button A polygon button A point button These buttons are associated with interactors that create graphic annotations on a map.

Method Summary

Modifier and Type	Method and Description
void	addAnnotation(IlvGraphic graphic, String label, String description) Adds an annotation graphic into the annotation model.
protected void	addImpl(Component comp, Object constraints, int index)
String	askForString(String old) Called at graphic annotation creation to provide a string to be displayed as the annotation label.
String[]	askForStrings(String defaultLabel, String defaultDescription) Pops a dialog to ask for the label and the extended description.
protected JMenuItem	deleteItem() Creates a menu item that allows you to delete the annotation.
IlvMapAnnotationToolBar.ToolBarButton	getButton(int i) Returns the nth ToolBarButton button of the toolbar.
Dimension	getButtonSize() Retrieves the button size set by setButtonSize().
JPopupMenu	getPopupMenu() Returns the pop-up menu that is displayed for the graphic objects created by this toolbar.
IlvManagerView	getView() Returns the view associated with this annotation toolbar.
boolean	isChecking() Indicates if the point validity is checked or not.
boolean	isGrapherMode() Returns true if the interactors are in grapher mode.
boolean	isPermanent() Returns true if the interactors are permanent.
protected JMenuItem	labelItem() Creates a menu item that allows you to change the label of the annotation.
void	setButtonSize(Dimension buttonSize) Forces the button sizes for the buttons contained by this toolbar.
void	setChecking(boolean check) Requests this toolbar to check if the points entered are valid or not.
void	setGrapherMode(boolean value) Sets the grapher mode value.
void	setPermanent(boolean value) Sets the permanent indicator .
void	setView(IlvManagerView v) Sets the view for this annotation toolbar.
protected JMenuItem	styleItem() Creates a menu item that allows you to change the style of the annotation.

Methods inherited from class javax.swing.JToolBar

add, addSeparator, addSeparator, createActionChangeListener, createActionComponent, getAccessibleContext, getComponentAtIndex, getComponentIndex, getMargin, getOrientation, getUI, getUIClassID, isBorderPainted, isFloatable, isRollover, paintBorder, paramString, setBorderPainted, setFloatable, setLayout, setMargin, setOrientation, setRollover, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

POLYLINE_BUTTON

public static final int POLYLINE_BUTTON

The index of the polyline annotation button.

See Also:

Constant Field Values

POLYGON_BUTTON

public static final int POLYGON_BUTTON

The index of the polygon annotation button.

See Also:

Constant Field Values

POINT_BUTTON

public static final int POINT_BUTTON

The index of the point annotation button.

See Also:

Constant Field Values

LINK_BUTTON

public static final int LINK_BUTTON

The index of the link annotation button.

Since:

JViews 8.5

See Also:

Constant Field Values

ANNOTATION_PROPERTY_NAME

public static String ANNOTATION_PROPERTY_NAME

The name of the attribute displayed as a label by the annotation.

EXT_ANNOTATION_PROPERTY_NAME

public static String EXT_ANNOTATION_PROPERTY_NAME

The name of the attribute displayed as an extended description by the annotation.

Constructor Detail

IlvMapAnnotationToolBar

public IlvMapAnnotationToolBar()

Creates a new IlvMapAnnotationToolBar with the default set of buttons:

• A polyline button
• A polygon button
• A point button

These buttons are associated with interactors that create graphic annotations on a map. These annotations can be labeled.

Method Detail

addAnnotation

public void addAnnotation(IlvGraphic graphic,
                          String label,
                          String description)

Adds an annotation graphic into the annotation model. The following example shows how to create annotations in the view attached to the toolbar:

 IlvMapAnnotationToolBar.MapMarker m=new IlvMapAnnotationToolBar.MapMarker(new IlvPoint(10,10));
 annotationToolbar.addAnnotation(m, "marker", "this is a marker");
 

Parameters:

graphic - Annotation to add into the model and configure. The object should implement the IlvMapAnnotationToolBar.AnnotationGraphic interface.

label - Value of the attribute displayed as a label by the annotation.

description - Value of the attribute displayed as an extended description by the annotation.

Since:

JViews 8.5

askForString

public String askForString(String old)

Called at graphic annotation creation to provide a string to be displayed as the annotation label.

Parameters:

old - The old string value.

Returns:

The new string to be displayed as an annotation label.

askForStrings

public String[] askForStrings(String defaultLabel,
                              String defaultDescription)

Pops a dialog to ask for the label and the extended description. The extended description can be formated HTML.

Parameters:

defaultLabel - A label to fill the label field of the dialog or null

defaultDescription - A description to fill the description field of the dialog or null

Returns:

An array of two strings : The label and the extended description entered by the user.

getButton

public IlvMapAnnotationToolBar.ToolBarButton getButton(int i)

Returns the nth ToolBarButton button of the toolbar.

Parameters:

i - The nth button or null if the index is out of range. You can also retrieve the polyline annotation button by passing IlvMapAnnotationToolBar.POLYLINE_BUTTON as index, the polygon annotation button by passing IlvMapAnnotationToolBar.POLYGON_BUTTON, or the point annotation button by passing IlvMapAnnotationToolBar.POINT_BUTTON.

Returns:

The requested button or null if the given index is out of range or if the component is not a ToolBarButton.

getButtonSize

public Dimension getButtonSize()

Retrieves the button size set by setButtonSize().

Returns:

The button size set by setButtonSize().

getPopupMenu

public JPopupMenu getPopupMenu()

Returns the pop-up menu that is displayed for the graphic objects created by this toolbar. This implementation returns a JPopupMenu allowing you to change the value attribute of the IlvGraphic, to delete the annotation, and to change/add a new style.

Returns:

The pop-up menu that is displayed for the graphic objects created by this toolbar.

getView

public IlvManagerView getView()

Returns the view associated with this annotation toolbar.

Returns:

The view associated with this annotation toolbar.

isChecking

public boolean isChecking()

Indicates if the point validity is checked or not.

Returns:

If set to true checking is performed, false otherwise.

setButtonSize

public void setButtonSize(Dimension buttonSize)

Forces the button sizes for the buttons contained by this toolbar.

Parameters:

buttonSize - The forced button size.

setChecking

public void setChecking(boolean check)

Requests this toolbar to check if the points entered are valid or not.

Parameters:

check - If set to true checking is performed, false otherwise.

setGrapherMode

public void setGrapherMode(boolean value)

Sets the grapher mode value. If true, created objects will be added to the grapher of the attached view with IlvGrapher.addNode(IlvGraphic, boolean) method. If false, they will be added with IlvManager.addObject(IlvGraphic, boolean).

Parameters:

value - The value to be set.

Since:

JViews 8.5

See Also:

isGrapherMode()

isGrapherMode

public boolean isGrapherMode()

Returns true if the interactors are in grapher mode.

Returns:

true if the interactors are in grapher mode. The default is false.

Since:

JViews 8.5

See Also:

setGrapherMode(boolean)

setPermanent

public void setPermanent(boolean value)

Sets the permanent indicator . If true, the toolbar interactors will be permanent.

Parameters:

value - The value to be set.

Since:

JViews 8.5

See Also:

isPermanent()

isPermanent

public boolean isPermanent()

Returns true if the interactors are permanent.

Returns:

true if the interactors are permanent. The default is false.

Since:

JViews 8.5

See Also:

setPermanent(boolean)

setView

public void setView(IlvManagerView v)

Sets the view for this annotation toolbar.

Parameters:

v - The view to be associated with this annotation toolbar.

addImpl

protected void addImpl(Component comp,
                       Object constraints,
                       int index)

Overrides:

addImpl in class JToolBar

deleteItem

protected JMenuItem deleteItem()

Creates a menu item that allows you to delete the annotation.

Returns:

The delete item menu.

labelItem

protected JMenuItem labelItem()

Creates a menu item that allows you to change the label of the annotation.

Returns:

The label item menu.

styleItem

protected JMenuItem styleItem()

Creates a menu item that allows you to change the style of the annotation.

Returns:

The style item menu.