com.esri.arcgis.carto
Class ScaleText

java.lang.Object
  com.esri.arcgis.carto.ScaleText

All Implemented Interfaces:

IBoundsProperties, IGraphicsComposite, IMapSurround, IQuerySize, IScaleText, IScaleText2, IConnectionPointContainer, ITransformEvents, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IPropertySupport, Externalizable, Serializable, EventListener

public class ScaleText
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IScaleText, IScaleText2, IMapSurround, IGraphicsComposite, IQuerySize, IBoundsProperties, IConnectionPointContainer, IPropertySupport, ITransformEvents, IPersistStream, IPersist, IClone, Externalizable

A map surround for displaying a scale text.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

ScaleText()
Constructs a ScaleText using ArcGIS Engine.

ScaleText(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ScaleText theScaleText = (ScaleText) obj;

Method Summary

void	addIMapSurroundEventsListener(IMapSurroundEvents theListener) addIMapSurroundEventsListener.
boolean	applies(Object pUnk) Indicates if the receiver can apply the given object at any given time.
Object	apply(Object newObject) Applies the given property to the receiver and returns the old object.
void	assign(IClone src) Assigns the properties of src to the receiver.
void	boundsUpdated(ITransformEventsBoundsUpdatedEvent theEvent) Notifies clients when the bounds is updated.
boolean	canApply(Object pUnk) Indicates if the receiver can apply the given object at that particular moment.
void	delayEvents(boolean delay) Used to batch operations together to minimize notifications.
void	deviceFrameUpdated(ITransformEventsDeviceFrameUpdatedEvent theEvent) Notifies clients when the device frame is updated.
void	draw(IDisplay display, ITrackCancel trackCancel, IEnvelope bounds) Draws the map surround into the specified display bounds.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
void	fitToBounds(IDisplay display, IEnvelope bounds, boolean[] changed) Adjusts the map surround to fit the bounds.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
Object	getCurrent(Object pUnk) The object currently being used.
String	getFormat() Format of the scale text.
IEnumElement	getGraphics(IDisplay display, Object data) Graphic elements that are used to render this object.
int	getIcon() Icon used to represent the map surround.
IMap	getMap() The parent map.
String	getMapUnitLabel() Map unit label of the scale text.
int	getMapUnits() Map units of the scale text.
String	getName() Name of the map surround.
INumberFormat	getNumberFormat() Number formatting.
String	getPageUnitLabel() Page unit label of the scale text.
int	getPageUnits() Page units of the scale text.
String	getSeparator() Character(s) used to separate '1' from the scale in an absolute scale, i.e., the ':' in 1:20000.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	getStyle() Style of the scale text.
ITextSymbol	getSymbol() Symbol of the scale text.
String	getText() The scale text.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isFixedAspectRatio() Indicates if the bounds has a fixed aspect ratio.
boolean	isFixedSize() Indicates if size is determined by some other property like the symbol.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
void	load(IStream pstm) load
void	queryBounds(IDisplay display, IEnvelope oldBounds, IEnvelope newBounds) Returns the bounds of the map surround.
void	querySize(double[] widthPoints, double[] heightPoints) Get the size in points.
void	readExternal(ObjectInput in)
void	refresh() Makes sure the latest updates are refected the next time the Map Surround is drawn.
void	removeIMapSurroundEventsListener(IMapSurroundEvents theListener) removeIMapSurroundEventsListener.
void	resolutionUpdated(ITransformEventsResolutionUpdatedEvent theEvent) Notifies clients when the resolution is updated.
void	rotationUpdated(ITransformEventsRotationUpdatedEvent theEvent) Notifies clients when the rotation angle is updated.
void	save(IStream pstm, int fClearDirty) save
void	setFixedAspectRatio(boolean flag) Indicates if the bounds has a fixed aspect ratio.
void	setFormat(String format) Format of the scale text.
void	setMapByRef(IMap map) The parent map.
void	setMapUnitLabel(String label) Map unit label of the scale text.
void	setMapUnits(int units) Map units of the scale text.
void	setName(String name) Name of the map surround.
void	setNumberFormat(INumberFormat format) Number formatting.
void	setPageUnitLabel(String label) Page unit label of the scale text.
void	setPageUnits(int units) Page units of the scale text.
void	setSeparator(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.
void	unitsUpdated(ITransformEventsUnitsUpdatedEvent theEvent) Notifies clients when the units are updated.
void	visibleBoundsUpdated(ITransformEventsVisibleBoundsUpdatedEvent theEvent) Notifies clients when the visible bounds is updated.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

ScaleText

public ScaleText()
          throws IOException,
                 UnknownHostException

Constructs a ScaleText using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ScaleText

public ScaleText(Object obj)
          throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ScaleText theScaleText = (ScaleText) obj;

Construct a ScaleText using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ScaleText.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

addIMapSurroundEventsListener

public void addIMapSurroundEventsListener(IMapSurroundEvents theListener)
                                   throws IOException

addIMapSurroundEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.carto.IMapSurroundEvents interface.

Throws:

IOException - If there are communications problems.

removeIMapSurroundEventsListener

public void removeIMapSurroundEventsListener(IMapSurroundEvents theListener)
                                      throws IOException

removeIMapSurroundEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.carto.IMapSurroundEvents interface.

Throws:

IOException - If there are communications problems.

getText

public String getText()
               throws IOException,
                      AutomationException

The scale text.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getText in interface IScaleText

Specified by:

getText in interface IScaleText2

Returns:

The text

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSymbol

public void setSymbol(ITextSymbol symbol)
               throws IOException,
                      AutomationException

Symbol of the scale text.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSymbol in interface IScaleText

Specified by:

setSymbol in interface IScaleText2

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSymbol

public ITextSymbol getSymbol()
                      throws IOException,
                             AutomationException

Symbol of the scale text.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSymbol in interface IScaleText

Specified by:

getSymbol in interface IScaleText2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStyle

public void setStyle(int style)
              throws IOException,
                     AutomationException

Style of the scale text.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setStyle in interface IScaleText

Specified by:

setStyle in interface IScaleText2

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStyle

public int getStyle()
             throws IOException,
                    AutomationException

Style of the scale text.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getStyle in interface IScaleText

Specified by:

getStyle in interface IScaleText2

Returns:

A com.esri.arcgis.carto.esriScaleTextStyleEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFormat

public void setFormat(String format)
               throws IOException,
                      AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFormat in interface IScaleText

Specified by:

setFormat in interface IScaleText2

Parameters:

format - The format (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFormat

public String getFormat()
                 throws IOException,
                        AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFormat in interface IScaleText

Specified by:

getFormat in interface IScaleText2

Returns:

The format

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPageUnits

public void setPageUnits(int units)
                  throws IOException,
                         AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPageUnits in interface IScaleText

Specified by:

setPageUnits in interface IScaleText2

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPageUnits

public int getPageUnits()
                 throws IOException,
                        AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPageUnits in interface IScaleText

Specified by:

getPageUnits in interface IScaleText2

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMapUnits

public void setMapUnits(int units)
                 throws IOException,
                        AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMapUnits in interface IScaleText

Specified by:

setMapUnits in interface IScaleText2

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapUnits

public int getMapUnits()
                throws IOException,
                       AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMapUnits in interface IScaleText

Specified by:

getMapUnits in interface IScaleText2

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPageUnitLabel

public void setPageUnitLabel(String label)
                      throws IOException,
                             AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPageUnitLabel in interface IScaleText

Specified by:

setPageUnitLabel in interface IScaleText2

Parameters:

label - The label (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPageUnitLabel

public String getPageUnitLabel()
                        throws IOException,
                               AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPageUnitLabel in interface IScaleText

Specified by:

getPageUnitLabel in interface IScaleText2

Returns:

The label

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMapUnitLabel

public void setMapUnitLabel(String label)
                     throws IOException,
                            AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMapUnitLabel in interface IScaleText

Specified by:

setMapUnitLabel in interface IScaleText2

Parameters:

label - The label (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapUnitLabel

public String getMapUnitLabel()
                       throws IOException,
                              AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMapUnitLabel in interface IScaleText

Specified by:

getMapUnitLabel in interface IScaleText2

Returns:

The label

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNumberFormat

public void setNumberFormat(INumberFormat format)
                     throws IOException,
                            AutomationException

Number formatting.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setNumberFormat in interface IScaleText

Specified by:

setNumberFormat in interface IScaleText2

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumberFormat

public INumberFormat getNumberFormat()
                              throws IOException,
                                     AutomationException

Number formatting.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNumberFormat in interface IScaleText

Specified by:

getNumberFormat in interface IScaleText2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMap

public IMap getMap()
            throws IOException,
                   AutomationException

The parent map.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMap in interface IMapSurround

Returns:

A reference to a com.esri.arcgis.carto.IMap

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMapByRef

public void setMapByRef(IMap map)
                 throws IOException,
                        AutomationException

The parent map.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMapByRef in interface IMapSurround

Parameters:

map - A reference to a com.esri.arcgis.carto.IMap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

Name of the map surround.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IMapSurround

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String name)
             throws IOException,
                    AutomationException

Name of the map surround.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface IMapSurround

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIcon

public int getIcon()
            throws IOException,
                   AutomationException

Icon used to represent the map surround.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getIcon in interface IMapSurround

Returns:

The hIcon (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryBounds

public void queryBounds(IDisplay display,
                        IEnvelope oldBounds,
                        IEnvelope newBounds)
                 throws IOException,
                        AutomationException

Returns the bounds of the map surround.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

queryBounds in interface IMapSurround

Parameters:

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

oldBounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

newBounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

fitToBounds

public void fitToBounds(IDisplay display,
                        IEnvelope bounds,
                        boolean[] changed)
                 throws IOException,
                        AutomationException

Adjusts the map surround to fit the bounds. The changed argument indicates whether the size of the map surround was changed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

fitToBounds in interface IMapSurround

Parameters:

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

bounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

changed - The changed (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

delayEvents

public void delayEvents(boolean delay)
                 throws IOException,
                        AutomationException

Used to batch operations together to minimize notifications.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

delayEvents in interface IMapSurround

Parameters:

delay - The delay (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

public void refresh()
             throws IOException,
                    AutomationException

Makes sure the latest updates are refected the next time the Map Surround is drawn.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

refresh in interface IMapSurround

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

draw

public void draw(IDisplay display,
                 ITrackCancel trackCancel,
                 IEnvelope bounds)
          throws IOException,
                 AutomationException

Draws the map surround into the specified display bounds.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

draw in interface IMapSurround

Parameters:

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

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

bounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSeparator

public void setSeparator(String separator)
                  throws 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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setSeparator in interface IScaleText2

Parameters:

separator - The separator (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSeparator

public String getSeparator()
                    throws 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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getSeparator in interface IScaleText2

Returns:

The separator

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGraphics

public IEnumElement getGraphics(IDisplay display,
                                Object data)
                         throws IOException,
                                AutomationException

Graphic elements that are used to render this object. The data argument is defined by the coclass that implements this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getGraphics in interface IGraphicsComposite

Parameters:

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

data - A reference to another Object (IUnknown) (in)

Returns:

A reference to a com.esri.arcgis.carto.IEnumElement

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

querySize

public void querySize(double[] widthPoints,
                      double[] heightPoints)
               throws IOException,
                      AutomationException

Get the size in points.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

querySize in interface IQuerySize

Parameters:

widthPoints - The widthPoints (in/out: use single element array)

heightPoints - The heightPoints (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFixedAspectRatio

public boolean isFixedAspectRatio()
                           throws IOException,
                                  AutomationException

Indicates if the bounds has a fixed aspect ratio.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isFixedAspectRatio in interface IBoundsProperties

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFixedAspectRatio

public void setFixedAspectRatio(boolean flag)
                         throws IOException,
                                AutomationException

Indicates if the bounds has a fixed aspect ratio.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFixedAspectRatio in interface IBoundsProperties

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFixedSize

public boolean isFixedSize()
                    throws IOException,
                           AutomationException

Indicates if size is determined by some other property like the symbol.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isFixedSize in interface IBoundsProperties

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws IOException,
                                 AutomationException

enumConnectionPoints

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws IOException,
                                AutomationException

findConnectionPoint

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

findConnectionPoint in interface IConnectionPointContainer

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

applies

public boolean applies(Object pUnk)
                throws IOException,
                       AutomationException

Indicates if the receiver can apply the given object at any given time.

Remarks

Applies indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.

CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

applies in interface IPropertySupport

Parameters:

pUnk - A reference to another Object (IUnknown) (in)

Returns:

The applies

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canApply

public boolean canApply(Object pUnk)
                 throws IOException,
                        AutomationException

Indicates if the receiver can apply the given object at that particular moment.

Remarks

CanApply indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.

CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

canApply in interface IPropertySupport

Parameters:

pUnk - A reference to another Object (IUnknown) (in)

Returns:

The canApply

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrent

public Object getCurrent(Object pUnk)
                  throws IOException,
                         AutomationException

The object currently being used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getCurrent in interface IPropertySupport

Parameters:

pUnk - A reference to another Object (IUnknown) (in)

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

apply

public Object apply(Object newObject)
             throws IOException,
                    AutomationException

Applies the given property to the receiver and returns the old object.

Remarks

Apply will apply the specified object to the current object. For instance, I might apply a Color object to my RectangleElement. When I execute Apply, the object I replace (the old object) is returned.

Use the Applies and CanApply methods to determine if an Apply can be used on an object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

apply in interface IPropertySupport

Parameters:

newObject - A reference to another Object (IUnknown) (in)

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

boundsUpdated

public void boundsUpdated(ITransformEventsBoundsUpdatedEvent theEvent)
                   throws IOException,
                          AutomationException

Notifies clients when the bounds is updated.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

boundsUpdated in interface ITransformEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

visibleBoundsUpdated

public void visibleBoundsUpdated(ITransformEventsVisibleBoundsUpdatedEvent theEvent)
                          throws IOException,
                                 AutomationException

Notifies clients when the visible bounds is updated.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

visibleBoundsUpdated in interface ITransformEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deviceFrameUpdated

public void deviceFrameUpdated(ITransformEventsDeviceFrameUpdatedEvent theEvent)
                        throws IOException,
                               AutomationException

Notifies clients when the device frame is updated.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

deviceFrameUpdated in interface ITransformEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resolutionUpdated

public void resolutionUpdated(ITransformEventsResolutionUpdatedEvent theEvent)
                       throws IOException,
                              AutomationException

Notifies clients when the resolution is updated.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

resolutionUpdated in interface ITransformEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

rotationUpdated

public void rotationUpdated(ITransformEventsRotationUpdatedEvent theEvent)
                     throws IOException,
                            AutomationException

Notifies clients when the rotation angle is updated.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

rotationUpdated in interface ITransformEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

unitsUpdated

public void unitsUpdated(ITransformEventsUnitsUpdatedEvent theEvent)
                  throws IOException,
                         AutomationException

Notifies clients when the units are updated.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

unitsUpdated in interface ITransformEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException