public class ViewOperationChooser
extends javax.swing.JToolBar
ViewOperationChooser
class is a
JToolBar
that allows the user to select view transform
operations using a set of toolbar buttons. There are seven view
transform operations in total: Magnify, Shrink, 1:1, Zoom, Pan,
Recenter, and Reset, and Fit. The Magnify, Shrink, 1:1, Reset, and Fit
operations are designed to be non-interactive, single-click modes.
The user would click these buttons once, then the view should
change according to the operation. The Zoom, Pan, and Recenter
operations are interactive in the sense that once selected,
additional input must be obtained from the user in order the change
the view transform.
The operation chooser signals a change in the selected operation by
firing a PropertyChangeEvent
whose property name is
ViewOperationChooser.OPERATION_PROPERTY
, and new value
contains an operation name from the constants in this class.
A static instance of this class is available via
getInstance()
so that a single chooser may be used
from multiple classes, even though it is only included in one
layout manager.
javax.swing.JToolBar.AccessibleJToolBar, javax.swing.JToolBar.Separator
javax.swing.JComponent.AccessibleJComponent
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLOSE
The close operation (full screen only).
|
static java.lang.String |
FIT
The fit operation.
|
static java.lang.String |
MAGNIFY
The magnify operation.
|
static java.lang.String |
ONE_TO_ONE
The 1:1 operation.
|
static java.lang.String |
OPERATION_PROPERTY
The operation property.
|
static java.lang.String |
PAN
The pan operation.
|
static java.lang.String |
RECENTER
The recenter operation.
|
static java.lang.String |
RESET
The reset operation.
|
static java.lang.String |
SHRINK
The shrink operation.
|
static java.lang.String |
ZOOM
The zoom operation.
|
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
Constructor and Description |
---|
ViewOperationChooser()
Creates a new horizontal operation chooser with text and icons.
|
ViewOperationChooser(int orientation,
boolean showText)
Creates a new operation chooser.
|
Modifier and Type | Method and Description |
---|---|
void |
deactivate()
Deactivates the view chooser so that no operation is selected.
|
FullScreenToolBar |
getFullScreenChooser()
Creates a full screen version of the chooser with a subset of the
view operations, and an additional exit button.
|
static ViewOperationChooser |
getInstance()
Creates a static instance of this class using the default
constructor.
|
java.lang.String |
getOperation()
Gets the selected operation, or null if no operation is selected.
|
void |
performOperation(java.lang.String operation)
Performs an operation programatically, rather than having to
wait for the user to click a button on the chooser.
|
void |
setEnabled(boolean flag)
Sets the enabled status of the chooser buttons.
|
add, addImpl, addSeparator, addSeparator, createActionChangeListener, createActionComponent, getAccessibleContext, getComponentAtIndex, getComponentIndex, getMargin, getOrientation, getUI, getUIClassID, isBorderPainted, isFloatable, isRollover, paintBorder, paramString, setBorderPainted, setFloatable, setLayout, setMargin, setOrientation, setRollover, setUI, updateUI
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, removeNotify, 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
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
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
public static final java.lang.String OPERATION_PROPERTY
public static final java.lang.String MAGNIFY
public static final java.lang.String SHRINK
public static final java.lang.String ONE_TO_ONE
public static final java.lang.String ZOOM
public static final java.lang.String PAN
public static final java.lang.String RECENTER
public static final java.lang.String RESET
public static final java.lang.String FIT
public static final java.lang.String CLOSE
public ViewOperationChooser()
public ViewOperationChooser(int orientation, boolean showText)
orientation
- the toolbar orientation, either
HORIZONTAL
or VERTICAL
.showText
- the show text flag. If true, text is shown below
the icon in each button. If false, no text is shown, but a tool
tip is set for the button.public void deactivate()
public void setEnabled(boolean flag)
setEnabled
in class javax.swing.JComponent
public java.lang.String getOperation()
public static ViewOperationChooser getInstance()
public FullScreenToolBar getFullScreenChooser()
public void performOperation(java.lang.String operation)
operation
- the operation to perform.getOperation()