JIDE 3.5.15

com.jidesoft.chart.event
Class AxisZoomController

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JPanel
                  extended by com.jidesoft.chart.event.AxisZoomController
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible

public class AxisZoomController
extends JPanel

A GUI element for controlling the zooming of one or more axes. As the user of this component in the user interface you can choose which axis to zoom by choosing from the drop-down menu, then zoom in or out by pressing the appropriate button. When you do this, the component fires a ZoomEvent to its listeners and the listener can determine how much to zoom. The listener will probably effect a zoom by using the zoom() method on the Axis class.

As a developer working with this component, you can specify what the text or icon should be in the zoom buttons and you can specify the axes that can be controlled. (Actually it is also possible to specify both text and an icon. If just one axis is specified, a JLabel is used to display the axis name as no choices can be made.

Here is a screenshot of the AxisZoomController (taken on a Mac), where the buttons have been configured to display '-' and '+' to mean zoom out and zoom in, respectively:

AxisZoomController screenshot

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JPanel
JPanel.AccessibleJPanel
 
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 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
AxisZoomController()
          Added for Java Bean compatibility.
AxisZoomController(Axis... axes)
          Create a zoom controller object and pass the axes that it will allow you to control.
 
Method Summary
 void addZoomListener(ZoomListener listener)
          Add an object that is interested in receiving zoom events from this class
protected  void fireZoomAction(ZoomDirection direction)
          Fire a zoom event.
 Axis[] getAxes()
          The axes that are known by this class
protected  void init()
           
 void removeZoomListener(ZoomListener listener)
          Remove a (previously-added) zoom listener from this class
 void setAxes(Axis[] axes)
          Specify the axes that are to be controlled by this class
 void setZoomInIcon(Icon icon)
          Specify the icon to use on the zoom in button
 void setZoomInText(String text)
          Specify the text to use on the zoom in button
 void setZoomOutIcon(Icon icon)
          Specify the icon to use on the zoom out button
 void setZoomOutText(String text)
          Specify the text to use on the zoom out button
 
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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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
 

Constructor Detail

AxisZoomController

public AxisZoomController()
Added for Java Bean compatibility. If you use this constructor you must remember to call setAxes() to specify which axes the class is to act on.


AxisZoomController

public AxisZoomController(Axis... axes)
Create a zoom controller object and pass the axes that it will allow you to control.

Parameters:
axes - the Axis objects for this zoom controller
Method Detail

setAxes

public void setAxes(Axis[] axes)
Specify the axes that are to be controlled by this class

Parameters:
axes - the axes that are to be controlled by this class

getAxes

public Axis[] getAxes()
The axes that are known by this class

Returns:
the axes

init

protected void init()

addZoomListener

public void addZoomListener(ZoomListener listener)
Add an object that is interested in receiving zoom events from this class

Parameters:
listener - the object to receive zoom notification

removeZoomListener

public void removeZoomListener(ZoomListener listener)
Remove a (previously-added) zoom listener from this class

Parameters:
listener - the object to remove

fireZoomAction

protected void fireZoomAction(ZoomDirection direction)
Fire a zoom event. This method is called when either of the zoom buttons is pressed.

Parameters:
direction - the direction of the zoom (in or out)

setZoomOutText

public void setZoomOutText(String text)
Specify the text to use on the zoom out button

Parameters:
text - the text label

setZoomInText

public void setZoomInText(String text)
Specify the text to use on the zoom in button

Parameters:
text - the text label

setZoomOutIcon

public void setZoomOutIcon(Icon icon)
Specify the icon to use on the zoom out button

Parameters:
icon - the zoom out icon

setZoomInIcon

public void setZoomInIcon(Icon icon)
Specify the icon to use on the zoom in button

Parameters:
icon - the zoom in icon

JIDE 3.5.15