ilog.views.maps.beans
Class IlvJOverview

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              ilog.views.maps.beans.IlvJOverview

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable

public class IlvJOverview
extends JComponent

This class defines a Swing component that shows an overview of a map displayed in a target IlvManagerView. Technically, the components contain an IlvJManagerView that has an IlvManagerMagViewInteractor. It has been packaged as a Java Bean so that map overviews can be very easily specified in a JAVA development environment supporting visual programming with Beans.

See Also:

IlvManagerMagViewInteractor, Serialized Form

Nested Class Summary

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.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

static String

MAPS_OVERVIEW_VIEW_NAME The name selected for all IlvManagerView used as an overview.

Fields inherited from class javax.swing.JComponent

accessibleContext, 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

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

IlvJOverview()
Creates a new IlvJOverview.

Method Summary

int	getDrawingStyle() Returns the way the control rectangle is drawn.
IlvManagerMagViewInteractor	getInteractor() Returns the instance of IlvManagerMagViewInteractor used by this overview.
int	getLineWidth() Returns the width of the lines when the drawing style is set to Line.
IlvManagerView	getOverviewView() Returns the view of the overview object.
int	getResizeHandleSize() Gets the size of the resizing handles.
IlvManagerView	getView() Returns the target view of the overview.
boolean	isAutoTranslating() Returns the Auto Translating mode status.
boolean	isAutoZoomConstrained() Returns whether Auto Zoom mode is constrained or not.
boolean	isAutoZooming() Returns the Auto Zooming mode.
boolean	isBoundedByView() Returns whether the control rectangle can be moved outside of the view.
boolean	isResizingAllowed() Returns whether the ability to resize the control rectangle is set.
void	resetOverview() Resets the overview so that the rectangle representing the part of the map that is visible in the target view appears in the center of the overview.
void	setAutoTranslating(boolean set) Enables/disables Auto Translating mode.
void	setAutoZoomConstrained(boolean set) Constraints the Auto Zoom mode.
void	setAutoZooming(boolean set) Enables/disables Auto Zoom mode.
void	setBoundedByView(boolean set) Sets Bounded by View mode.
void	setDrawingStyle(int style) Sets the way the control rectangle is drawn.
void	setInteractor(IlvManagerMagViewInteractor interactor) Set a customized subclass of IlvManagerMagViewInteractor as the interactor for this overview pane.
void	setLineWidth(int width) Sets the width of the line when the drawing style is set to Line.
void	setResizeHandleSize(int size) Sets the size of the resizing handles.
void	setResizingAllowed(boolean allowed) Sets whether the ability to resize the control rectangle is set.
void	setView(IlvManagerView view) Sets the target view of the overview.

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, 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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, 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, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, 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, setLayout, transferFocusBackward, 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, hide, 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, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

MAPS_OVERVIEW_VIEW_NAME

public static final String MAPS_OVERVIEW_VIEW_NAME

The name selected for all IlvManagerView used as an overview.

Since:

JViews 7.5

See Also:

Constant Field Values

Constructor Detail

IlvJOverview

public IlvJOverview()

Creates a new IlvJOverview. The overview is not active until a target view has been specified.

See Also:

setView(ilog.views.IlvManagerView)

Method Detail

setInteractor

public void setInteractor(IlvManagerMagViewInteractor interactor)

Set a customized subclass of IlvManagerMagViewInteractor as the interactor for this overview pane.

An IlvManagerMagViewInteractor instance set on this overview window, draws a rectangle that shows the visible area of the manager in the main window. The visible area of the main window is changed when the rectangle drawn by the interactor in the overview window is moved.

Parameters:

interactor - The IlvManagerMagViewInteractor

Since:

JViews 6.0

getInteractor

public IlvManagerMagViewInteractor getInteractor()

Returns the instance of IlvManagerMagViewInteractor used by this overview.

setAutoTranslating

public void setAutoTranslating(boolean set)

Enables/disables Auto Translating mode.

See Also:

IlvManagerMagViewInteractor.setAutoTranslating(boolean)

isAutoTranslating

public boolean isAutoTranslating()

Returns the Auto Translating mode status.

See Also:

IlvManagerMagViewInteractor.isAutoTranslating()

setAutoZoomConstrained

public void setAutoZoomConstrained(boolean set)

Constraints the Auto Zoom mode.

See Also:

IlvManagerMagViewInteractor.setAutoZoomConstrained(boolean)

isAutoZoomConstrained

public boolean isAutoZoomConstrained()

Returns whether Auto Zoom mode is constrained or not.

See Also:

IlvManagerMagViewInteractor.isAutoZoomConstrained()

setAutoZooming

public void setAutoZooming(boolean set)

Enables/disables Auto Zoom mode.

See Also:

IlvManagerMagViewInteractor.setAutoZooming(boolean)

isAutoZooming

public boolean isAutoZooming()

Returns the Auto Zooming mode.

See Also:

IlvManagerMagViewInteractor.isAutoZooming()

setBoundedByView

public void setBoundedByView(boolean set)

Sets Bounded by View mode. When this mode is set, the control rectangle cannot be moved outside of the view.

See Also:

IlvManagerMagViewInteractor.setBoundedByView(boolean)

isBoundedByView

public boolean isBoundedByView()

Returns whether the control rectangle can be moved outside of the view.

See Also:

IlvManagerMagViewInteractor.isBoundedByView()

setResizingAllowed

public void setResizingAllowed(boolean allowed)

Sets whether the ability to resize the control rectangle is set.

See Also:

IlvManagerMagViewInteractor.setResizingAllowed(boolean)

isResizingAllowed

public boolean isResizingAllowed()

Returns whether the ability to resize the control rectangle is set.

See Also:

IlvManagerMagViewInteractor.isResizingAllowed()

setLineWidth

public void setLineWidth(int width)

Sets the width of the line when the drawing style is set to Line.

See Also:

IlvManagerMagViewInteractor.setLineWidth(int)

getLineWidth

public int getLineWidth()

Returns the width of the lines when the drawing style is set to Line.

See Also:

IlvManagerMagViewInteractor.getLineWidth()

setResizeHandleSize

public void setResizeHandleSize(int size)

Sets the size of the resizing handles.

See Also:

IlvManagerMagViewInteractor.setResizeHandleSize(int)

getResizeHandleSize

public int getResizeHandleSize()

Gets the size of the resizing handles.

See Also:

IlvManagerMagViewInteractor.getResizeHandleSize()

setDrawingStyle

public void setDrawingStyle(int style)

Sets the way the control rectangle is drawn.

See Also:

IlvManagerMagViewInteractor.setDrawingStyle(int)

getDrawingStyle

public int getDrawingStyle()

Returns the way the control rectangle is drawn.

See Also:

IlvManagerMagViewInteractor.getDrawingStyle()

getView

public IlvManagerView getView()

Returns the target view of the overview.

setView

public void setView(IlvManagerView view)

Sets the target view of the overview.

getOverviewView

public IlvManagerView getOverviewView()

Returns the view of the overview object.

Returns:

The view of the overview object.

Since:

JViews 3.5

resetOverview

public void resetOverview()

Resets the overview so that the rectangle representing the part of the map that is visible in the target view appears in the center of the overview.