com.mindgene.d20.common.map

Class GenericMapConsoleView

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.mindgene.d20.common.map.GenericMapConsoleView

All Implemented Interfaces:

com.sengent.common.control.CanBeCancelled, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public abstract class GenericMapConsoleView
extends javax.swing.JPanel
implements com.sengent.common.control.CanBeCancelled

GUI surrounding GenericMapView and provides navigation and toolbar controls.

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JPanel.AccessibleJPanel

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

Modifier	Constructor and Description
protected	GenericMapConsoleView(com.mindgene.d20.common.AbstractApp app)

Method Summary

Modifier and Type	Method and Description
com.mindgene.d20.common.AbstractApp	accessApp()
com.mindgene.d20.common.map.instrument.MapInstrument_Abstract	accessCurrentInstrument()
com.mindgene.d20.common.map.instrument.MapInstrument_Default	accessDefaultInstrument()
GenericMapModel	accessGenericMapModel()
GenericMapView	accessGenericMapView()
void	allowInstruments()
void	assignDefaultInstrument()
void	assignInstrument(com.mindgene.d20.common.map.instrument.MapInstrument_Default instrument)
void	assignMapPlusState(GenericMapModel map, GenericMapViewState state)
void	assignMapTransfer(java.util.List<AbstractCreatureInPlay> targets) helper function for feature library behaviors which teleport targets -- not fully implemented yet.
protected javax.swing.JComponent	buildContent_ConsoleButtons_East_Additional()
protected abstract GenericMapView	buildContent_MapView(com.mindgene.d20.common.AbstractApp app)
protected void	buildContent()
protected abstract com.mindgene.d20.common.map.instrument.MapInstrument_Default	buildDefaultMapInstrument()
void	cancelInstrument() Send cancel command to current instrument.
void	centerOver(java.awt.Point target)
void	discardMapPlusState(javax.swing.JComponent blankness) Triggers the discard event and notifies listeners.
void	dismissCurrentInstrument(com.mindgene.d20.common.map.instrument.MapInstrument_Default instrument)
int	getCornerInset()
static java.awt.Dimension	getSizeCornerButtonIcon()
boolean	hasMap()
void	initInstruments()
boolean	interceptKeystroke(java.awt.event.KeyEvent ke)
boolean	isCurrentInstrumentDefault()
boolean	isInstrumentCurrent(com.mindgene.d20.common.map.instrument.MapInstrument_Default instrument)
protected boolean	isRulerModeActive() Indicates if the Ruler Model toggle button is pressed.
protected void	leaveRulerMode() Cause the Ruler toggle button to be deselected.
protected abstract void	recognizeMap(GenericMapModel map)
protected abstract void	recognizeMapState(GenericMapViewState state) Concrete class must take appropriate action for the new map state.
void	refocusMap(java.awt.Point focus) Refocus but stay at current zoom level.
void	refocusMap(java.awt.Point focus, int zoomLevel)
void	setCornerInset(int inset)
void	signalCancel(java.lang.String reason) Deprecated.
void	updateMapDependentGumps()
void	zoomIn()
void	zoomOut()
void	zoomToScale(double x, double y, double diagonal) method to zoom the map to the closest zoom level equivalent to a dot-per-inch physical resolution.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, 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, paintBorder, 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, 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, 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

GenericMapConsoleView

protected GenericMapConsoleView(com.mindgene.d20.common.AbstractApp app)

Method Detail

initInstruments

public final void initInstruments()

buildDefaultMapInstrument

protected abstract com.mindgene.d20.common.map.instrument.MapInstrument_Default buildDefaultMapInstrument()

assignDefaultInstrument

public void assignDefaultInstrument()

assignMapTransfer

public void assignMapTransfer(java.util.List<AbstractCreatureInPlay> targets)

helper function for feature library behaviors which teleport targets -- not fully implemented yet.

Parameters:

targets -

assignInstrument

public void assignInstrument(com.mindgene.d20.common.map.instrument.MapInstrument_Default instrument)

allowInstruments

public void allowInstruments()

dismissCurrentInstrument

public void dismissCurrentInstrument(com.mindgene.d20.common.map.instrument.MapInstrument_Default instrument)

cancelInstrument

public void cancelInstrument()

Send cancel command to current instrument.

accessDefaultInstrument

public com.mindgene.d20.common.map.instrument.MapInstrument_Default accessDefaultInstrument()

accessCurrentInstrument

public com.mindgene.d20.common.map.instrument.MapInstrument_Abstract accessCurrentInstrument()

isCurrentInstrumentDefault

public boolean isCurrentInstrumentDefault()

interceptKeystroke

public boolean interceptKeystroke(java.awt.event.KeyEvent ke)

isInstrumentCurrent

public boolean isInstrumentCurrent(com.mindgene.d20.common.map.instrument.MapInstrument_Default instrument)

signalCancel

@Deprecated
public void signalCancel(java.lang.String reason)

Deprecated.

Pass cancel command in to the current mouser. If the current mouser does not implement CanBeCancelled, replace the current mouser with the default mouser.

Specified by:

signalCancel in interface com.sengent.common.control.CanBeCancelled

Parameters:

reason -

buildContent_MapView

protected abstract GenericMapView buildContent_MapView(com.mindgene.d20.common.AbstractApp app)

buildContent

protected void buildContent()

buildContent_ConsoleButtons_East_Additional

protected javax.swing.JComponent buildContent_ConsoleButtons_East_Additional()

isRulerModeActive

protected boolean isRulerModeActive()

Indicates if the Ruler Model toggle button is pressed.

Returns:

leaveRulerMode

protected void leaveRulerMode()

Cause the Ruler toggle button to be deselected.

getSizeCornerButtonIcon

public static java.awt.Dimension getSizeCornerButtonIcon()

recognizeMapState

protected abstract void recognizeMapState(GenericMapViewState state)

Concrete class must take appropriate action for the new map state.

Parameters:

state -

recognizeMap

protected abstract void recognizeMap(GenericMapModel map)

centerOver

public void centerOver(java.awt.Point target)

refocusMap

public void refocusMap(java.awt.Point focus)

Refocus but stay at current zoom level.

Parameters:

focus -

refocusMap

public void refocusMap(java.awt.Point focus,
                       int zoomLevel)

Parameters:

focus - the new focus or null to leave unchanged

zoomLevel - the zoom or -1 to leave unchanged

assignMapPlusState

public void assignMapPlusState(GenericMapModel map,
                               GenericMapViewState state)

updateMapDependentGumps

public void updateMapDependentGumps()

discardMapPlusState

public void discardMapPlusState(javax.swing.JComponent blankness)

Triggers the discard event and notifies listeners.

zoomIn

public void zoomIn()

zoomOut

public void zoomOut()

zoomToScale

public void zoomToScale(double x,
                        double y,
                        double diagonal)

method to zoom the map to the closest zoom level equivalent to a dot-per-inch physical resolution.

Parameters:

x - - horizontal screen resolution in pixels

y - - vertical screen resolution in pixels

diagonal - - diagonal size in inches

hasMap

public boolean hasMap()

accessGenericMapModel

public GenericMapModel accessGenericMapModel()

accessGenericMapView

public GenericMapView accessGenericMapView()

accessApp

public com.mindgene.d20.common.AbstractApp accessApp()

getCornerInset

public int getCornerInset()

setCornerInset

public void setCornerInset(int inset)