com.esri.arcgis.carto
Interface IScaleText2

All Superinterfaces:

IMapSurround, java.io.Serializable

All Known Implementing Classes:

IScaleText2Proxy, ScaleText

public interface IScaleText2
extends IMapSurround, java.io.Serializable

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

Description: 'Provides access to members that control the scale text.' 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	IIDa2fe2d0c_bd0e_452f_b903_c6a80ffc94e6
static int	xxDummy Deprecated. Internal use only

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

IIDfe3115e9_ed6c_11d0_8683_0000f8751720

Method Summary

java.lang.String	getFormat() Format of the scale text.
java.lang.String	getMapUnitLabel() Map unit label of the scale text.
int	getMapUnits() Map units of the scale text.
INumberFormat	getNumberFormat() Number formatting.
java.lang.String	getPageUnitLabel() Page unit label of the scale text.
int	getPageUnits() Page units of the scale text.
java.lang.String	getSeparator() Character(s) used to separate '1' from the scale in an absolute scale, i.e., the ':' in 1:20000.
int	getStyle() Style of the scale text.
ITextSymbol	getSymbol() Symbol of the scale text.
java.lang.String	getText() The scale text.
void	setFormat(java.lang.String format) Format of the scale text.
void	setMapUnitLabel(java.lang.String label) Map unit label of the scale text.
void	setMapUnits(int units) Map units of the scale text.
void	setNumberFormat(INumberFormat format) Number formatting.
void	setPageUnitLabel(java.lang.String label) Page unit label of the scale text.
void	setPageUnits(int units) Page units of the scale text.
void	setSeparator(java.lang.String separator) Character(s) used to separate '1' from the scale in an absolute scale, i.e., the ':' in 1:20000.
void	setStyle(int style) Style of the scale text.
void	setSymbol(ITextSymbol symbol) Symbol of the scale text.

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

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

Field Detail

IIDa2fe2d0c_bd0e_452f_b903_c6a80ffc94e6

static final int IIDa2fe2d0c_bd0e_452f_b903_c6a80ffc94e6

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

getText

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

The scale text.

Returns:

The text

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSymbol

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

Symbol of the scale text.

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.

getSymbol

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

Symbol of the scale text.

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.

setStyle

void setStyle(int style)
              throws java.io.IOException,
                     AutomationException

Style of the scale text.

Parameters:

style - A com.esri.arcgis.carto.esriScaleTextStyleEnum constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStyle

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

Style of the scale text.

Returns:

A com.esri.arcgis.carto.esriScaleTextStyleEnum constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFormat

void setFormat(java.lang.String format)
               throws java.io.IOException,
                      AutomationException

Format of the scale text. Style must be set to custom.

Parameters:

format - The format (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFormat

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

Format of the scale text. Style must be set to custom.

Returns:

The format

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPageUnits

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

Page units of the scale text. Style must be set to custom.

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.

getPageUnits

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

Page units of the scale text. Style must be set to custom.

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.

setMapUnits

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

Map units of the scale text. Style must be set to custom.

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.

getMapUnits

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

Map units of the scale text. Style must be set to custom.

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.

setPageUnitLabel

void setPageUnitLabel(java.lang.String label)
                      throws java.io.IOException,
                             AutomationException

Page unit label of the scale text. Style must be set to relative.

Parameters:

label - The label (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPageUnitLabel

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

Page unit label of the scale text. Style must be set to relative.

Returns:

The label

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMapUnitLabel

void setMapUnitLabel(java.lang.String label)
                     throws java.io.IOException,
                            AutomationException

Map unit label of the scale text. Style must be set to relative.

Parameters:

label - The label (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMapUnitLabel

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

Map unit label of the scale text. Style must be set to relative.

Returns:

The label

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

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.

getNumberFormat

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

Number formatting.

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.

setSeparator

void setSeparator(java.lang.String separator)
                  throws java.io.IOException,
                         AutomationException

Character(s) used to separate '1' from the scale in an absolute scale, i.e., the ':' in 1:20000. Also used for 'equals' in relative scale texts.

Parameters:

separator - The separator (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSeparator

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

Character(s) used to separate '1' from the scale in an absolute scale, i.e., the ':' in 1:20000. Also used for 'equals' in relative scale texts.

Returns:

The separator

Throws:

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

AutomationException - If the ArcObject component throws an exception.