maps.gml.view

Class GMLMapViewer

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

maps.gml.view.GMLMapViewer

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class GMLMapViewer
extends javax.swing.JComponent

A component for viewing GML maps.

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

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 java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
GMLMapViewer() Create a GMLMapViewer.
GMLMapViewer(GMLMap map) Create a GMLMapViewer.

Method Summary

Modifier and Type	Method and Description
void	addOverlay(Overlay overlay) Add an overlay to the view.
void	clearAllBuildingDecorators() Remove any custom BuildingDecorators.
void	clearAllEdgeDecorators() Remove any custom EdgeDecorators.
void	clearAllNodeDecorators() Remove any custom NodeDecorators.
void	clearAllRoadDecorators() Remove any custom RoadDecorators.
void	clearAllSpaceDecorators() Remove any custom SpaceDecorators.
void	clearBuildingDecorator(java.util.Collection<? extends GMLBuilding> buildings) Remove any custom BuildingDecorator for a set of GMLBuildings.
void	clearBuildingDecorator(GMLBuilding... buildings) Remove any custom BuildingDecorator for a set of GMLBuildings.
void	clearEdgeDecorator(java.util.Collection<? extends GMLEdge> edges) Remove any custom EdgeDecorator for a set of GMLEdges.
void	clearEdgeDecorator(GMLEdge... edges) Remove any custom EdgeDecorator for a set of GMLEdges.
void	clearNodeDecorator(java.util.Collection<? extends GMLNode> nodes) Remove any custom NodeDecorator for a set of GMLNodes.
void	clearNodeDecorator(GMLNode... nodes) Remove any custom NodeDecorator for a set of GMLNodes.
void	clearRoadDecorator(java.util.Collection<? extends GMLRoad> roads) Remove any custom RoadDecorator for a set of GMLRoads.
void	clearRoadDecorator(GMLRoad... roads) Remove any custom RoadDecorator for a set of GMLRoads.
void	clearSpaceDecorator(java.util.Collection<? extends GMLSpace> spaces) Remove any custom SpaceDecorator for a set of GMLSpaces.
void	clearSpaceDecorator(GMLSpace... spaces) Remove any custom SpaceDecorator for a set of GMLSpaces.
BuildingDecorator	getBuildingDecorator(GMLBuilding building) Get the BuildingDecorator for a GMLBuildings.
GMLCoordinates	getCoordinatesAtPoint(int x, int y) Get the coordinates of a point on screen.
BuildingDecorator	getDefaultBuildingDecorator() Get the default building decorator.
EdgeDecorator	getDefaultEdgeDecorator() Get the default edge decorator.
NodeDecorator	getDefaultNodeDecorator() Get the default node decorator.
RoadDecorator	getDefaultRoadDecorator() Get the default road decorator.
SpaceDecorator	getDefaultSpaceDecorator() Get the default space decorator.
EdgeDecorator	getEdgeDecorator(GMLEdge edge) Get the EdgeDecorator for a GMLEdge.
NodeDecorator	getNodeDecorator(GMLNode node) Get the NodeDecorator for a GMLNodes.
PanZoomListener	getPanZoomListener() Get the PanZoomListener for this component.
RoadDecorator	getRoadDecorator(GMLRoad road) Get the RoadDecorator for a GMLRoads.
java.awt.Point	getScreenCoordinates(GMLCoordinates c) Get the on-screen coordinates for a point.
SpaceDecorator	getSpaceDecorator(GMLSpace space) Get the SpaceDecorator for a GMLSpaces.
boolean	isOpaque()
void	paintComponent(java.awt.Graphics graphics)
void	removeOverlay(Overlay overlay) Remove an overlay from the view.
void	setBuildingDecorator(BuildingDecorator decorator, java.util.Collection<? extends GMLBuilding> buildings) Set the BuildingDecorator for a set of GMLBuildings.
void	setBuildingDecorator(BuildingDecorator decorator, GMLBuilding... buildings) Set the BuildingDecorator for a set of GMLBuildings.
void	setDefaultBuildingDecorator(BuildingDecorator defaultDecorator) Set the default building decorator.
void	setDefaultEdgeDecorator(EdgeDecorator defaultDecorator) Set the default edge decorator.
void	setDefaultNodeDecorator(NodeDecorator defaultDecorator) Set the default node decorator.
void	setDefaultRoadDecorator(RoadDecorator defaultDecorator) Set the default road decorator.
void	setDefaultSpaceDecorator(SpaceDecorator defaultDecorator) Set the default space decorator.
void	setEdgeDecorator(EdgeDecorator decorator, java.util.Collection<? extends GMLEdge> edges) Set the EdgeDecorator for a set of GMLEdges.
void	setEdgeDecorator(EdgeDecorator decorator, GMLEdge... edges) Set the EdgeDecorator for a set of GMLEdges.
void	setGridEnabled(boolean b) Set whether to draw the grid or not.
void	setGridResolution(double resolution) Set the grid resolution.
void	setMap(GMLMap map) Set the map.
void	setNodeDecorator(NodeDecorator decorator, java.util.Collection<? extends GMLNode> nodes) Set the NodeDecorator for a set of GMLNodes.
void	setNodeDecorator(NodeDecorator decorator, GMLNode... nodes) Set the NodeDecorator for a set of GMLNodes.
void	setPaintNodes(boolean paintNodes)
void	setPanZoomEnabled(boolean enabled) Enable or disable the pan/zoom feature.
void	setRoadDecorator(RoadDecorator decorator, java.util.Collection<? extends GMLRoad> roads) Set the RoadDecorator for a set of GMLRoads.
void	setRoadDecorator(RoadDecorator decorator, GMLRoad... roads) Set the RoadDecorator for a set of GMLRoads.
void	setSpaceDecorator(SpaceDecorator decorator, java.util.Collection<? extends GMLSpace> spaces) Set the SpaceDecorator for a set of GMLSpaces.
void	setSpaceDecorator(SpaceDecorator decorator, GMLSpace... spaces) Set the SpaceDecorator for a set of GMLSpaces.
void	view(GMLObject... objects) View a particular set of objects.
void	view(java.util.List<? extends GMLObject> objects) View a particular set of objects.
void	viewAll() View all objects.

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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, 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, 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, getAccessibleContext, 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

Constructor Detail

GMLMapViewer

public GMLMapViewer()

Create a GMLMapViewer.

GMLMapViewer

public GMLMapViewer(GMLMap map)

Create a GMLMapViewer.

Parameters:

map - The map to view.

Method Detail

setMap

public void setMap(GMLMap map)

Set the map.

Parameters:

map - The map to view.

view

public void view(GMLObject... objects)

View a particular set of objects.

Parameters:

objects - The objects to view.

view

public void view(java.util.List<? extends GMLObject> objects)

View a particular set of objects.

Parameters:

objects - The objects to view.

viewAll

public void viewAll()

View all objects.

getPanZoomListener

public PanZoomListener getPanZoomListener()

Get the PanZoomListener for this component.

Returns:

The PanZoomListener.

setDefaultNodeDecorator

public void setDefaultNodeDecorator(NodeDecorator defaultDecorator)

Set the default node decorator.

Parameters:

defaultDecorator - The new default node decorator.

getDefaultNodeDecorator

public NodeDecorator getDefaultNodeDecorator()

Get the default node decorator.

Returns:

The default node decorator.

setNodeDecorator

public void setNodeDecorator(NodeDecorator decorator,
                             GMLNode... nodes)

Set the NodeDecorator for a set of GMLNodes.

Parameters:

decorator - The decorator to set.

nodes - The nodes to set the decorator for.

setNodeDecorator

public void setNodeDecorator(NodeDecorator decorator,
                             java.util.Collection<? extends GMLNode> nodes)

Set the NodeDecorator for a set of GMLNodes.

Parameters:

decorator - The decorator to set.

nodes - The nodes to set the decorator for.

getNodeDecorator

public NodeDecorator getNodeDecorator(GMLNode node)

Get the NodeDecorator for a GMLNodes.

Parameters:

node - The node to look up.

Returns:

The NodeDecorator for that node. This will be the default decorator if no custom decorator has been set for that node.

clearNodeDecorator

public void clearNodeDecorator(GMLNode... nodes)

Remove any custom NodeDecorator for a set of GMLNodes.

Parameters:

nodes - The nodes to remove any custom decorator for.

clearNodeDecorator

public void clearNodeDecorator(java.util.Collection<? extends GMLNode> nodes)

Remove any custom NodeDecorator for a set of GMLNodes.

Parameters:

nodes - The nodes to remove any custom decorator for.

clearAllNodeDecorators

public void clearAllNodeDecorators()

Remove any custom NodeDecorators.

setDefaultEdgeDecorator

public void setDefaultEdgeDecorator(EdgeDecorator defaultDecorator)

Set the default edge decorator.

Parameters:

defaultDecorator - The new default edge decorator.

getDefaultEdgeDecorator

public EdgeDecorator getDefaultEdgeDecorator()

Get the default edge decorator.

Returns:

The default edge decorator.

setEdgeDecorator

public void setEdgeDecorator(EdgeDecorator decorator,
                             GMLEdge... edges)

Set the EdgeDecorator for a set of GMLEdges.

Parameters:

decorator - The decorator to set.

edges - The edges to set the decorator for.

setEdgeDecorator

public void setEdgeDecorator(EdgeDecorator decorator,
                             java.util.Collection<? extends GMLEdge> edges)

Set the EdgeDecorator for a set of GMLEdges.

Parameters:

decorator - The decorator to set.

edges - The edges to set the decorator for.

getEdgeDecorator

public EdgeDecorator getEdgeDecorator(GMLEdge edge)

Get the EdgeDecorator for a GMLEdge.

Parameters:

edge - The edge to look up.

Returns:

The EdgeDecorator for that edge. This will be the default decorator if no custom decorator has been set for that edge.

clearEdgeDecorator

public void clearEdgeDecorator(GMLEdge... edges)

Remove any custom EdgeDecorator for a set of GMLEdges.

Parameters:

edges - The edges to remove any custom decorator for.

clearEdgeDecorator

public void clearEdgeDecorator(java.util.Collection<? extends GMLEdge> edges)

Remove any custom EdgeDecorator for a set of GMLEdges.

Parameters:

edges - The edges to remove any custom decorator for.

clearAllEdgeDecorators

public void clearAllEdgeDecorators()

Remove any custom EdgeDecorators.

setDefaultBuildingDecorator

public void setDefaultBuildingDecorator(BuildingDecorator defaultDecorator)

Set the default building decorator.

Parameters:

defaultDecorator - The new default building decorator.

getDefaultBuildingDecorator

public BuildingDecorator getDefaultBuildingDecorator()

Get the default building decorator.

Returns:

The default building decorator.

setBuildingDecorator

public void setBuildingDecorator(BuildingDecorator decorator,
                                 GMLBuilding... buildings)

Set the BuildingDecorator for a set of GMLBuildings.

Parameters:

decorator - The decorator to set.

buildings - The buildings to set the decorator for.

setBuildingDecorator

public void setBuildingDecorator(BuildingDecorator decorator,
                                 java.util.Collection<? extends GMLBuilding> buildings)

Set the BuildingDecorator for a set of GMLBuildings.

Parameters:

decorator - The decorator to set.

buildings - The buildings to set the decorator for.

getBuildingDecorator

public BuildingDecorator getBuildingDecorator(GMLBuilding building)

Get the BuildingDecorator for a GMLBuildings.

Parameters:

building - The building to look up.

Returns:

The BuildingDecorator for that building. This will be the default decorator if no custom decorator has been set for that building.

clearBuildingDecorator

public void clearBuildingDecorator(GMLBuilding... buildings)

Remove any custom BuildingDecorator for a set of GMLBuildings.

Parameters:

buildings - The buildings to remove any custom decorator for.

clearBuildingDecorator

public void clearBuildingDecorator(java.util.Collection<? extends GMLBuilding> buildings)

Remove any custom BuildingDecorator for a set of GMLBuildings.

Parameters:

buildings - The buildings to remove any custom decorator for.

clearAllBuildingDecorators

public void clearAllBuildingDecorators()

Remove any custom BuildingDecorators.

setDefaultRoadDecorator

public void setDefaultRoadDecorator(RoadDecorator defaultDecorator)

Set the default road decorator.

Parameters:

defaultDecorator - The new default road decorator.

getDefaultRoadDecorator

public RoadDecorator getDefaultRoadDecorator()

Get the default road decorator.

Returns:

The default road decorator.

setRoadDecorator

public void setRoadDecorator(RoadDecorator decorator,
                             GMLRoad... roads)

Set the RoadDecorator for a set of GMLRoads.

Parameters:

decorator - The decorator to set.

roads - The roads to set the decorator for.

setRoadDecorator

public void setRoadDecorator(RoadDecorator decorator,
                             java.util.Collection<? extends GMLRoad> roads)

Set the RoadDecorator for a set of GMLRoads.

Parameters:

decorator - The decorator to set.

roads - The roads to set the decorator for.

getRoadDecorator

public RoadDecorator getRoadDecorator(GMLRoad road)

Get the RoadDecorator for a GMLRoads.

Parameters:

road - The road to look up.

Returns:

The RoadDecorator for that road. This will be the default decorator if no custom decorator has been set for that road.

clearRoadDecorator

public void clearRoadDecorator(GMLRoad... roads)

Remove any custom RoadDecorator for a set of GMLRoads.

Parameters:

roads - The roads to remove any custom decorator for.

clearRoadDecorator

public void clearRoadDecorator(java.util.Collection<? extends GMLRoad> roads)

Remove any custom RoadDecorator for a set of GMLRoads.

Parameters:

roads - The roads to remove any custom decorator for.

clearAllRoadDecorators

public void clearAllRoadDecorators()

Remove any custom RoadDecorators.

setDefaultSpaceDecorator

public void setDefaultSpaceDecorator(SpaceDecorator defaultDecorator)

Set the default space decorator.

Parameters:

defaultDecorator - The new default space decorator.

getDefaultSpaceDecorator

public SpaceDecorator getDefaultSpaceDecorator()

Get the default space decorator.

Returns:

The default space decorator.

setSpaceDecorator

public void setSpaceDecorator(SpaceDecorator decorator,
                              GMLSpace... spaces)

Set the SpaceDecorator for a set of GMLSpaces.

Parameters:

decorator - The decorator to set.

spaces - The spaces to set the decorator for.

setSpaceDecorator

public void setSpaceDecorator(SpaceDecorator decorator,
                              java.util.Collection<? extends GMLSpace> spaces)

Set the SpaceDecorator for a set of GMLSpaces.

Parameters:

decorator - The decorator to set.

spaces - The spaces to set the decorator for.

getSpaceDecorator

public SpaceDecorator getSpaceDecorator(GMLSpace space)

Get the SpaceDecorator for a GMLSpaces.

Parameters:

space - The space to look up.

Returns:

The SpaceDecorator for that space. This will be the default decorator if no custom decorator has been set for that space.

clearSpaceDecorator

public void clearSpaceDecorator(GMLSpace... spaces)

Remove any custom SpaceDecorator for a set of GMLSpaces.

Parameters:

spaces - The spaces to remove any custom decorator for.

clearSpaceDecorator

public void clearSpaceDecorator(java.util.Collection<? extends GMLSpace> spaces)

Remove any custom SpaceDecorator for a set of GMLSpaces.

Parameters:

spaces - The spaces to remove any custom decorator for.

clearAllSpaceDecorators

public void clearAllSpaceDecorators()

Remove any custom SpaceDecorators.

setGridEnabled

public void setGridEnabled(boolean b)

Set whether to draw the grid or not.

Parameters:

b - True to draw the grid.

setGridResolution

public void setGridResolution(double resolution)

Set the grid resolution.

Parameters:

resolution - The new grid resolution.

addOverlay

public void addOverlay(Overlay overlay)

Add an overlay to the view.

Parameters:

overlay - The overlay to add.

removeOverlay

public void removeOverlay(Overlay overlay)

Remove an overlay from the view.

Parameters:

overlay - The overlay to remove.

paintComponent

public void paintComponent(java.awt.Graphics graphics)

Overrides:

paintComponent in class javax.swing.JComponent

isOpaque

public boolean isOpaque()

Overrides:

isOpaque in class javax.swing.JComponent

setPanZoomEnabled

public void setPanZoomEnabled(boolean enabled)

Enable or disable the pan/zoom feature.

Parameters:

enabled - Whether pan/zoom should be enabled or not.

getCoordinatesAtPoint

public GMLCoordinates getCoordinatesAtPoint(int x,
                                            int y)

Get the coordinates of a point on screen.

Parameters:

x - The screen x coordinate.

y - The screen y coordinate.

Returns:

The coordinates in the GML map under the screen point.

getScreenCoordinates

public java.awt.Point getScreenCoordinates(GMLCoordinates c)

Get the on-screen coordinates for a point.

Parameters:

c - The GML coordinates to look up.

Returns:

The on-screen coordinates of the point.

setPaintNodes

public void setPaintNodes(boolean paintNodes)