com.mindfusion.diagramming
Class Ruler

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              com.mindfusion.diagramming.Ruler

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class Ruler
extends javax.swing.JComponent

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.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

Ruler()
Initializes a new instance of the Ruler class.

Method Summary

protected javax.swing.ImageIcon	createImageIcon(java.lang.String path)
DiagramView	getDiagramView() Gets the DiagramView document this ruler is associated with.
java.awt.Color	getGuideColor() Gets the color of alignment guides.
int	getHorizontalScaleAlignment() Gets the alignment of the horizontal scale of the ruler.
boolean	getHorizontalScaleVisible() Gets a value specifying whether the horizontal scale is visible.
java.awt.Color	getPointerColor() Gets the color of mouse pointer's projections.
java.awt.Color	getProjectionColor() Gets the color used to paint the projections of the active node on the ruler scales.
java.awt.Color	getScaleColor() Gets the color used to paint the color of the ruler scales.
java.awt.Color	getTextColor() Gets the color used to paint texts in the ruler.
int	getUnit() Gets the measure units displayed by the ruler.
int	getVerticalScaleAlignment() Gets the alignment of the vertical scale of the ruler.
boolean	getVerticalScaleVisible() Gets a value specifying whether the vertical scale is visible.
void	setDiagramView(DiagramView diagramView) Sets the DiagramView document this ruler is associated with.
void	setGuideColor(java.awt.Color color) Sets the color of alignment guides.
void	setHorizontalScaleAlignment(int align) Sets the alignment of the horizontal scale of the ruler.
void	setHorizontalScaleVisible(boolean value) Sets a value specifying whether the horizontal scale is visible.
void	setPointerColor(java.awt.Color color) Sets the color of mouse pointer's projections.
void	setProjectionColor(java.awt.Color color) Sets the color used to paint the projections of the active node on the ruler scales.
void	setScaleColor(java.awt.Color color) Sets the color used to paint the color of the ruler scales.
void	setTextColor(java.awt.Color color) Sets the color used to paint texts in the ruler.
void	setUnit(int unit) Sets the measure units displayed by the ruler.
void	setVerticalScaleAlignment(int align) Sets the alignment of the vertical scale.
void	setVerticalScaleVisible(boolean value) Sets a value specifying whether the vertval scale is visible.

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, 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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, 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, setFont, 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, 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

Ruler

public Ruler()

Initializes a new instance of the Ruler class.

Method Detail

createImageIcon

protected javax.swing.ImageIcon createImageIcon(java.lang.String path)

getDiagramView

public DiagramView getDiagramView()

Gets the DiagramView document this ruler is associated with.

Returns:

An instance of the DiagramView class.

setDiagramView

public void setDiagramView(DiagramView diagramView)

Sets the DiagramView document this ruler is associated with.

Parameters:

diagramView - An instance of the DiagramView class.

setHorizontalScaleAlignment

public void setHorizontalScaleAlignment(int align)

Sets the alignment of the horizontal scale of the ruler.

Parameters:

align - the alignment of the horizontal scale.

getHorizontalScaleAlignment

public int getHorizontalScaleAlignment()

Gets the alignment of the horizontal scale of the ruler.

Returns:

the alignment of the horizontal scale.

setVerticalScaleAlignment

public void setVerticalScaleAlignment(int align)

Sets the alignment of the vertical scale.

Parameters:

align - the alignment of the vertical scale.

setUnit

public void setUnit(int unit)

Sets the measure units displayed by the ruler.

Parameters:

unit - the measure unit used by the ruler.

setProjectionColor

public void setProjectionColor(java.awt.Color color)

Sets the color used to paint the projections of the active node on the ruler scales.

Parameters:

color - the color used to paint the projection of the active node.

getProjectionColor

public java.awt.Color getProjectionColor()

Gets the color used to paint the projections of the active node on the ruler scales.

Returns:

the color used to paint the projection of the active node.

setPointerColor

public void setPointerColor(java.awt.Color color)

Sets the color of mouse pointer's projections.

Parameters:

color - a Color instance specifying the color of the pointer projection lines. The default is Color.red.

getPointerColor

public java.awt.Color getPointerColor()

Gets the color of mouse pointer's projections.

Returns:

A Color instance specifying the color of the pointer projection lines. The default is Color.red.

setTextColor

public void setTextColor(java.awt.Color color)

Sets the color used to paint texts in the ruler.

Parameters:

color - the color used to paint texts in the ruler.

getTextColor

public java.awt.Color getTextColor()

Gets the color used to paint texts in the ruler.

Returns:

the color used to paint texts in the ruler.

setGuideColor

public void setGuideColor(java.awt.Color color)

Sets the color of alignment guides.

Parameters:

color - the color used to paint guides.

getGuideColor

public java.awt.Color getGuideColor()

Gets the color of alignment guides.

Returns:

the color used to paint guides.

getUnit

public int getUnit()

Gets the measure units displayed by the ruler.

Returns:

the measure unit used by the ruler.

getVerticalScaleAlignment

public int getVerticalScaleAlignment()

Gets the alignment of the vertical scale of the ruler.

Returns:

the alignment of the vertical scale.

getScaleColor

public java.awt.Color getScaleColor()

Gets the color used to paint the color of the ruler scales.

Returns:

A Color used to fill the ruler scales. The default is white.

setScaleColor

public void setScaleColor(java.awt.Color color)

Sets the color used to paint the color of the ruler scales.

Parameters:

color - A Color used to fill the ruler scales. The default is white.

getVerticalScaleVisible

public boolean getVerticalScaleVisible()

Gets a value specifying whether the vertical scale is visible.

Returns:

a value specifying whether the vertical scale is visible.

setVerticalScaleVisible

public void setVerticalScaleVisible(boolean value)

Sets a value specifying whether the vertval scale is visible.

Parameters:

value - a value specifying whether the vertical scale is visible.

getHorizontalScaleVisible

public boolean getHorizontalScaleVisible()

Gets a value specifying whether the horizontal scale is visible.

Returns:

a value specifying whether the horizontal scale is visible.

setHorizontalScaleVisible

public void setHorizontalScaleVisible(boolean value)

Sets a value specifying whether the horizontal scale is visible.

Parameters:

value - a value specifying whether the horizontal scale is visible.