net.sf.gridarta.gui.panel.objectchooser

Class DefaultObjectChooser<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

net.sf.gridarta.gui.panel.objectchooser.DefaultObjectChooser<G,A,R>

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, ObjectChooser<G,A,R>

public class DefaultObjectChooser<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
extends javax.swing.JPanel
implements ObjectChooser<G,A,R>

The object Chooser implementation.

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

Constructor and Description
DefaultObjectChooser(ObjectChooserTab<G,A,R> archetypeChooserControl, ObjectChooserTab<G,A,R> pickmapChooserControl, ArchetypeChooserModel<G,A,R> archetypeChooserModel, PickmapChooserModel<G,A,R> pickmapChooserModel, ArchetypeTypeSet archetypeTypeSet) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	addObjectChooserListener(ObjectChooserListener<G,A,R> listener) Adds a listener to be notified.
BaseObject<G,A,R,?>	getCursorSelection() Returns the selected archetype (if the archetype chooser is active) or the game object selected by the map cursor (if the pickmap chooser) is active.
BaseObject<G,A,R,?>	getSelection() Returns the active arch in the left-side panel.
java.util.List<? extends BaseObject<G,A,R,?>>	getSelections() Returns the selected arches in the left-side panel.
boolean	isMatching(G gameObject) Returns whether a given game object matches the selection.
boolean	isPickmapActive() Return if the Pickmap Chooser is active.
void	moveArchetypeChooserToFront() Move the Archetype Chooser in front of the Pickmap Chooser.
void	movePickmapChooserToFront() Move the Pickmap Chooser in front of the Archetype Chooser.
void	removeObjectChooserListener(ObjectChooserListener<G,A,R> listener) Removes a listener to be notified.

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

DefaultObjectChooser

public DefaultObjectChooser(@NotNull
                            ObjectChooserTab<G,A,R> archetypeChooserControl,
                            @NotNull
                            ObjectChooserTab<G,A,R> pickmapChooserControl,
                            @NotNull
                            ArchetypeChooserModel<G,A,R> archetypeChooserModel,
                            @NotNull
                            PickmapChooserModel<G,A,R> pickmapChooserModel,
                            @NotNull
                            ArchetypeTypeSet archetypeTypeSet)

Creates a new instance.

Parameters:

archetypeChooserControl - the archetype chooser control

pickmapChooserControl - the pickmap chooser control

archetypeChooserModel - the archetype chooser model

pickmapChooserModel - the pickmap chooser model

archetypeTypeSet - the archetype type set

Method Detail

isPickmapActive

public final boolean isPickmapActive()

Return if the Pickmap Chooser is active.

Specified by:

isPickmapActive in interface ObjectChooser<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Returns:

true if the Pickmap Chooser is active, or false if the Archetype Chooser is active.

isMatching

public boolean isMatching(@NotNull
                          G gameObject)

Returns whether a given game object matches the selection.

Specified by:

isMatching in interface ObjectChooser<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

gameObject - the game object to check

Returns:

whether the game object matches

addObjectChooserListener

public void addObjectChooserListener(@NotNull
                                     ObjectChooserListener<G,A,R> listener)

Adds a listener to be notified.

Specified by:

addObjectChooserListener in interface ObjectChooser<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

listener - the listener to add

removeObjectChooserListener

public void removeObjectChooserListener(@NotNull
                                        ObjectChooserListener<G,A,R> listener)

Removes a listener to be notified.

Specified by:

removeObjectChooserListener in interface ObjectChooser<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

listener - the listener to remove

moveArchetypeChooserToFront

public void moveArchetypeChooserToFront()

Move the Archetype Chooser in front of the Pickmap Chooser.

Specified by:

moveArchetypeChooserToFront in interface ObjectChooser<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

movePickmapChooserToFront

public void movePickmapChooserToFront()

Move the Pickmap Chooser in front of the Archetype Chooser.

Specified by:

movePickmapChooserToFront in interface ObjectChooser<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

getCursorSelection

@Nullable
public BaseObject<G,A,R,?> getCursorSelection()

Returns the selected archetype (if the archetype chooser is active) or the game object selected by the map cursor (if the pickmap chooser) is active.

Specified by:

getCursorSelection in interface ObjectChooser<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Returns:

the selection or null

getSelection

@Nullable
public final BaseObject<G,A,R,?> getSelection()

Returns the active arch in the left-side panel. This can either be a default arch from the archetype set, or a custom game object from a pickmap. IMPORTANT: The returned BaseObject is not a clone. A copy must be generated before inserting such an object to the map.

Specified by:

getSelection in interface ObjectChooser<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Returns:

the active arch in the left-side panel

getSelections

@NotNull
public java.util.List<? extends BaseObject<G,A,R,?>> getSelections()

Returns the selected arches in the left-side panel. This can either be default arches, or custom arches from a pickmap. IMPORTANT: The returned GameObject list contains no clone. A copy must be generated before inserting such arches to the map.

Specified by:

getSelections in interface ObjectChooser<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Returns:

the selected arches in the left-side panel