JClass DesktopViews 6.3.0 API
Documentation

com.klg.jclass.swing.gauge
Class JCCircularNeedle

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--com.klg.jclass.swing.gauge.JCAbstractIndicator
                          |
                          +--com.klg.jclass.swing.gauge.JCAbstractNeedle
                                |
                                +--com.klg.jclass.swing.gauge.JCCircularNeedle
All Implemented Interfaces:
ImageObserver, JCIndicator, JCNeedle, MenuContainer, Serializable

public class JCCircularNeedle
extends JCAbstractNeedle

A needle points to values on its scale. There may be multiple needles associated with a scale.

See Also:
JCIndicatorStyle, Serialized Form

Nested Class Summary
 
Nested classes inherited from class com.klg.jclass.swing.gauge.JCAbstractNeedle
JCAbstractNeedle.InteractionType
 
Nested classes inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
 
Nested classes inherited from class java.awt.Container
Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy
 
Field Summary
 
Fields inherited from class com.klg.jclass.swing.gauge.JCAbstractNeedle
changeEvent, changeListeners, interactionType, sendEvents
 
Fields inherited from class com.klg.jclass.swing.gauge.JCAbstractIndicator
indicatorStyle, indicatorWidth, inner_extent, outer_extent, reversed, scale, value
 
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
JCCircularNeedle(Color foreground, double needleWidth, com.klg.jclass.swing.gauge.JCCircularScale scale, boolean visible, double inner_extent, double outer_extent, com.klg.jclass.swing.gauge.JCIndicatorStyle needleStyle, double value)
          Creates a needle.
JCCircularNeedle(Color foreground, double needleWidth, com.klg.jclass.swing.gauge.JCCircularScale scale, JCAbstractNeedle.InteractionType interactionType, boolean visible, double length, com.klg.jclass.swing.gauge.JCIndicatorStyle needleStyle, double value)
          Deprecated. Beginning with JClass 5, the length parameter has been replaced with inner_extent and outer_extent.
JCCircularNeedle(com.klg.jclass.swing.gauge.JCCircularScale scale)
          Creates a needle.
 
Method Summary
protected  com.klg.jclass.swing.gauge.JCCircularScale getCircularScale()
          Returns the circular scale associated with this needle.
 void paint(Graphics g)
          This routine draws the circular needle object on the screen.
 
Methods inherited from class com.klg.jclass.swing.gauge.JCAbstractNeedle
addChangeListener, getInteractionType, getLength, getNeedleStyle, getNeedleWidth, getPreferredSize, getSendEvents, removeChangeListener, sendChangeEvent, setInteractionType, setLength, setNeedleStyle, setNeedleWidth, setSendEvents, setValue
 
Methods inherited from class com.klg.jclass.swing.gauge.JCAbstractIndicator
getIndicatorStyle, getIndicatorWidth, getInnerExtent, getOuterExtent, getScale, getValue, isReversed, redraw, setIndicatorStyle, setIndicatorWidth, setInnerExtent, setOuterExtent, setReversed, setScale
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, 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 com.klg.jclass.swing.gauge.JCIndicator
getIndicatorStyle, getIndicatorWidth, getInnerExtent, getOuterExtent, getScale, getValue, isReversed, setIndicatorStyle, setIndicatorWidth, setInnerExtent, setOuterExtent, setReversed
 

Constructor Detail

JCCircularNeedle

public JCCircularNeedle(com.klg.jclass.swing.gauge.JCCircularScale scale)
Creates a needle.

Parameters:
scale - The associated circular scale

JCCircularNeedle

public JCCircularNeedle(Color foreground,
                        double needleWidth,
                        com.klg.jclass.swing.gauge.JCCircularScale scale,
                        boolean visible,
                        double inner_extent,
                        double outer_extent,
                        com.klg.jclass.swing.gauge.JCIndicatorStyle needleStyle,
                        double value)
Creates a needle.

Parameters:
foreground - the needle's color
needleWidth - the needle's width in pixels
scale - the associated circular scale
visible - a Boolean that controls the visibility of the needle
inner_extent - the needle's inner extent, expressed as a ratio of its length to the relevant dimension (radius, width/length) of the associated circular scale
outer_extent - the needle's outer extent, expressed as a ratio of its length to the relevant dimension (radius, width/length) of the associated circular scale
needleStyle - needle styles are kept in JCIndicatorStyle; user-defined needle styles may be passed to JCIndicatorStyle's constructor
value - the needle's value; the needle points to this value on its associated scale

JCCircularNeedle

public JCCircularNeedle(Color foreground,
                        double needleWidth,
                        com.klg.jclass.swing.gauge.JCCircularScale scale,
                        JCAbstractNeedle.InteractionType interactionType,
                        boolean visible,
                        double length,
                        com.klg.jclass.swing.gauge.JCIndicatorStyle needleStyle,
                        double value)
Deprecated. Beginning with JClass 5, the length parameter has been replaced with inner_extent and outer_extent.

Creates a needle.

Parameters:
foreground - the needle's color
needleWidth - the needle's width in pixels
scale - the associated circular scale
interactionType - the interaction type; CLICK, CLICK_DRAG, or NONE
visible - a Boolean that controls the visibility of the needle
length - the needle's length, expressed as a ratio of its length to the relevant dimension (radius, width/length) of the associated scale
needleStyle - needle styles are kept in JCIndicatorStyle; user-defined needle styles may be passed to JCIndicatorStyle's constructor
value - the needle's value; the needle points to this value on its associated scale
Method Detail

getCircularScale

protected com.klg.jclass.swing.gauge.JCCircularScale getCircularScale()
Returns the circular scale associated with this needle.

Returns:
the circular scale associated with this needle

paint

public void paint(Graphics g)
This routine draws the circular needle object on the screen.

Specified by:
paint in class JCAbstractNeedle
Parameters:
g -

Copyright © 2004 Quest Software Inc..
All rights reserved.