com.esri.arcgis.carto
Interface IScaleBar

All Superinterfaces:

IMapSurround, java.io.Serializable

All Known Implementing Classes:

AlternatingScaleBar, DoubleAlternatingScaleBar, HollowScaleBar, IScaleBarProxy, ScaleLine, SingleDivisionScaleBar, SteppedScaleLine

public interface IScaleBar
extends IMapSurround, java.io.Serializable

COM Interface 'IScaleBar'. Generated 3/19/2015 1:20:52 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to members that control the scalebar map surrounds.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID6dfae8e2_ecaa_11d0_8682_0000f8751720
static int	xxDummy Deprecated. Internal use only

Fields inherited from interface com.esri.arcgis.carto.IMapSurround

IIDfe3115e9_ed6c_11d0_8683_0000f8751720

Method Summary

IColor	getBarColor() Color used to draw the bar.
double	getBarHeight() Height of the bar in points (1/72 inch).
double	getDivision() Number of units in one major division.
short	getDivisions() Total number of divisions (including those before zero).
short	getDivisionsBeforeZero() Number of divisions to the left of zero.
int	getLabelFrequency() The label style indicating which marks are labeled.
double	getLabelGap() Vertical gap between the bar and the labels in points (1/72 inch).
int	getLabelPosition() Vertical positioning of the mark labels.
ITextSymbol	getLabelSymbol() Symbol used to draw the labels.
INumberFormat	getNumberFormat() Number format.
int	getResizeHint() Indicates what happens when scale bar is resized.
short	getSubdivisions() Number of subdivisions per major division.
java.lang.String	getUnitLabel() The unit label.
double	getUnitLabelGap() Gap between the scale bar and the unit label in points (1/72 inch).
int	getUnitLabelPosition() Vertical positioning of the unit label.
ITextSymbol	getUnitLabelSymbol() Unit label symbol.
int	getUnits() The units reported.
void	setBarColor(IColor color) Color used to draw the bar.
void	setBarHeight(double points) Height of the bar in points (1/72 inch).
void	setDivision(double units) Number of units in one major division.
void	setDivisions(short count) Total number of divisions (including those before zero).
void	setDivisionsBeforeZero(short count) Number of divisions to the left of zero.
void	setLabelFrequency(int labelFrequency) The label style indicating which marks are labeled.
void	setLabelGap(double points) Vertical gap between the bar and the labels in points (1/72 inch).
void	setLabelPosition(int position) Vertical positioning of the mark labels.
void	setLabelSymbol(ITextSymbol symbol) Symbol used to draw the labels.
void	setNumberFormat(INumberFormat format) Number format.
void	setResizeHint(int hint) Indicates what happens when scale bar is resized.
void	setSubdivisions(short units) Number of subdivisions per major division.
void	setUnitLabel(java.lang.String unitLabel) The unit label.
void	setUnitLabelGap(double points) Gap between the scale bar and the unit label in points (1/72 inch).
void	setUnitLabelPosition(int position) Vertical positioning of the unit label.
void	setUnitLabelSymbol(ITextSymbol symbol) Unit label symbol.
void	setUnits(int units) The units reported.
void	useMapSettings() Sets division and units based on map.

Methods inherited from interface com.esri.arcgis.carto.IMapSurround

delayEvents, draw, fitToBounds, getIcon, getMap, getName, queryBounds, refresh, setMapByRef, setName

Field Detail

IID6dfae8e2_ecaa_11d0_8682_0000f8751720

static final int IID6dfae8e2_ecaa_11d0_8682_0000f8751720

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getDivision

double getDivision()
                   throws java.io.IOException,
                          AutomationException

Number of units in one major division.

Returns:

The units

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDivision

void setDivision(double units)
                 throws java.io.IOException,
                        AutomationException

Number of units in one major division.

Parameters:

units - The units (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDivisions

short getDivisions()
                   throws java.io.IOException,
                          AutomationException

Total number of divisions (including those before zero).

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDivisions

void setDivisions(short count)
                  throws java.io.IOException,
                         AutomationException

Total number of divisions (including those before zero).

Parameters:

count - The count (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDivisionsBeforeZero

short getDivisionsBeforeZero()
                             throws java.io.IOException,
                                    AutomationException

Number of divisions to the left of zero.

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDivisionsBeforeZero

void setDivisionsBeforeZero(short count)
                            throws java.io.IOException,
                                   AutomationException

Number of divisions to the left of zero.

Parameters:

count - The count (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSubdivisions

short getSubdivisions()
                      throws java.io.IOException,
                             AutomationException

Number of subdivisions per major division.

Returns:

The units

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSubdivisions

void setSubdivisions(short units)
                     throws java.io.IOException,
                            AutomationException

Number of subdivisions per major division.

Parameters:

units - The units (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUnits

int getUnits()
             throws java.io.IOException,
                    AutomationException

The units reported.

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUnits

void setUnits(int units)
              throws java.io.IOException,
                     AutomationException

The units reported.

Parameters:

units - A com.esri.arcgis.system.esriUnits constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUnitLabel

java.lang.String getUnitLabel()
                              throws java.io.IOException,
                                     AutomationException

The unit label.

Returns:

The unitLabel

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUnitLabel

void setUnitLabel(java.lang.String unitLabel)
                  throws java.io.IOException,
                         AutomationException

The unit label.

Parameters:

unitLabel - The unitLabel (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUnitLabelPosition

int getUnitLabelPosition()
                         throws java.io.IOException,
                                AutomationException

Vertical positioning of the unit label.

Returns:

A com.esri.arcgis.carto.esriScaleBarPos constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUnitLabelPosition

void setUnitLabelPosition(int position)
                          throws java.io.IOException,
                                 AutomationException

Vertical positioning of the unit label.

Parameters:

position - A com.esri.arcgis.carto.esriScaleBarPos constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUnitLabelGap

double getUnitLabelGap()
                       throws java.io.IOException,
                              AutomationException

Gap between the scale bar and the unit label in points (1/72 inch).

Returns:

The points

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUnitLabelGap

void setUnitLabelGap(double points)
                     throws java.io.IOException,
                            AutomationException

Gap between the scale bar and the unit label in points (1/72 inch).

Parameters:

points - The points (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUnitLabelSymbol

ITextSymbol getUnitLabelSymbol()
                               throws java.io.IOException,
                                      AutomationException

Unit label symbol.

Returns:

A reference to a com.esri.arcgis.display.ITextSymbol

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUnitLabelSymbol

void setUnitLabelSymbol(ITextSymbol symbol)
                        throws java.io.IOException,
                               AutomationException

Unit label symbol.

Parameters:

symbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabelFrequency

int getLabelFrequency()
                      throws java.io.IOException,
                             AutomationException

The label style indicating which marks are labeled.

Returns:

A com.esri.arcgis.carto.esriScaleBarFrequency constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelFrequency

void setLabelFrequency(int labelFrequency)
                       throws java.io.IOException,
                              AutomationException

The label style indicating which marks are labeled.

Parameters:

labelFrequency - A com.esri.arcgis.carto.esriScaleBarFrequency constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumberFormat

INumberFormat getNumberFormat()
                              throws java.io.IOException,
                                     AutomationException

Number format.

Returns:

A reference to a com.esri.arcgis.system.INumberFormat

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNumberFormat

void setNumberFormat(INumberFormat format)
                     throws java.io.IOException,
                            AutomationException

Number format.

Parameters:

format - A reference to a com.esri.arcgis.system.INumberFormat (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabelPosition

int getLabelPosition()
                     throws java.io.IOException,
                            AutomationException

Vertical positioning of the mark labels.

Returns:

A com.esri.arcgis.carto.esriVertPosEnum constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelPosition

void setLabelPosition(int position)
                      throws java.io.IOException,
                             AutomationException

Vertical positioning of the mark labels.

Parameters:

position - A com.esri.arcgis.carto.esriVertPosEnum constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabelGap

double getLabelGap()
                   throws java.io.IOException,
                          AutomationException

Vertical gap between the bar and the labels in points (1/72 inch).

Returns:

The points

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelGap

void setLabelGap(double points)
                 throws java.io.IOException,
                        AutomationException

Vertical gap between the bar and the labels in points (1/72 inch).

Parameters:

points - The points (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabelSymbol

ITextSymbol getLabelSymbol()
                           throws java.io.IOException,
                                  AutomationException

Symbol used to draw the labels.

Returns:

A reference to a com.esri.arcgis.display.ITextSymbol

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelSymbol

void setLabelSymbol(ITextSymbol symbol)
                    throws java.io.IOException,
                           AutomationException

Symbol used to draw the labels.

Parameters:

symbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBarColor

IColor getBarColor()
                   throws java.io.IOException,
                          AutomationException

Color used to draw the bar.

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBarColor

void setBarColor(IColor color)
                 throws java.io.IOException,
                        AutomationException

Color used to draw the bar.

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBarHeight

double getBarHeight()
                    throws java.io.IOException,
                           AutomationException

Height of the bar in points (1/72 inch).

Returns:

The points

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBarHeight

void setBarHeight(double points)
                  throws java.io.IOException,
                         AutomationException

Height of the bar in points (1/72 inch).

Parameters:

points - The points (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getResizeHint

int getResizeHint()
                  throws java.io.IOException,
                         AutomationException

Indicates what happens when scale bar is resized.

Returns:

A com.esri.arcgis.carto.esriScaleBarResizeHint constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setResizeHint

void setResizeHint(int hint)
                   throws java.io.IOException,
                          AutomationException

Indicates what happens when scale bar is resized.

Parameters:

hint - A com.esri.arcgis.carto.esriScaleBarResizeHint constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

useMapSettings

void useMapSettings()
                    throws java.io.IOException,
                           AutomationException

Sets division and units based on map.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.