IlvScaleBar (Perforce JViews 10.0 API)

java.lang.Object
- java.awt.Component
- - ilog.views.maps.beans.IlvScaleBar

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable
```
public class IlvScaleBar
extends Component
```
This class defines a component that displays the scale of an IlvManagerView. This component works only if the manager of the target view has an IlvCoordinateSystemProperty or an IlvProjectionProperty (for backward compatibility with JViews versions previous to 5.0).
This property defines the coordinate system of the manager and its units.

See Also:

IlvProjectionProperty, IlvCoordinateSystemProperty, Serialized Form

Nested Class Summary
- 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`	`DASH_SCALE_EVEN` Displays alternate color filled rectangles, starting with a foreground colored rectangle.
`static int`	`DASH_SCALE_ODD` Displays graduations with filled rectangles, starting with an alternate colored rectangle.
`static int`	`DOUBLE_DASH_SCALE_EVEN` Displays alternate filled and non filled rectangles.
`static int`	`DOUBLE_DASH_SCALE_ODD` Displays two lines of filled and non filled rectangles, starting with an alternate color filled rectangle.
`static int`	`DOUBLE_SCALE_EMPTY` Displays two lines of empty rectangles.
`static int`	`SCALE_EMPTY` Displays graduations with empty rectangles.
`static int`	`SIMPLE_SCALE_BOTTOM` Displays graduations on a bottom line.
`static int`	`SIMPLE_SCALE_CENTER` Displays graduations on a centered line.
`static int`	`THREE_LABELS` Three labels are drawn on the top of the scale bar.
`static int`	`UNIQUE_LABEL` A unique label is drawn on the top of the scale bar.

Fields inherited from class java.awt.Component
accessibleContext, 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

Constructors
Constructor and Description

IlvScaleBar()
Creates a new instance of IlvScaleBar.

Constructors
Constructor and Description
`IlvScaleBar()` Creates a new instance of `IlvScaleBar`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Color`	`getAlternateScaleColor()` Gets the alternate scale color.
`double`	`getFarLimit()` Returns the switch limit between a text display of the scale in a small unit (for instance, meters) and a text display in a large unit (for instance, kilometers).
`IlvLinearUnit`	`getFarUnit()` Returns the unit used to display the length of the scale bar for small scales.
`IlvGraphic`	`getGraphic()` Returns the `IlvGraphic` that represents the scale part of the `IlvScaleBar`.
`int`	`getMarginHeight()` Returns the vertical margin that must be left between the scale bar and the border of the component.
`int`	`getMarginWidth()` Returns the minimum margin that must be left between the scale bar and the border of the component.
`Dimension`	`getMinimumSize()` Returns the minimum size of the component.
`IlvLinearUnit`	`getNearUnit()` Returns the unit used to display the length of the scale bar for large scales.
`Dimension`	`getPreferredSize()` Returns the preferred size of the component.
`int`	`getScaleHeight()` Returns the height of the scale bar.
`int`	`getScaleStyle()` Returns the style used to draw the scale bar.
`int`	`getScaleTextMode()` Returns the text mode.
`int`	`getTextSpacing()` Returns the text spacing.
`IlvManagerView`	`getView()` Returns the view whose scale is displayed.
`void`	`paint(Graphics g)` Draws the component.
`void`	`setAlternateScaleColor(Color color)` Sets the alternate scale color.
`void`	`setFarLimit(double limit)` Sets the switch limit between a text display of the scale in a small unit (for instance, meters) and a text display in a large unit (for instance, kilometers).
`void`	`setFarUnit(IlvLinearUnit unit)` Sets the unit used to display the length of the scale bar for small scales.
`void`	`setGraphic(IlvGraphic graphic)` Sets the `IlvGraphic` that represents the scale part of the `IlvScaleBar`.
`void`	`setMarginHeight(int margin)` Specifies the vertical margin that must be left between the scale bar and the border of the component.
`void`	`setMarginWidth(int margin)` Specifies the minimum horizontal margin that must be left between the scale bar and the border of the component.
`void`	`setNearUnit(IlvLinearUnit unit)` Sets the unit used to display the length of the scale bar for large scales.
`void`	`setScaleHeight(int scaleHeight)` Sets the height of the scale bar.
`void`	`setScaleStyle(int style)` Sets the style used to draw the scale bar.
`void`	`setScaleTextMode(int mode)` Sets the label displaying mode.
`void`	`setSize(int width, int height)` Sets the size for this object.
`void`	`setTextSpacing(int spacing)` Specifies the text spacing.
`void`	`setView(IlvManagerView view)` Specifies the view that controls this component.

Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getAlignmentX, getAlignmentY, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, revalidate, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, update, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - SIMPLE_SCALE_CENTER
```
public static final int SIMPLE_SCALE_CENTER
```
    Displays graduations on a centered line.
    
    Since:
    
    JViews 5.0
    
    See Also:
    
    Constant Field Values
  - DASH_SCALE_EVEN
```
public static final int DASH_SCALE_EVEN
```
    Displays alternate color filled rectangles, starting with a foreground colored rectangle.
    
    Since:
    
    JViews 5.0
    
    See Also:
    
    Constant Field Values
  - DOUBLE_DASH_SCALE_EVEN
```
public static final int DOUBLE_DASH_SCALE_EVEN
```
    Displays alternate filled and non filled rectangles.
    
    Since:
    
    JViews 5.0
    
    See Also:
    
    Constant Field Values
  - DASH_SCALE_ODD
```
public static final int DASH_SCALE_ODD
```
    Displays graduations with filled rectangles, starting with an alternate colored rectangle.
    
    Since:
    
    JViews 5.0
    
    See Also:
    
    Constant Field Values
  - DOUBLE_DASH_SCALE_ODD
```
public static final int DOUBLE_DASH_SCALE_ODD
```
    Displays two lines of filled and non filled rectangles, starting with an alternate color filled rectangle.
    
    Since:
    
    JViews 5.0
    
    See Also:
    
    Constant Field Values
  - SIMPLE_SCALE_BOTTOM
```
public static final int SIMPLE_SCALE_BOTTOM
```
    Displays graduations on a bottom line.
    
    Since:
    
    JViews 5.0
    
    See Also:
    
    Constant Field Values
  - SCALE_EMPTY
```
public static final int SCALE_EMPTY
```
    Displays graduations with empty rectangles.
    
    Since:
    
    JViews 5.0
    
    See Also:
    
    Constant Field Values
  - DOUBLE_SCALE_EMPTY
```
public static final int DOUBLE_SCALE_EMPTY
```
    Displays two lines of empty rectangles.
    
    Since:
    
    JViews 5.0
    
    See Also:
    
    Constant Field Values
  - UNIQUE_LABEL
```
public static final int UNIQUE_LABEL
```
    A unique label is drawn on the top of the scale bar. This label displays the length of the displayed bar, expressed in cartographic units.
    
    Since:
    
    JViews 5.0
    
    See Also:
    
    Constant Field Values
  - THREE_LABELS
```
public static final int THREE_LABELS
```
    Three labels are drawn on the top of the scale bar. These three labels are the zero, the value of the first graduation, and the value of the last graduation. These labels are only drawn if the size of the scale is large enough.
    
    Since:
    
    JViews 5.0
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - IlvScaleBar
```
public IlvScaleBar()
```
    Creates a new instance of IlvScaleBar. The scale bar is not active until an IlvManagerView is set. The manager of the view should have an IlvCoordinateSystemProperty.
    
    See Also:
    
    setView(ilog.views.IlvManagerView)
- Method Detail
  - setView
```
public void setView(IlvManagerView view)
```
    Specifies the view that controls this component.
    
    Parameters:
    
    view - The view.
  - getView
```
public IlvManagerView getView()
```
    Returns the view whose scale is displayed.
    
    Returns:
    
    The attached view or null if the bean has no attached view.
  - setScaleStyle
```
public void setScaleStyle(int style)
```
    Sets the style used to draw the scale bar.
    
    Parameters:
    
    style - The scale style.
    
    See Also:
    
    SIMPLE_SCALE_CENTER, DASH_SCALE_EVEN, DOUBLE_DASH_SCALE_EVEN, DASH_SCALE_ODD, DOUBLE_DASH_SCALE_ODD, SIMPLE_SCALE_BOTTOM, SCALE_EMPTY, DOUBLE_SCALE_EMPTY
  - getScaleStyle
```
public int getScaleStyle()
```
    Returns the style used to draw the scale bar.
    
    Returns:
    
    The scale style.
  - setScaleTextMode
```
public void setScaleTextMode(int mode)
```
    Sets the label displaying mode.
    
    Parameters:
    
    mode - The text displaying mode.
    
    Since:
    
    JViews 5.0
    
    See Also:
    
    UNIQUE_LABEL, THREE_LABELS
  - getScaleTextMode
```
public int getScaleTextMode()
```
    Returns the text mode.
    
    Returns:
    
    The text mode.
    
    Since:
    
    JViews 5.0
  - setMarginWidth
```
public void setMarginWidth(int margin)
```
    Specifies the minimum horizontal margin that must be left between the scale bar and the border of the component. This value must be greater than 0. The default value is 2 pixels.
    
    Parameters:
    
    margin - The margin width.
  - getMarginWidth
```
public int getMarginWidth()
```
    Returns the minimum margin that must be left between the scale bar and the border of the component.
    
    Returns:
    
    The margin width.
  - setMarginHeight
```
public void setMarginHeight(int margin)
```
    Specifies the vertical margin that must be left between the scale bar and the border of the component. This value must be greater than 0. The default value is 4 pixels.
    
    Parameters:
    
    margin - The margin height.
  - getMarginHeight
```
public int getMarginHeight()
```
    Returns the vertical margin that must be left between the scale bar and the border of the component.
    
    Returns:
    
    The margin height.
  - setTextSpacing
```
public void setTextSpacing(int spacing)
```
    Specifies the text spacing. The text spacing is the number of pixels between the scale text and the scale bar.
    
    Parameters:
    
    spacing - The text spacing.
  - getTextSpacing
```
public int getTextSpacing()
```
    Returns the text spacing.
    
    Returns:
    
    The text spacing.
  - setScaleHeight
```
public void setScaleHeight(int scaleHeight)
```
    Sets the height of the scale bar. The value must be greater than or equal to 1.
    
    Parameters:
    
    scaleHeight - The height.
  - getScaleHeight
```
public int getScaleHeight()
```
    Returns the height of the scale bar.
  - setAlternateScaleColor
```
public void setAlternateScaleColor(Color color)
```
    Sets the alternate scale color. Bicolor scale bar styles (DASH_SCALE_EVEN, DOUBLE_DASH_SCALE_EVEN) use this component foreground as first color and this alternate color as a second color.
    
    Parameters:
    
    color - The color.
  - getAlternateScaleColor
```
public Color getAlternateScaleColor()
```
    Gets the alternate scale color.
    
    Returns:
    
    The alternate scale color.
  - setFarLimit
```
public void setFarLimit(double limit)
```
    Sets the switch limit between a text display of the scale in a small unit (for instance, meters) and a text display in a large unit (for instance, kilometers). If the length of the scale bar expressed in the small units exceeds the limit, then the scale will be displayed in the large unit.
    
    Parameters:
    
    limit - The upper limit.
    
    See Also:
    
    setNearUnit(ilog.views.maps.IlvLinearUnit), setFarUnit(ilog.views.maps.IlvLinearUnit)
  - getFarLimit
```
public double getFarLimit()
```
    Returns the switch limit between a text display of the scale in a small unit (for instance, meters) and a text display in a large unit (for instance, kilometers).
    
    Returns:
    
    The upper limit.
  - setNearUnit
```
public void setNearUnit(IlvLinearUnit unit)
```
    Sets the unit used to display the length of the scale bar for large scales.
    
    Parameters:
    
    unit - The near unit converter.
    
    Since:
    
    JViews 5.0
    
    See Also:
    
    setFarLimit(double), getNearUnit()
  - getNearUnit
```
public IlvLinearUnit getNearUnit()
```
    Returns the unit used to display the length of the scale bar for large scales.
    
    Returns:
    
    The near unit or null if there is no unit.
    
    Since:
    
    JViews 5.0
  - setFarUnit
```
public void setFarUnit(IlvLinearUnit unit)
```
    Sets the unit used to display the length of the scale bar for small scales.
    
    Parameters:
    
    unit - The far unit.
    
    Since:
    
    JViews 5.0
    
    See Also:
    
    setFarLimit(double), getFarUnit()
  - getFarUnit
```
public IlvLinearUnit getFarUnit()
```
    Returns the unit used to display the length of the scale bar for small scales.
    
    Returns:
    
    The far unit or null if there is no unit.
    
    Since:
    
    JViews 5.0
  - getPreferredSize
```
public Dimension getPreferredSize()
```
    Returns the preferred size of the component.
    
    Overrides:
    
    getPreferredSize in class Component
  - getMinimumSize
```
public Dimension getMinimumSize()
```
    Returns the minimum size of the component.
    
    Overrides:
    
    getMinimumSize in class Component
  - setGraphic
```
public void setGraphic(IlvGraphic graphic)
```
    Sets the IlvGraphic that represents the scale part of the IlvScaleBar. If an IlvGraphic is set, then the predefined scales drawings are not used.
    
    Parameters:
    
    graphic - The IlvGraphic that represents the scale part of the IlvScaleBar.
    
    Since:
    
    JViews 5.0
  - getGraphic
```
public IlvGraphic getGraphic()
```
    Returns the IlvGraphic that represents the scale part of the IlvScaleBar.
    
    Since:
    
    JViews 5.0
    
    See Also:
    
    setGraphic(ilog.views.IlvGraphic)
  - paint
```
public void paint(Graphics g)
```
    Draws the component.
    
    Overrides:
    
    paint in class Component
  - setSize
```
public void setSize(int width,
                    int height)
```
    Sets the size for this object.
    
    Overrides:
    
    setSize in class Component
    
    Since:
    
    JViews 5.0

Class IlvScaleBar

Nested Class Summary

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

Field Summary

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

SIMPLE_SCALE_CENTER

DASH_SCALE_EVEN

DOUBLE_DASH_SCALE_EVEN

DASH_SCALE_ODD

DOUBLE_DASH_SCALE_ODD

SIMPLE_SCALE_BOTTOM

SCALE_EMPTY

DOUBLE_SCALE_EMPTY

UNIQUE_LABEL

THREE_LABELS

Constructor Detail

IlvScaleBar

Method Detail

setView

getView

setScaleStyle

getScaleStyle

setScaleTextMode

getScaleTextMode

setMarginWidth

getMarginWidth

setMarginHeight

getMarginHeight

setTextSpacing

getTextSpacing

setScaleHeight

getScaleHeight

setAlternateScaleColor

getAlternateScaleColor

setFarLimit

getFarLimit

setNearUnit

getNearUnit

setFarUnit

getFarUnit

getPreferredSize

getMinimumSize

setGraphic

getGraphic

paint

setSize