com.esri.arcgis.carto
Class AlternatingScaleBar

java.lang.Object
  extended by com.esri.arcgis.carto.AlternatingScaleBar
All Implemented Interfaces:
IBoundsProperties, IDoubleFillScaleBar, IGraphicsComposite, IMapSurround, IQuerySize, IScaleBar, IScaleMarks, IConnectionPointContainer, ITransformEvents, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IPropertySupport, IXMLSerialize, Externalizable, Serializable, EventListener

public class AlternatingScaleBar
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IScaleBar, IDoubleFillScaleBar, IScaleMarks, IMapSurround, IQuerySize, IBoundsProperties, IConnectionPointContainer, IGraphicsComposite, IPropertySupport, ITransformEvents, IPersistStream, IPersist, IClone, IXMLSerialize, Externalizable

A map surround for displaying a single alternating scale bar.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
AlternatingScaleBar()
          Constructs a AlternatingScaleBar using ArcGIS Engine.
AlternatingScaleBar(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AlternatingScaleBar theAlternatingScaleBar = (AlternatingScaleBar) 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 deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 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.
 IColor getBarColor()
          Color used to draw the bar.
 double getBarHeight()
          Height of the bar in points (1/72 inch).
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 Object getCurrent(Object pUnk)
          The object currently being used.
 double getDivision()
          Number of units in one major division.
 double getDivisionMarkHeight()
          Height of division marks in points (1/72 inch).
 ILineSymbol getDivisionMarkSymbol()
          Symbol used to draw the division marks.
 short getDivisions()
          Total number of divisions (including those before zero).
 short getDivisionsBeforeZero()
          Number of divisions to the left of zero.
 IFillSymbol getFillSymbol1()
          Symbol used to draw the bar.
 IFillSymbol getFillSymbol2()
          Symbol used to draw the bar.
 IEnumElement getGraphics(IDisplay display, Object data)
          Graphic elements that are used to render this object.
 int getIcon()
          Icon used to represent the map surround.
 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.
 IMap getMap()
          The parent map.
 int getMarkFrequency()
          Mark frequency.
 int getMarkPosition()
          Vertical positioning of the marks relative to the bar.
 String getName()
          Name of the map surround.
 INumberFormat getNumberFormat()
          Number format.
 int getResizeHint()
          Indicates what happens when scale bar is resized.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 double getSubdivisionMarkHeight()
          Height of subdivision marks in points (1/72 inch).
 ILineSymbol getSubdivisionMarkSymbol()
          Symbol used to draw the subdivision marks.
 short getSubdivisions()
          Number of subdivisions per major division.
 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.
 int hashCode()
          the hashcode for this object
 void isDirty()
          isDirty
 boolean isEqual(IClone other)
          Returns TRUE when 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)
          Returns TRUE when 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 serialize(IXMLSerializeData data)
          Serializes an object to XML.
 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 setDivisionMarkHeight(double points)
          Height of division marks in points (1/72 inch).
 void setDivisionMarkSymbol(ILineSymbol symbol)
          Symbol used to draw the division marks.
 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 setFillSymbol1(IFillSymbol symbol)
          Symbol used to draw the bar.
 void setFillSymbol2(IFillSymbol symbol)
          Symbol used to draw the bar.
 void setFixedAspectRatio(boolean flag)
          Indicates if the bounds has a fixed aspect ratio.
 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 setMapByRef(IMap map)
          The parent map.
 void setMarkFrequency(int frequency)
          Mark frequency.
 void setMarkPosition(int position)
          Vertical positioning of the marks relative to the bar.
 void setName(String name)
          Name of the map surround.
 void setNumberFormat(INumberFormat format)
          Number format.
 void setResizeHint(int hint)
          Indicates what happens when scale bar is resized.
 void setSubdivisionMarkHeight(double points)
          Height of subdivision marks in points (1/72 inch).
 void setSubdivisionMarkSymbol(ILineSymbol symbol)
          Symbol used to draw the subdivision marks.
 void setSubdivisions(short units)
          Number of subdivisions per major division.
 void setUnitLabel(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 unitsUpdated(ITransformEventsUnitsUpdatedEvent theEvent)
          Notifies clients when the units are updated.
 void useMapSettings()
          Sets division and units based on map.
 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

AlternatingScaleBar

public AlternatingScaleBar()
                    throws IOException,
                           UnknownHostException
Constructs a AlternatingScaleBar using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

AlternatingScaleBar

public AlternatingScaleBar(Object obj)
                    throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AlternatingScaleBar theAlternatingScaleBar = (AlternatingScaleBar) obj;

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

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.

getDivision

public double getDivision()
                   throws IOException,
                          AutomationException
Number of units in one major division.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDivision in interface IScaleBar
Returns:
The units
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDivision

public void setDivision(double units)
                 throws IOException,
                        AutomationException
Number of units in one major division.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDivision in interface IScaleBar
Parameters:
units - The units (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDivisions

public short getDivisions()
                   throws IOException,
                          AutomationException
Total number of divisions (including those before zero).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDivisions in interface IScaleBar
Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDivisions

public void setDivisions(short count)
                  throws IOException,
                         AutomationException
Total number of divisions (including those before zero).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDivisions in interface IScaleBar
Parameters:
count - The count (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDivisionsBeforeZero

public short getDivisionsBeforeZero()
                             throws IOException,
                                    AutomationException
Number of divisions to the left of zero.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDivisionsBeforeZero in interface IScaleBar
Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDivisionsBeforeZero

public void setDivisionsBeforeZero(short count)
                            throws IOException,
                                   AutomationException
Number of divisions to the left of zero.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDivisionsBeforeZero in interface IScaleBar
Parameters:
count - The count (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSubdivisions

public short getSubdivisions()
                      throws IOException,
                             AutomationException
Number of subdivisions per major division.

Description

Subdivisions is the number of subdivisions displayed in the leftmost interval.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSubdivisions in interface IScaleBar
Returns:
The units
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSubdivisions

public void setSubdivisions(short units)
                     throws IOException,
                            AutomationException
Number of subdivisions per major division.

Description

Subdivisions is the number of subdivisions displayed in the leftmost interval.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSubdivisions in interface IScaleBar
Parameters:
units - The units (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUnits

public int getUnits()
             throws IOException,
                    AutomationException
The units reported.

Description

Units is the type of distance units (miles, kilometers, etc.) a scalebar displays the interval distances. This unit does not have to be the same as the the units of the data frame that a scalebar is associated with.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getUnits in interface IScaleBar
Returns:
A com.esri.arcgis.system.esriUnits constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUnits

public void setUnits(int units)
              throws IOException,
                     AutomationException
The units reported.

Description

Units is the type of distance units (miles, kilometers, etc.) a scalebar displays the interval distances. This unit does not have to be the same as the the units of the data frame that a scalebar is associated with.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setUnits in interface IScaleBar
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.

getUnitLabel

public String getUnitLabel()
                    throws IOException,
                           AutomationException
The unit label.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getUnitLabel in interface IScaleBar
Returns:
The unitLabel
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUnitLabel

public void setUnitLabel(String unitLabel)
                  throws IOException,
                         AutomationException
The unit label.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setUnitLabel in interface IScaleBar
Parameters:
unitLabel - The unitLabel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUnitLabelPosition

public int getUnitLabelPosition()
                         throws IOException,
                                AutomationException
Vertical positioning of the unit label.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getUnitLabelPosition in interface IScaleBar
Returns:
A com.esri.arcgis.carto.esriScaleBarPos constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUnitLabelPosition

public void setUnitLabelPosition(int position)
                          throws IOException,
                                 AutomationException
Vertical positioning of the unit label.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setUnitLabelPosition in interface IScaleBar
Parameters:
position - A com.esri.arcgis.carto.esriScaleBarPos constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUnitLabelGap

public double getUnitLabelGap()
                       throws IOException,
                              AutomationException
Gap between the scale bar and the unit label in points (1/72 inch).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getUnitLabelGap in interface IScaleBar
Returns:
The points
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUnitLabelGap

public void setUnitLabelGap(double points)
                     throws IOException,
                            AutomationException
Gap between the scale bar and the unit label in points (1/72 inch).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setUnitLabelGap in interface IScaleBar
Parameters:
points - The points (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUnitLabelSymbol

public ITextSymbol getUnitLabelSymbol()
                               throws IOException,
                                      AutomationException
Unit label symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getUnitLabelSymbol in interface IScaleBar
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.

setUnitLabelSymbol

public void setUnitLabelSymbol(ITextSymbol symbol)
                        throws IOException,
                               AutomationException
Unit label symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setUnitLabelSymbol in interface IScaleBar
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.

getLabelFrequency

public int getLabelFrequency()
                      throws IOException,
                             AutomationException
The label style indicating which marks are labeled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLabelFrequency in interface IScaleBar
Returns:
A com.esri.arcgis.carto.esriScaleBarFrequency constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabelFrequency

public void setLabelFrequency(int labelFrequency)
                       throws IOException,
                              AutomationException
The label style indicating which marks are labeled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setLabelFrequency in interface IScaleBar
Parameters:
labelFrequency - A com.esri.arcgis.carto.esriScaleBarFrequency constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNumberFormat

public INumberFormat getNumberFormat()
                              throws IOException,
                                     AutomationException
Number format.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getNumberFormat in interface IScaleBar
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.

setNumberFormat

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setNumberFormat in interface IScaleBar
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.

getLabelPosition

public int getLabelPosition()
                     throws IOException,
                            AutomationException
Vertical positioning of the mark labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLabelPosition in interface IScaleBar
Returns:
A com.esri.arcgis.carto.esriVertPosEnum constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabelPosition

public void setLabelPosition(int position)
                      throws IOException,
                             AutomationException
Vertical positioning of the mark labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setLabelPosition in interface IScaleBar
Parameters:
position - A com.esri.arcgis.carto.esriVertPosEnum constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabelGap

public double getLabelGap()
                   throws IOException,
                          AutomationException
Vertical gap between the bar and the labels in points (1/72 inch).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLabelGap in interface IScaleBar
Returns:
The points
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabelGap

public void setLabelGap(double points)
                 throws IOException,
                        AutomationException
Vertical gap between the bar and the labels in points (1/72 inch).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setLabelGap in interface IScaleBar
Parameters:
points - The points (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabelSymbol

public ITextSymbol getLabelSymbol()
                           throws IOException,
                                  AutomationException
Symbol used to draw the labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLabelSymbol in interface IScaleBar
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.

setLabelSymbol

public void setLabelSymbol(ITextSymbol symbol)
                    throws IOException,
                           AutomationException
Symbol used to draw the labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setLabelSymbol in interface IScaleBar
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.

getBarColor

public IColor getBarColor()
                   throws IOException,
                          AutomationException
Color used to draw the bar.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getBarColor in interface IScaleBar
Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBarColor

public void setBarColor(IColor color)
                 throws IOException,
                        AutomationException
Color used to draw the bar.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setBarColor in interface IScaleBar
Parameters:
color - A reference to a com.esri.arcgis.display.IColor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBarHeight

public double getBarHeight()
                    throws IOException,
                           AutomationException
Height of the bar in points (1/72 inch).

Description

BarHeight is the vertical height of the bars in a scalebar. In the case of double bar scalebars, it is the height of a single bar.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getBarHeight in interface IScaleBar
Returns:
The points
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBarHeight

public void setBarHeight(double points)
                  throws IOException,
                         AutomationException
Height of the bar in points (1/72 inch).

Description

BarHeight is the vertical height of the bars in a scalebar. In the case of double bar scalebars, it is the height of a single bar.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setBarHeight in interface IScaleBar
Parameters:
points - The points (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getResizeHint

public int getResizeHint()
                  throws IOException,
                         AutomationException
Indicates what happens when scale bar is resized.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getResizeHint in interface IScaleBar
Returns:
A com.esri.arcgis.carto.esriScaleBarResizeHint constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setResizeHint

public void setResizeHint(int hint)
                   throws IOException,
                          AutomationException
Indicates what happens when scale bar is resized.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setResizeHint in interface IScaleBar
Parameters:
hint - A com.esri.arcgis.carto.esriScaleBarResizeHint constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

useMapSettings

public void useMapSettings()
                    throws IOException,
                           AutomationException
Sets division and units based on map.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
useMapSettings in interface IScaleBar
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.

getFillSymbol1

public IFillSymbol getFillSymbol1()
                           throws IOException,
                                  AutomationException
Symbol used to draw the bar.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFillSymbol1 in interface IDoubleFillScaleBar
Returns:
A reference to a com.esri.arcgis.display.IFillSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFillSymbol1

public void setFillSymbol1(IFillSymbol symbol)
                    throws IOException,
                           AutomationException
Symbol used to draw the bar.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setFillSymbol1 in interface IDoubleFillScaleBar
Parameters:
symbol - A reference to a com.esri.arcgis.display.IFillSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFillSymbol2

public IFillSymbol getFillSymbol2()
                           throws IOException,
                                  AutomationException
Symbol used to draw the bar.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFillSymbol2 in interface IDoubleFillScaleBar
Returns:
A reference to a com.esri.arcgis.display.IFillSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFillSymbol2

public void setFillSymbol2(IFillSymbol symbol)
                    throws IOException,
                           AutomationException
Symbol used to draw the bar.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setFillSymbol2 in interface IDoubleFillScaleBar
Parameters:
symbol - A reference to a com.esri.arcgis.display.IFillSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDivisionMarkSymbol

public ILineSymbol getDivisionMarkSymbol()
                                  throws IOException,
                                         AutomationException
Symbol used to draw the division marks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDivisionMarkSymbol in interface IScaleMarks
Returns:
A reference to a com.esri.arcgis.display.ILineSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDivisionMarkSymbol

public void setDivisionMarkSymbol(ILineSymbol symbol)
                           throws IOException,
                                  AutomationException
Symbol used to draw the division marks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDivisionMarkSymbol in interface IScaleMarks
Parameters:
symbol - A reference to a com.esri.arcgis.display.ILineSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSubdivisionMarkSymbol

public ILineSymbol getSubdivisionMarkSymbol()
                                     throws IOException,
                                            AutomationException
Symbol used to draw the subdivision marks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSubdivisionMarkSymbol in interface IScaleMarks
Returns:
A reference to a com.esri.arcgis.display.ILineSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSubdivisionMarkSymbol

public void setSubdivisionMarkSymbol(ILineSymbol symbol)
                              throws IOException,
                                     AutomationException
Symbol used to draw the subdivision marks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSubdivisionMarkSymbol in interface IScaleMarks
Parameters:
symbol - A reference to a com.esri.arcgis.display.ILineSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDivisionMarkHeight

public double getDivisionMarkHeight()
                             throws IOException,
                                    AutomationException
Height of division marks in points (1/72 inch). Use esriAutoScaleBar to automatically calculate.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDivisionMarkHeight in interface IScaleMarks
Returns:
The points
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDivisionMarkHeight

public void setDivisionMarkHeight(double points)
                           throws IOException,
                                  AutomationException
Height of division marks in points (1/72 inch). Use esriAutoScaleBar to automatically calculate.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDivisionMarkHeight in interface IScaleMarks
Parameters:
points - The points (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSubdivisionMarkHeight

public double getSubdivisionMarkHeight()
                                throws IOException,
                                       AutomationException
Height of subdivision marks in points (1/72 inch). Use esriAutoScaleBar to automatically calculate.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSubdivisionMarkHeight in interface IScaleMarks
Returns:
The points
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSubdivisionMarkHeight

public void setSubdivisionMarkHeight(double points)
                              throws IOException,
                                     AutomationException
Height of subdivision marks in points (1/72 inch). Use esriAutoScaleBar to automatically calculate.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSubdivisionMarkHeight in interface IScaleMarks
Parameters:
points - The points (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMarkPosition

public int getMarkPosition()
                    throws IOException,
                           AutomationException
Vertical positioning of the marks relative to the bar.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMarkPosition in interface IScaleMarks
Returns:
A com.esri.arcgis.carto.esriVertPosEnum constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMarkPosition

public void setMarkPosition(int position)
                     throws IOException,
                            AutomationException
Vertical positioning of the marks relative to the bar.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMarkPosition in interface IScaleMarks
Parameters:
position - A com.esri.arcgis.carto.esriVertPosEnum constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMarkFrequency

public int getMarkFrequency()
                     throws IOException,
                            AutomationException
Mark frequency.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMarkFrequency in interface IScaleMarks
Returns:
A com.esri.arcgis.carto.esriScaleBarFrequency constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMarkFrequency

public void setMarkFrequency(int frequency)
                      throws IOException,
                             AutomationException
Mark frequency.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMarkFrequency in interface IScaleMarks
Parameters:
frequency - A com.esri.arcgis.carto.esriScaleBarFrequency constant (in)
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.

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.

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
Returns TRUE when 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
Returns TRUE when 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.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException
Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
serialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException
Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
deserialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
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