ilog.views.awt
Class IlvManagerViewControlBar

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Panel
              ilog.views.awt.IlvManagerViewControlBar

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

IltManagerViewControlBar

public class IlvManagerViewControlBar
extends Panel

This class defines a customizable tool bar that contains tools to zoom, unzoom, scroll, fit to contents, or select graphic objects.

This component must be used in an AWT Application. Note that if your application is a Swing application you should use the class IlvJManagerViewControlBar.

Since:

ILOG JViews 3.0

See Also:

Serialized Form

Nested Class Summary

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

Panel.AccessibleAWTPanel

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

IlvManagerViewControlBar()
Creates a default map Control Bar

Method Summary

Image	getFitToContentsIconImage() Returns the icon image of the Fit to contents button.
URL	getFitToContentsIconURL() Returns the URL of the icon image of the Fit to contents button.
Image	getPanIconImage() Returns the icon image of the Pan button.
URL	getPanIconURL() Returns the URL of the icon image of the Pan button.
IlvManagerViewInteractor	getPanInteractor() Returns the interactor for the Pan tool.
Image	getSelectIconImage() Returns the icon image of the Selection button.
URL	getSelectIconURL() Returns the URL of the icon image of the Selection button.
IlvManagerViewInteractor	getSelectInteractor() Returns the interactor for the Selection tool.
IlvManagerView	getView() Returns the view associated with this control bar.
float	getZoomInFactor() Returns the zoom-in factor currently in use.
Image	getZoomInIconImage() Returns the icon image of the Zoom in button.
URL	getZoomInIconURL() Returns the URL of the icon image of the Zoom in button.
float	getZoomOutFactor() Returns the zoom out factor currently in use.
Image	getZoomOutIconImage() Returns the icon image of the Zoom out button.
URL	getZoomOutIconURL() Returns the URL of the icon image of the Zoom out button.
Image	getZoomViewIconImage() Returns the icon image of the Zoom view button.
URL	getZoomViewIconURL() Returns the URL of the icon image of the Zoom view button.
IlvManagerViewInteractor	getZoomViewInteractor() Returns the zoom view interactor currently in use.
boolean	isFitToContentsButtonAvailable() Returns true if the show all tool is available.
boolean	isPanButtonAvailable() Returns true if Pan tool is available.
boolean	isSelectButtonAvailable() Returns true if the Selection tool is available.
boolean	isZoomInButtonAvailable() Returns true if the Zoom in tool is available.
boolean	isZoomOutButtonAvailable() Returns true if the Zoom out button is available.
boolean	isZoomViewButtonAvailable() Returns true if Zoom view tool is available.
void	setFitToContentsButtonAvailable(boolean available) Specifies whether the Fit to contents tool is available.
void	setFitToContentsIconImage(Image icon) Specifies the icon image of the Fit to contents button.
void	setFitToContentsIconURL(URL iconURL) Specifies the icon image of the Fit to contents button.
void	setPanButtonAvailable(boolean available) Specifies whether the Pan tool is available.
void	setPanIconImage(Image icon) Specifies the icon image of the Pan button.
void	setPanIconURL(URL iconURL) Specifies the icon image of the Pan button.
void	setPanInteractor(IlvManagerViewInteractor interactor) Changes the interactor for the Pan tool.
void	setSelectButtonAvailable(boolean available) Specifies whether the Selection tool is available.
void	setSelectIconImage(Image icon) Specifies the icon image of the Selection button.
void	setSelectIconURL(URL iconURL) Specifies the icon image of the Selection button.
void	setSelectInteractor(IlvManagerViewInteractor interactor) Sets the interactor for the Selection tool.
void	setView(IlvManagerView view) Sets the view for this control bar.
void	setZoomInButtonAvailable(boolean available) Specifies whether the Zoom In tool is available.
void	setZoomInFactor(float factor) Changes the zoom in factor.
void	setZoomInIconImage(Image icon) Specifies the icon image of the Zoom in button.
void	setZoomInIconURL(URL iconURL) Specifies the icon image of the Zoom in button.
void	setZoomOutButtonAvailable(boolean available) Specifies whether the Zoom out tool is available.
void	setZoomOutFactor(float factor) Changes the zoom out factor.
void	setZoomOutIconImage(Image icon) Specifies the icon image of the Zoom out button.
void	setZoomOutIconURL(URL iconURL) Specifies the icon image of the Zoom out button.
void	setZoomViewButtonAvailable(boolean available) Specifies whether the Zoom view tool is available.
void	setZoomViewIconImage(Image icon) Specifies the icon image of the Zoom view button.
void	setZoomViewIconURL(URL iconURL) Specifies the icon image of the Zoom view button.
void	setZoomViewInteractor(IlvManagerViewInteractor interactor) Changes the zoom view interactor.

Methods inherited from class java.awt.Panel

addNotify, getAccessibleContext

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, paramString, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, setLayout, transferFocusBackward, transferFocusDownCycle, update, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvManagerViewControlBar

public IlvManagerViewControlBar()

Creates a default map Control Bar

Method Detail

setPanButtonAvailable

public void setPanButtonAvailable(boolean available)

Specifies whether the Pan tool is available.

Parameters:

available - If true, the Pan tool is available.

isPanButtonAvailable

public boolean isPanButtonAvailable()

Returns true if Pan tool is available.

setPanIconURL

public void setPanIconURL(URL iconURL)

Specifies the icon image of the Pan button.

Since:

JViews 8.0

getPanIconURL

public URL getPanIconURL()

Returns the URL of the icon image of the Pan button. This may return null if the icon was set using setPanIconImage(java.awt.Image) instead of setPanIconURL(java.net.URL).

Since:

JViews 8.0

setPanIconImage

public void setPanIconImage(Image icon)

Specifies the icon image of the Pan button.

Since:

JViews 8.0

getPanIconImage

public Image getPanIconImage()

Returns the icon image of the Pan button.

Since:

JViews 8.0

setPanInteractor

public void setPanInteractor(IlvManagerViewInteractor interactor)

Changes the interactor for the Pan tool.

Parameters:

interactor - The new interactor.

See Also:

IlvPanInteractor

getPanInteractor

public IlvManagerViewInteractor getPanInteractor()

Returns the interactor for the Pan tool.

setSelectButtonAvailable

public void setSelectButtonAvailable(boolean available)

Specifies whether the Selection tool is available.

isSelectButtonAvailable

public boolean isSelectButtonAvailable()

Returns true if the Selection tool is available.

setSelectIconURL

public void setSelectIconURL(URL iconURL)

Specifies the icon image of the Selection button.

Since:

JViews 8.0

getSelectIconURL

public URL getSelectIconURL()

Returns the URL of the icon image of the Selection button. This may return null if the icon was set using setSelectIconImage(java.awt.Image) instead of setSelectIconURL(java.net.URL).

Since:

JViews 8.0

setSelectIconImage

public void setSelectIconImage(Image icon)

Specifies the icon image of the Selection button.

Since:

JViews 8.0

getSelectIconImage

public Image getSelectIconImage()

Returns the icon image of the Selection button.

Since:

JViews 8.0

setSelectInteractor

public void setSelectInteractor(IlvManagerViewInteractor interactor)

Sets the interactor for the Selection tool.

getSelectInteractor

public IlvManagerViewInteractor getSelectInteractor()

Returns the interactor for the Selection tool.

setZoomViewButtonAvailable

public void setZoomViewButtonAvailable(boolean available)

Specifies whether the Zoom view tool is available.

isZoomViewButtonAvailable

public boolean isZoomViewButtonAvailable()

Returns true if Zoom view tool is available.

setZoomViewIconURL

public void setZoomViewIconURL(URL iconURL)

Specifies the icon image of the Zoom view button.

Since:

JViews 8.0

getZoomViewIconURL

public URL getZoomViewIconURL()

Returns the URL of the icon image of the Zoom view button. This may return null if the icon was set using setZoomViewIconImage(java.awt.Image) instead of setZoomViewIconURL(java.net.URL).

Since:

JViews 8.0

setZoomViewIconImage

public void setZoomViewIconImage(Image icon)

Specifies the icon image of the Zoom view button.

Since:

JViews 8.0

getZoomViewIconImage

public Image getZoomViewIconImage()

Returns the icon image of the Zoom view button.

Since:

JViews 8.0

setZoomViewInteractor

public void setZoomViewInteractor(IlvManagerViewInteractor interactor)

Changes the zoom view interactor.

getZoomViewInteractor

public IlvManagerViewInteractor getZoomViewInteractor()

Returns the zoom view interactor currently in use.

setZoomInButtonAvailable

public void setZoomInButtonAvailable(boolean available)

Specifies whether the Zoom In tool is available.

isZoomInButtonAvailable

public boolean isZoomInButtonAvailable()

Returns true if the Zoom in tool is available.

setZoomInIconURL

public void setZoomInIconURL(URL iconURL)

Specifies the icon image of the Zoom in button.

Since:

JViews 8.0

getZoomInIconURL

public URL getZoomInIconURL()

Returns the URL of the icon image of the Zoom in button. This may return null if the icon was set using setZoomInIconImage(java.awt.Image) instead of setZoomInIconURL(java.net.URL).

Since:

JViews 8.0

setZoomInIconImage

public void setZoomInIconImage(Image icon)

Specifies the icon image of the Zoom in button.

Since:

JViews 8.0

getZoomInIconImage

public Image getZoomInIconImage()

Returns the icon image of the Zoom in button.

Since:

JViews 8.0

setZoomInFactor

public void setZoomInFactor(float factor)

Changes the zoom in factor.

getZoomInFactor

public float getZoomInFactor()

Returns the zoom-in factor currently in use.

setZoomOutButtonAvailable

public void setZoomOutButtonAvailable(boolean available)

Specifies whether the Zoom out tool is available.

isZoomOutButtonAvailable

public boolean isZoomOutButtonAvailable()

Returns true if the Zoom out button is available.

setZoomOutIconURL

public void setZoomOutIconURL(URL iconURL)

Specifies the icon image of the Zoom out button.

Since:

JViews 8.0

getZoomOutIconURL

public URL getZoomOutIconURL()

Returns the URL of the icon image of the Zoom out button. This may return null if the icon was set using setZoomOutIconImage(java.awt.Image) instead of setZoomOutIconURL(java.net.URL).

Since:

JViews 8.0

setZoomOutIconImage

public void setZoomOutIconImage(Image icon)

Specifies the icon image of the Zoom out button.

Since:

JViews 8.0

getZoomOutIconImage

public Image getZoomOutIconImage()

Returns the icon image of the Zoom out button.

Since:

JViews 8.0

setZoomOutFactor

public void setZoomOutFactor(float factor)

Changes the zoom out factor.

getZoomOutFactor

public float getZoomOutFactor()

Returns the zoom out factor currently in use.

setFitToContentsButtonAvailable

public void setFitToContentsButtonAvailable(boolean available)

Specifies whether the Fit to contents tool is available.

isFitToContentsButtonAvailable

public boolean isFitToContentsButtonAvailable()

Returns true if the show all tool is available.

setFitToContentsIconURL

public void setFitToContentsIconURL(URL iconURL)

Specifies the icon image of the Fit to contents button.

Since:

JViews 8.0

getFitToContentsIconURL

public URL getFitToContentsIconURL()

Returns the URL of the icon image of the Fit to contents button. This may return null if the icon was set using setFitToContentsIconImage(java.awt.Image) instead of setFitToContentsIconURL(java.net.URL).

Since:

JViews 8.0

setFitToContentsIconImage

public void setFitToContentsIconImage(Image icon)

Specifies the icon image of the Fit to contents button.

Since:

JViews 8.0

getFitToContentsIconImage

public Image getFitToContentsIconImage()

Returns the icon image of the Fit to contents button.

Since:

JViews 8.0

setView

public void setView(IlvManagerView view)

Sets the view for this control bar.

getView

public IlvManagerView getView()

Returns the view associated with this control bar.