JRuler (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - org.siox.example.JRuler

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Icon, SwingConstants
```
public class JRuler
extends JComponent
implements Icon, SwingConstants
```
Ruler component for ScrollDisplay.

Version:

1.0

Author:

Lars Knipping

See Also:

Serialized Form

Nested Class Summary
- 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 and Description
`static int`	`INCH_UNITS` Constant for showing an inch ruler.
`static int`	`METRIC_UNITS` Constant for showing a metric uler, showing centimeter units.
`static int`	`NO_UNITS` Constant for showing an empty ruler, just reserving space.
`int`	`orientation` Orientation, `HORIZONTAL` or `VERTICAL`.
`static int`	`PIXEL_UNITS` Constant for showing an pixel measuring ruler.

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 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

Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`JRuler(ScrollDisplay scrollDisplay, int orientation, int unitMode, int maxScale)` Constructs a new ruler instance for use with scrollable areas and capable of scrolling.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getIconHeight()` Returns height as icon.
`int`	`getIconWidth()` Returns width as icon.
`Dimension`	`getPreferredSize()` Returns size needed for max supported scale.
`int`	`getUnit()` Returns the units this ruler shows.
`protected void`	`paintComponent(Graphics g)` Paints this ruler component.
`void`	`paintIcon(Component c, Graphics g, int x, int y)` Draw the icon at the specified location.
`void`	`setFont(Font font)` Sets the font to label major tick in.
`void`	`setUnit(int unitMode)` Sets the units this ruler will show.

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, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, 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, setForeground, setInheritsPopupMenu, 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, 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, getAccessibleContext, 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

- Field Detail
  - NO_UNITS
```
public static final int NO_UNITS
```
    Constant for showing an empty ruler, just reserving space.
    
    See Also:
    
    Constant Field Values
  - METRIC_UNITS
```
public static final int METRIC_UNITS
```
    Constant for showing a metric uler, showing centimeter units.
    
    See Also:
    
    Constant Field Values
  - INCH_UNITS
```
public static final int INCH_UNITS
```
    Constant for showing an inch ruler.
    
    See Also:
    
    Constant Field Values
  - PIXEL_UNITS
```
public static final int PIXEL_UNITS
```
    Constant for showing an pixel measuring ruler.
    
    See Also:
    
    Constant Field Values
  - orientation
```
public final int orientation
```
    Orientation, HORIZONTAL or VERTICAL.
- Constructor Detail
  - JRuler
```
protected JRuler(ScrollDisplay scrollDisplay,
                 int orientation,
                 int unitMode,
                 int maxScale)
```
    Constructs a new ruler instance for use with scrollable areas and capable of scrolling.
    
    Parameters:
    
    scrollDisplay - the display this belongs to.
    
    orientation - one of SwingConstants.HORIZONTAL and SwingConstants.VERTICAL.
    
    unitMode - ruler unit to show, one of the constants NO_UNITS, METRIC_UNITS, INCH_UNITS, and PIXEL_UNITS.
    
    maxScale - the maximum scale factor this will be able to handle.
- Method Detail
  - getPreferredSize
```
public Dimension getPreferredSize()
```
    Returns size needed for max supported scale.
    
    Overrides:
    
    getPreferredSize in class JComponent
  - setUnit
```
public void setUnit(int unitMode)
```
    Sets the units this ruler will show.
    
    Parameters:
    
    unitMode - ruler unit to show, one of the constants NO_UNITS, METRIC_UNITS, INCH_UNITS, and PIXEL_UNITS.
    
    See Also:
    
    getUnit()
  - getUnit
```
public int getUnit()
```
    Returns the units this ruler shows.
    
    See Also:
    
    getUnit(), NO_UNITS, METRIC_UNITS, INCH_UNITS, PIXEL_UNITS
  - setFont
```
public void setFont(Font font)
```
    Sets the font to label major tick in.
    
    Overrides:
    
    setFont in class JComponent
  - paintComponent
```
protected void paintComponent(Graphics g)
```
    Paints this ruler component.
    
    Overrides:
    
    paintComponent in class JComponent
  - getIconWidth
```
public int getIconWidth()
```
    Returns width as icon.
    
    Specified by:
    
    getIconWidth in interface Icon
  - getIconHeight
```
public int getIconHeight()
```
    Returns height as icon.
    
    Specified by:
    
    getIconHeight in interface Icon
  - paintIcon
```
public void paintIcon(Component c,
                      Graphics g,
                      int x,
                      int y)
```
    Draw the icon at the specified location.
    
    Specified by:
    
    paintIcon in interface Icon

Class JRuler

Nested Class Summary

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

Nested classes/interfaces inherited from class java.awt.Container

Nested classes/interfaces inherited from class java.awt.Component

Field Summary

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface javax.swing.SwingConstants

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

NO_UNITS

METRIC_UNITS

INCH_UNITS

PIXEL_UNITS

orientation

Constructor Detail

JRuler

Method Detail

getPreferredSize

setUnit

getUnit

setFont

paintComponent

getIconWidth

getIconHeight

paintIcon