com.esri.arcgis.carto
Class IScaleBarProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.carto.IMapSurroundProxy
          com.esri.arcgis.carto.IScaleBarProxy

All Implemented Interfaces:

IMapSurround, IScaleBar, java.io.Externalizable, java.io.Serializable

Deprecated. Internal use only. Proxy for 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 =

public class IScaleBarProxy
extends IMapSurroundProxy
implements IScaleBar, java.io.Serializable

Internal use class

See Also:

Serialized Form

Field Summary

boolean	noncastable Deprecated.
static java.lang.Class	targetClass Deprecated.

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

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

IID, IID6dfae8e2_ecaa_11d0_8682_0000f8751720

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

IIDfe3115e9_ed6c_11d0_8683_0000f8751720

Constructor Summary

	IScaleBarProxy() Deprecated. For internal use only
	IScaleBarProxy(java.lang.Object obj) Deprecated.
protected	IScaleBarProxy(java.lang.Object obj, java.lang.String iid) Deprecated.
	IScaleBarProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo) Deprecated.
protected	IScaleBarProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo) Deprecated.

Method Summary

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

Methods inherited from class com.esri.arcgis.carto.IMapSurroundProxy

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

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

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

Field Detail

targetClass

public static final java.lang.Class targetClass

Deprecated.

noncastable

public boolean noncastable

Deprecated.

Constructor Detail

IScaleBarProxy

public IScaleBarProxy(java.lang.String CLSID,
                      java.lang.String host,
                      com.esri.arcgis.interop.AuthInfo authInfo)
               throws java.net.UnknownHostException,
                      java.io.IOException

Deprecated.

Throws:

java.net.UnknownHostException

java.io.IOException

IScaleBarProxy

public IScaleBarProxy()

Deprecated.

For internal use only

IScaleBarProxy

public IScaleBarProxy(java.lang.Object obj)
               throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

IScaleBarProxy

protected IScaleBarProxy(java.lang.Object obj,
                         java.lang.String iid)
                  throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

IScaleBarProxy

protected IScaleBarProxy(java.lang.String CLSID,
                         java.lang.String iid,
                         java.lang.String host,
                         com.esri.arcgis.interop.AuthInfo authInfo)
                  throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException

Deprecated.

Overrides:

addListener in class IMapSurroundProxy

Throws:

java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException

Deprecated.

Overrides:

removeListener in class IMapSurroundProxy

Throws:

java.io.IOException

getDivision

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

Deprecated.

Number of units in one major division.

Specified by:

getDivision in interface IScaleBar

Returns:

The units

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDivision

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

Deprecated.

Number of units in one major division.

Specified by:

setDivision in interface IScaleBar

Parameters:

units - The units (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDivisions

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

Deprecated.

Total number of divisions (including those before zero).

Specified by:

getDivisions in interface IScaleBar

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDivisions

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

Deprecated.

Total number of divisions (including those before zero).

Specified by:

setDivisions in interface IScaleBar

Parameters:

count - The count (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDivisionsBeforeZero

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

Deprecated.

Number of divisions to the left of zero.

Specified by:

getDivisionsBeforeZero in interface IScaleBar

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDivisionsBeforeZero

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

Deprecated.

Number of divisions to the left of zero.

Specified by:

setDivisionsBeforeZero in interface IScaleBar

Parameters:

count - The count (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSubdivisions

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

Deprecated.

Number of subdivisions per major division.

Specified by:

getSubdivisions in interface IScaleBar

Returns:

The units

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSubdivisions

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

Deprecated.

Number of subdivisions per major division.

Specified by:

setSubdivisions in interface IScaleBar

Parameters:

units - The units (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getUnits

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

Deprecated.

The units reported.

Specified by:

getUnits in interface IScaleBar

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

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

Deprecated.

The units reported.

Specified by:

setUnits in interface IScaleBar

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

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

Deprecated.

The unit label.

Specified by:

getUnitLabel in interface IScaleBar

Returns:

The unitLabel

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUnitLabel

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

Deprecated.

The unit label.

Specified by:

setUnitLabel in interface IScaleBar

Parameters:

unitLabel - The unitLabel (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getUnitLabelPosition

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

Deprecated.

Vertical positioning of the unit label.

Specified by:

getUnitLabelPosition in interface IScaleBar

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

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

Deprecated.

Vertical positioning of the unit label.

Specified by:

setUnitLabelPosition in interface IScaleBar

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

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

Deprecated.

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

Specified by:

getUnitLabelGap in interface IScaleBar

Returns:

The points

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUnitLabelGap

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

Deprecated.

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

Specified by:

setUnitLabelGap in interface IScaleBar

Parameters:

points - The points (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getUnitLabelSymbol

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

Deprecated.

Unit label symbol.

Specified by:

getUnitLabelSymbol in interface IScaleBar

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

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

Deprecated.

Unit label symbol.

Specified by:

setUnitLabelSymbol in interface IScaleBar

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

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

Deprecated.

The label style indicating which marks are labeled.

Specified by:

getLabelFrequency in interface IScaleBar

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

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

Deprecated.

The label style indicating which marks are labeled.

Specified by:

setLabelFrequency in interface IScaleBar

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

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

Deprecated.

Number format.

Specified by:

getNumberFormat in interface IScaleBar

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

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

Deprecated.

Number format.

Specified by:

setNumberFormat in interface IScaleBar

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

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

Deprecated.

Vertical positioning of the mark labels.

Specified by:

getLabelPosition in interface IScaleBar

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

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

Deprecated.

Vertical positioning of the mark labels.

Specified by:

setLabelPosition in interface IScaleBar

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

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

Deprecated.

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

Specified by:

getLabelGap in interface IScaleBar

Returns:

The points

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLabelGap

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

Deprecated.

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

Specified by:

setLabelGap in interface IScaleBar

Parameters:

points - The points (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLabelSymbol

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

Deprecated.

Symbol used to draw the labels.

Specified by:

getLabelSymbol in interface IScaleBar

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

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

Deprecated.

Symbol used to draw the labels.

Specified by:

setLabelSymbol in interface IScaleBar

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

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

Deprecated.

Color used to draw the bar.

Specified by:

getBarColor in interface IScaleBar

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

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

Deprecated.

Color used to draw the bar.

Specified by:

setBarColor in interface IScaleBar

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

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

Deprecated.

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

Specified by:

getBarHeight in interface IScaleBar

Returns:

The points

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBarHeight

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

Deprecated.

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

Specified by:

setBarHeight in interface IScaleBar

Parameters:

points - The points (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getResizeHint

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

Deprecated.

Indicates what happens when scale bar is resized.

Specified by:

getResizeHint in interface IScaleBar

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

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

Deprecated.

Indicates what happens when scale bar is resized.

Specified by:

setResizeHint in interface IScaleBar

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

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

Deprecated.

Sets division and units based on map.

Specified by:

useMapSettings in interface IScaleBar

Throws:

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

AutomationException - If the ArcObject component throws an exception.