Package edu.cnu.mdi.graphics.toolbar

Class APointerButton

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.AbstractButton

javax.swing.JToggleButton

edu.cnu.mdi.graphics.toolbar.APointerButton

All Implemented Interfaces:

IRubberbanded, MouseListener, MouseMotionListener, ImageObserver, ItemSelectable, MenuContainer, Serializable, EventListener, Accessible, SwingConstants

public abstract class APointerButton
extends JToggleButton
implements MouseMotionListener, MouseListener, IRubberbanded

Toggle button that drives the "pointer" (selection/move/rubberband) tool for a canvas, disambiguating a mouse press into an object drag or a rubberband gesture based on where the press landed and how far the mouse moves before the drag threshold is crossed.

State machine

An internal Mode tracks the gesture in progress:

• IDLE — no gesture in progress.
• PRESS_ON_OBJECT / PRESS_ON_EMPTY — the mouse was pressed on a hit-tested object (see hitTest(java.awt.Point)) or on empty space; the gesture is not yet classified as a drag or a click.
• MOVING — the press was on an object and the mouse has moved past dragThresholdPx, promoting the gesture into an object drag (see beginDragObject(java.lang.Object, java.awt.Point, java.awt.event.MouseEvent)/dragObjectBy(java.lang.Object, int, int, java.awt.event.MouseEvent)/endDragObject(java.lang.Object, java.awt.event.MouseEvent)).
• RUBBERBANDING — the press was on empty space and the mouse has moved past the threshold, promoting the gesture into a rubberband selection (see rubberbanding(java.awt.Rectangle, java.awt.Point[])).

Extension points

Subclasses configure hit-testing and drag behavior by overriding hitTest(java.awt.Point), doNotDrag(java.lang.Object, java.awt.event.MouseEvent), clickObject(java.lang.Object, java.awt.event.MouseEvent), doubleClickObject(java.lang.Object, java.awt.event.MouseEvent), beginDragObject(java.lang.Object, java.awt.Point, java.awt.event.MouseEvent), dragObjectBy(java.lang.Object, int, int, java.awt.event.MouseEvent), endDragObject(java.lang.Object, java.awt.event.MouseEvent), and must implement rubberbanding(java.awt.Rectangle, java.awt.Point[]) to react to a completed rubberband gesture.

See Also:

• Serialized Form

Nested Class Summary

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

JToggleButton.AccessibleJToggleButton, JToggleButton.ToggleButtonModel

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

AbstractButton.AccessibleAbstractButton, AbstractButton.ButtonChangeListener

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

Field Summary

Fields

Modifier and Type	Field	Description
protected Component	canvas
protected int	dragThresholdPx	Drag threshold (px) to promote press into a drag gesture.
protected ARubberband.Policy	policy
protected ARubberband	rubberband
protected AToolBar	toolBar

Fields inherited from class javax.swing.AbstractButton

actionListener, BORDER_PAINTED_CHANGED_PROPERTY, changeEvent, changeListener, CONTENT_AREA_FILLED_CHANGED_PROPERTY, DISABLED_ICON_CHANGED_PROPERTY, DISABLED_SELECTED_ICON_CHANGED_PROPERTY, FOCUS_PAINTED_CHANGED_PROPERTY, HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY, HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY, ICON_CHANGED_PROPERTY, itemListener, MARGIN_CHANGED_PROPERTY, MNEMONIC_CHANGED_PROPERTY, model, MODEL_CHANGED_PROPERTY, PRESSED_ICON_CHANGED_PROPERTY, ROLLOVER_ENABLED_CHANGED_PROPERTY, ROLLOVER_ICON_CHANGED_PROPERTY, ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY, SELECTED_ICON_CHANGED_PROPERTY, TEXT_CHANGED_PROPERTY, VERTICAL_ALIGNMENT_CHANGED_PROPERTY, VERTICAL_TEXT_POSITION_CHANGED_PROPERTY

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

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	APointerButton(Component canvas, AToolBar toolBar, ARubberband.Policy policy, int minSizePx)	Create a pointer button that supports rubberbanding.

Method Summary

Modifier and Type	Method	Description
protected Cursor	activeCursor()
protected void	beginDragObject(Object obj, Point pressPoint, MouseEvent e)
protected final void	cancelRubberband()
protected void	clickObject(Object obj, MouseEvent e)
final void	doneRubberbanding()	This just signals that we are done rubber banding.
protected boolean	doNotDrag(Object object, MouseEvent e)
protected void	doubleClickObject(Object obj, MouseEvent e)
protected void	dragObjectBy(Object object, int dx, int dy, MouseEvent e)
protected void	endDragObject(Object object, MouseEvent e)
protected Object	hitTest(Point p)
void	mouseClicked(MouseEvent e)
void	mouseDragged(MouseEvent e)
void	mouseEntered(MouseEvent e)
void	mouseExited(MouseEvent e)
void	mouseMoved(MouseEvent e)
void	mousePressed(MouseEvent e)
void	mouseReleased(MouseEvent e)
abstract void	rubberbanding(Rectangle bounds, Point[] vertices)
protected ARubberband.Policy	rubberbandPolicy()	Get the rubberbanding policy for this tool.

Methods inherited from class javax.swing.JToggleButton

getAccessibleContext, getUIClassID, paramString, requestFocus, requestFocusInWindow, updateUI

Methods inherited from class javax.swing.AbstractButton

actionPropertyChanged, addActionListener, addChangeListener, addImpl, addItemListener, checkHorizontalKey, checkVerticalKey, configurePropertiesFromAction, createActionListener, createActionPropertyChangeListener, createChangeListener, createItemListener, doClick, doClick, fireActionPerformed, fireItemStateChanged, fireStateChanged, getAction, getActionCommand, getActionListeners, getChangeListeners, getDisabledIcon, getDisabledSelectedIcon, getDisplayedMnemonicIndex, getHideActionText, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getItemListeners, getLabel, getMargin, getMnemonic, getModel, getMultiClickThreshhold, getPressedIcon, getRolloverIcon, getRolloverSelectedIcon, getSelectedIcon, getSelectedObjects, getText, getUI, getVerticalAlignment, getVerticalTextPosition, imageUpdate, init, isBorderPainted, isContentAreaFilled, isFocusPainted, isRolloverEnabled, isSelected, paintBorder, removeActionListener, removeChangeListener, removeItemListener, removeNotify, setAction, setActionCommand, setBorderPainted, setContentAreaFilled, setDisabledIcon, setDisabledSelectedIcon, setDisplayedMnemonicIndex, setEnabled, setFocusPainted, setHideActionText, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabel, setLayout, setMargin, setMnemonic, setMnemonic, setModel, setMultiClickThreshhold, setPressedIcon, setRolloverEnabled, setRolloverIcon, setRolloverSelectedIcon, setSelected, setSelectedIcon, setText, setUI, setVerticalAlignment, setVerticalTextPosition

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, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, 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, 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, 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, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, requestFocus, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, 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

Methods inherited from interface edu.cnu.mdi.graphics.rubberband.IRubberbanded

approvePoint

Field Details

canvas

protected Component canvas

toolBar

protected AToolBar toolBar

policy

protected ARubberband.Policy policy

rubberband

protected ARubberband rubberband

dragThresholdPx

protected int dragThresholdPx

Drag threshold (px) to promote press into a drag gesture.

Constructor Details

APointerButton

protected APointerButton(Component canvas,
 AToolBar toolBar,
 ARubberband.Policy policy,
 int minSizePx)

Create a pointer button that supports rubberbanding.

Parameters:

canvas - the component on which gestures occur

toolBar - the toolbar that owns this tool

policy - the rubberbanding policy for this tool

minSizePx - minimum size (in pixels) for a valid rubberband gesture

Method Details

rubberbandPolicy

protected ARubberband.Policy rubberbandPolicy()

Get the rubberbanding policy for this tool.

Returns:

the rubberbanding policy

activeCursor

protected Cursor activeCursor()

Returns:

cursor to use while active. Default is crosshair or default cursor if no rubberbanding.

rubberbanding

public abstract void rubberbanding(Rectangle bounds,
 Point[] vertices)

cancelRubberband

protected final void cancelRubberband()

doneRubberbanding

public final void doneRubberbanding()

Description copied from interface: IRubberbanded

This just signals that we are done rubber banding.

Specified by:

doneRubberbanding in interface IRubberbanded

mouseEntered

public void mouseEntered(MouseEvent e)

Specified by:

mouseEntered in interface MouseListener

mouseExited

public void mouseExited(MouseEvent e)

Specified by:

mouseExited in interface MouseListener

mouseMoved

public void mouseMoved(MouseEvent e)

Specified by:

mouseMoved in interface MouseMotionListener

mouseClicked

public void mouseClicked(MouseEvent e)

Specified by:

mouseClicked in interface MouseListener

mousePressed

public void mousePressed(MouseEvent e)

Specified by:

mousePressed in interface MouseListener

mouseDragged

public void mouseDragged(MouseEvent e)

Specified by:

mouseDragged in interface MouseMotionListener

mouseReleased

public void mouseReleased(MouseEvent e)

Specified by:

mouseReleased in interface MouseListener

hitTest

protected Object hitTest(Point p)

clickObject

protected void clickObject(Object obj,
 MouseEvent e)

doubleClickObject

protected void doubleClickObject(Object obj,
 MouseEvent e)

beginDragObject

protected void beginDragObject(Object obj,
 Point pressPoint,
 MouseEvent e)

dragObjectBy

protected void dragObjectBy(Object object,
 int dx,
 int dy,
 MouseEvent e)

endDragObject

protected void endDragObject(Object object,
 MouseEvent e)

doNotDrag

protected boolean doNotDrag(Object object,
 MouseEvent e)