rle.core.ui
Class PlayPerspectiveBase

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  rle.core.ui.PerspectiveBase
                      rle.core.ui.PlayPerspectiveBase

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, GameContextListener, Perspective, PlayPerspective, PlugIn

Direct Known Subclasses:

SimplePlayPerspective

public class PlayPerspectiveBase
extends PerspectiveBase
implements PlayPerspective

Shows the view while playing the game. This component controls several panels which can be arranged or added to in order to construct the desired display.

 left - at left, under the message panel and above the status panel
 right - at right, under the message panel and above the status panel
 status - along the entire bottom
 message - along the entire top
 camera - occupies central area, bordered by left, status, and message bar
 overlay - normally transparent, sized to cover the entire region below the message
           bar; this can be added to and made visible to show, for example, choice
           menus above the board display.




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



Field Summary

 
Fields inherited from class rle.core.ui.PerspectiveBase
parameters
 
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
PlayPerspectiveBase()



           
 



Method Summary




 void
boardChange(BoardChangeEvent event)



          Respond to a change of board.



 void
clearOverlayPanel()



          Clear the contents of the overlay, if any.



 void
commandSetChange(CommandSetChangeEvent event)



          Respond to a change of CommandSet.



protected  MessageBar
createMessageBar()



           



 Camera
getCamera()



          Return the camera.



 javax.swing.JPanel
getLeftPanel()



          Return the panel that sits to the left of the camera, typically
 displaying stats such as Str and Cur Hp.



 MessageBar
getMessageBar()



           



 javax.swing.JPanel
getOverlayPanel()



          Return the panel that exists in a layer above the main display
 (camera, left panel and status panel).



 javax.swing.JPanel
getRightPanel()



          Return the panel that sits to the right of the camera, perhaps for
 showing extra information.



 javax.swing.JPanel
getStatusPanel()



          Return the panel that sits underneath the camera, generally used
 to display conditions such as speed, hunger, etc.



 void
installPerspective()



          Lay out this component.



 void
languageChange(LanguageChangeEvent event)



          Respond to a language change.



 void
setConfig(InfoView view)



          Set the configuring InfoView.



 void
uninstallPerspective()



          Uninstall this perspective.


 
Methods inherited from class rle.core.ui.PerspectiveBase
config, getComponent, getContext, getParameters, paramMap, setParameters
 
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, 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, 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, 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
 
Methods inherited from interface rle.core.ui.Perspective
getComponent
 
Methods inherited from interface rle.core.vm.PlugIn
config, getContext, paramMap, setParameters
 





Constructor Detail



PlayPerspectiveBase
public PlayPerspectiveBase()






Method Detail



getLeftPanel
public javax.swing.JPanel getLeftPanel()

Return the panel that sits to the left of the camera, typically
 displaying stats such as Str and Cur Hp.











getRightPanel
public javax.swing.JPanel getRightPanel()

Return the panel that sits to the right of the camera, perhaps for
 showing extra information.











getStatusPanel
public javax.swing.JPanel getStatusPanel()

Return the panel that sits underneath the camera, generally used
 to display conditions such as speed, hunger, etc.











getOverlayPanel
public javax.swing.JPanel getOverlayPanel()

Return the panel that exists in a layer above the main display
 (camera, left panel and status panel).  This panel is positioned
 vertically beneath the message bar.  Components may be added to
 it as desired for display above the main display, for example, the
 list of items when showing inventory.  By default, this panel has
 no layout manager and is not opaque.


Specified by:
getOverlayPanel in interface PlayPerspective








createMessageBar
protected MessageBar createMessageBar()











installPerspective
public void installPerspective()

Lay out this component.  This should be overridden by subclasses that
 wish to radically change the layout of this Perspective.
 NOTE: As presently implemented, this method should only be called
 ONCE per Player session.


Specified by:
installPerspective in interface Perspective








uninstallPerspective
public void uninstallPerspective()

Uninstall this perspective.  This method needs to perform
 any cleanup necessary to make it as if it was never used.  In
 particular, all related listeners must be removed from 
 the board, context, game clock, etc.


Specified by:
uninstallPerspective in interface Perspective








setConfig
public void setConfig(InfoView view)

Description copied from interface: PlugIn
Set the configuring InfoView.


Specified by:
setConfig in interface PlugIn
Overrides:
setConfig in class PerspectiveBase








languageChange
public void languageChange(LanguageChangeEvent event)

Respond to a language change.  We just re-initialize.


Specified by:
languageChange in interface GameContextListener
Overrides:
languageChange in class PerspectiveBase








boardChange
public void boardChange(BoardChangeEvent event)

Respond to a change of board.


Specified by:
boardChange in interface GameContextListener
Overrides:
boardChange in class PerspectiveBase








commandSetChange
public void commandSetChange(CommandSetChangeEvent event)

Respond to a change of CommandSet.


Specified by:
commandSetChange in interface GameContextListener
Overrides:
commandSetChange in class PerspectiveBase








clearOverlayPanel
public void clearOverlayPanel()

Clear the contents of the overlay, if any.


Specified by:
clearOverlayPanel in interface PlayPerspective








getCamera
public Camera getCamera()

Description copied from interface: PlayPerspective
Return the camera.


Specified by:
getCamera in interface PlayPerspective








getMessageBar
public MessageBar getMessageBar()