com.esri.arcgis.carto
Class SingleDivisionScaleBar

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

All Implemented Interfaces:

IBoundsProperties, IGraphicsComposite, IMapSurround, IQuerySize, IScaleBar, IScaleBar2, IScaleMarks, ISingleFillScaleBar, IConnectionPointContainer, ITransformEvents, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IPropertySupport, IXMLSerialize, java.io.Externalizable, java.io.Serializable, java.util.EventListener

public class SingleDivisionScaleBar
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IScaleBar, IScaleBar2, ISingleFillScaleBar, IScaleMarks, IMapSurround, IQuerySize, IBoundsProperties, ITransformEvents, IPersistStream, IPersist, IClone, IConnectionPointContainer, IGraphicsComposite, IPropertySupport, IXMLSerialize, java.io.Externalizable

COM Class 'SingleDivisionScaleBar'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'A map surround for displaying a single division scale bar.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

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

IID, IID6dfae8e2_ecaa_11d0_8682_0000f8751720, xxDummy

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

IIDfe3115e9_ed6c_11d0_8683_0000f8751720

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

IID, IIDd1658f8e_be62_4a78_88d3_07170f09120c, xxDummy

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

IID, IID6dfae8e4_ecaa_11d0_8682_0000f8751720, xxDummy

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

IID, IID6dfae8e7_ecaa_11d0_8682_0000f8751720, xxDummy

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

IID, IID4d582692_c52a_4287_9fcf_d6286c4775af, xxDummy

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

IID, IID7ad72c5d_eb8a_11d3_9314_00600802e603, xxDummy

Fields inherited from interface com.esri.arcgis.display.ITransformEvents

IID, IIDe6bdb001_4d35_11d0_98be_00805f7ced21, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

Fields inherited from interface com.esri.arcgis.display.IConnectionPointContainer

IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy

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

IID, IID969cde4a_82d4_11d2_87dd_0000f8751720, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPropertySupport

IID, IID8a11ad55_2f4f_11d3_9fa0_00c04f6bc6a5, xxDummy

Fields inherited from interface com.esri.arcgis.system.IXMLSerialize

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

Constructor Summary

SingleDivisionScaleBar()
Constructs a SingleDivisionScaleBar using ArcGIS Engine.

SingleDivisionScaleBar(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SingleDivisionScaleBar theSingleDivisionScaleBar = (SingleDivisionScaleBar) obj;

Method Summary

void	addIMapSurroundEventsListener(IMapSurroundEvents theListener) addIMapSurroundEventsListener.
boolean	applies(java.lang.Object pUnk) Indicates if the receiver can apply the given object at any given time.
java.lang.Object	apply(java.lang.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(java.lang.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(java.lang.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 java.lang.String	getClsid() getClsid.
java.lang.Object	getCurrent(java.lang.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	getFillSymbol() Symbol used to draw the bar.
IEnumElement	getGraphics(IDisplay display, java.lang.Object data) Graphic elements that are used to render this object.
int	getIcon() Icon used to represent the map surround.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
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.
java.lang.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.
java.lang.String	getUnitLabel() The unit label.
double	getUnitLabelGap() Gap between the scale bar and the unit label in points (1/72 inch).
int	getUnitLabelPosition() Vertical positioning of the unit label.
ITextSymbol	getUnitLabelSymbol() Unit label symbol.
int	getUnits() The units reported.
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.
boolean	isUseFractionCharacters() Indicates if common decimal numbers are replaced by a fraction symbol, i.e., 1/2.
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(java.io.ObjectInput in)
void	refresh() Makes sure the latest updates are refected the next time the Map Surround is drawn.
void	release() Release a SingleDivisionScaleBar.
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	setFillSymbol(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(java.lang.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(java.lang.String unitLabel) The unit label.
void	setUnitLabelGap(double points) Gap between the scale bar and the unit label in points (1/72 inch).
void	setUnitLabelPosition(int position) Vertical positioning of the unit label.
void	setUnitLabelSymbol(ITextSymbol symbol) Unit label symbol.
void	setUnits(int units) The units reported.
void	setUseFractionCharacters(boolean flag) Indicates if common decimal numbers are replaced by a fraction symbol, i.e., 1/2.
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(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

SingleDivisionScaleBar

public SingleDivisionScaleBar()
                       throws java.io.IOException,
                              java.net.UnknownHostException

Constructs a SingleDivisionScaleBar using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

SingleDivisionScaleBar

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

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

addIMapSurroundEventsListener

public void addIMapSurroundEventsListener(IMapSurroundEvents theListener)
                                   throws java.io.IOException

addIMapSurroundEventsListener. Listen to events generated by this class.

Parameters:

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

Throws:

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

removeIMapSurroundEventsListener

public void removeIMapSurroundEventsListener(IMapSurroundEvents theListener)
                                      throws java.io.IOException

removeIMapSurroundEventsListener. Stop listening to events generated by this class.

Parameters:

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

Throws:

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

release

public void release()

Release a SingleDivisionScaleBar.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getDivision

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

Number of units in one major division.

Specified by:

getDivision in interface IScaleBar

Specified by:

getDivision in interface IScaleBar2

Returns:

The units

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDivision

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

Number of units in one major division.

Specified by:

setDivision in interface IScaleBar

Specified by:

setDivision in interface IScaleBar2

Parameters:

units - The units (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDivisions

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

Total number of divisions (including those before zero).

Specified by:

getDivisions in interface IScaleBar

Specified by:

getDivisions in interface IScaleBar2

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDivisions

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

Total number of divisions (including those before zero).

Specified by:

setDivisions in interface IScaleBar

Specified by:

setDivisions in interface IScaleBar2

Parameters:

count - The count (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDivisionsBeforeZero

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

Number of divisions to the left of zero.

Specified by:

getDivisionsBeforeZero in interface IScaleBar

Specified by:

getDivisionsBeforeZero in interface IScaleBar2

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDivisionsBeforeZero

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

Number of divisions to the left of zero.

Specified by:

setDivisionsBeforeZero in interface IScaleBar

Specified by:

setDivisionsBeforeZero in interface IScaleBar2

Parameters:

count - The count (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSubdivisions

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

Number of subdivisions per major division.

Specified by:

getSubdivisions in interface IScaleBar

Specified by:

getSubdivisions in interface IScaleBar2

Returns:

The units

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSubdivisions

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

Number of subdivisions per major division.

Specified by:

setSubdivisions in interface IScaleBar

Specified by:

setSubdivisions in interface IScaleBar2

Parameters:

units - The units (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getUnits

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

The units reported.

Specified by:

getUnits in interface IScaleBar

Specified by:

getUnits in interface IScaleBar2

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUnits

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

The units reported.

Specified by:

setUnits in interface IScaleBar

Specified by:

setUnits in interface IScaleBar2

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getUnitLabel

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

The unit label.

Specified by:

getUnitLabel in interface IScaleBar

Specified by:

getUnitLabel in interface IScaleBar2

Returns:

The unitLabel

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUnitLabel

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

The unit label.

Specified by:

setUnitLabel in interface IScaleBar

Specified by:

setUnitLabel in interface IScaleBar2

Parameters:

unitLabel - The unitLabel (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getUnitLabelPosition

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

Vertical positioning of the unit label.

Specified by:

getUnitLabelPosition in interface IScaleBar

Specified by:

getUnitLabelPosition in interface IScaleBar2

Returns:

A com.esri.arcgis.carto.esriScaleBarPos constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUnitLabelPosition

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

Vertical positioning of the unit label.

Specified by:

setUnitLabelPosition in interface IScaleBar

Specified by:

setUnitLabelPosition in interface IScaleBar2

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getUnitLabelGap

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

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

Specified by:

getUnitLabelGap in interface IScaleBar

Specified by:

getUnitLabelGap in interface IScaleBar2

Returns:

The points

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUnitLabelGap

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

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

Specified by:

setUnitLabelGap in interface IScaleBar

Specified by:

setUnitLabelGap in interface IScaleBar2

Parameters:

points - The points (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getUnitLabelSymbol

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

Unit label symbol.

Specified by:

getUnitLabelSymbol in interface IScaleBar

Specified by:

getUnitLabelSymbol in interface IScaleBar2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUnitLabelSymbol

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

Unit label symbol.

Specified by:

setUnitLabelSymbol in interface IScaleBar

Specified by:

setUnitLabelSymbol in interface IScaleBar2

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLabelFrequency

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

The label style indicating which marks are labeled.

Specified by:

getLabelFrequency in interface IScaleBar

Specified by:

getLabelFrequency in interface IScaleBar2

Returns:

A com.esri.arcgis.carto.esriScaleBarFrequency constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLabelFrequency

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

The label style indicating which marks are labeled.

Specified by:

setLabelFrequency in interface IScaleBar

Specified by:

setLabelFrequency in interface IScaleBar2

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNumberFormat

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

Number format.

Specified by:

getNumberFormat in interface IScaleBar

Specified by:

getNumberFormat in interface IScaleBar2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNumberFormat

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

Number format.

Specified by:

setNumberFormat in interface IScaleBar

Specified by:

setNumberFormat in interface IScaleBar2

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLabelPosition

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

Vertical positioning of the mark labels.

Specified by:

getLabelPosition in interface IScaleBar

Specified by:

getLabelPosition in interface IScaleBar2

Returns:

A com.esri.arcgis.carto.esriVertPosEnum constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLabelPosition

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

Vertical positioning of the mark labels.

Specified by:

setLabelPosition in interface IScaleBar

Specified by:

setLabelPosition in interface IScaleBar2

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLabelGap

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

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

Specified by:

getLabelGap in interface IScaleBar

Specified by:

getLabelGap in interface IScaleBar2

Returns:

The points

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLabelGap

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

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

Specified by:

setLabelGap in interface IScaleBar

Specified by:

setLabelGap in interface IScaleBar2

Parameters:

points - The points (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLabelSymbol

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

Symbol used to draw the labels.

Specified by:

getLabelSymbol in interface IScaleBar

Specified by:

getLabelSymbol in interface IScaleBar2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLabelSymbol

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

Symbol used to draw the labels.

Specified by:

setLabelSymbol in interface IScaleBar

Specified by:

setLabelSymbol in interface IScaleBar2

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBarColor

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

Color used to draw the bar.

Specified by:

getBarColor in interface IScaleBar

Specified by:

getBarColor in interface IScaleBar2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBarColor

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

Color used to draw the bar.

Specified by:

setBarColor in interface IScaleBar

Specified by:

setBarColor in interface IScaleBar2

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBarHeight

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

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

Specified by:

getBarHeight in interface IScaleBar

Specified by:

getBarHeight in interface IScaleBar2

Returns:

The points

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBarHeight

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

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

Specified by:

setBarHeight in interface IScaleBar

Specified by:

setBarHeight in interface IScaleBar2

Parameters:

points - The points (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getResizeHint

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

Indicates what happens when scale bar is resized.

Specified by:

getResizeHint in interface IScaleBar

Specified by:

getResizeHint in interface IScaleBar2

Returns:

A com.esri.arcgis.carto.esriScaleBarResizeHint constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setResizeHint

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

Indicates what happens when scale bar is resized.

Specified by:

setResizeHint in interface IScaleBar

Specified by:

setResizeHint in interface IScaleBar2

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

useMapSettings

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

Sets division and units based on map.

Specified by:

useMapSettings in interface IScaleBar

Specified by:

useMapSettings in interface IScaleBar2

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMap

public IMap getMap()
            throws java.io.IOException,
                   AutomationException

The parent map.

Specified by:

getMap in interface IMapSurround

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMapByRef

public void setMapByRef(IMap map)
                 throws java.io.IOException,
                        AutomationException

The parent map.

Specified by:

setMapByRef in interface IMapSurround

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

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

Name of the map surround.

Specified by:

getName in interface IMapSurround

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException

Name of the map surround.

Specified by:

setName in interface IMapSurround

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getIcon

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

Icon used to represent the map surround.

Specified by:

getIcon in interface IMapSurround

Returns:

The hIcon (A COM typedef)

Throws:

java.io.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 java.io.IOException,
                        AutomationException

Returns the bounds of the map surround.

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:

java.io.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 java.io.IOException,
                        AutomationException

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

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:

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

AutomationException - If the ArcObject component throws an exception.

delayEvents

public void delayEvents(boolean delay)
                 throws java.io.IOException,
                        AutomationException

Used to batch operations together to minimize notifications.

Specified by:

delayEvents in interface IMapSurround

Parameters:

delay - The delay (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

refresh

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

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

Specified by:

refresh in interface IMapSurround

Throws:

java.io.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 java.io.IOException,
                 AutomationException

Draws the map surround into the specified display bounds.

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:

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

AutomationException - If the ArcObject component throws an exception.

isUseFractionCharacters

public boolean isUseFractionCharacters()
                                throws java.io.IOException,
                                       AutomationException

Indicates if common decimal numbers are replaced by a fraction symbol, i.e., 1/2.

Specified by:

isUseFractionCharacters in interface IScaleBar2

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseFractionCharacters

public void setUseFractionCharacters(boolean flag)
                              throws java.io.IOException,
                                     AutomationException

Indicates if common decimal numbers are replaced by a fraction symbol, i.e., 1/2.

Specified by:

setUseFractionCharacters in interface IScaleBar2

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFillSymbol

public IFillSymbol getFillSymbol()
                          throws java.io.IOException,
                                 AutomationException

Symbol used to draw the bar.

Specified by:

getFillSymbol in interface ISingleFillScaleBar

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFillSymbol

public void setFillSymbol(IFillSymbol symbol)
                   throws java.io.IOException,
                          AutomationException

Symbol used to draw the bar.

Specified by:

setFillSymbol in interface ISingleFillScaleBar

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDivisionMarkSymbol

public ILineSymbol getDivisionMarkSymbol()
                                  throws java.io.IOException,
                                         AutomationException

Symbol used to draw the division marks.

Specified by:

getDivisionMarkSymbol in interface IScaleMarks

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDivisionMarkSymbol

public void setDivisionMarkSymbol(ILineSymbol symbol)
                           throws java.io.IOException,
                                  AutomationException

Symbol used to draw the division marks.

Specified by:

setDivisionMarkSymbol in interface IScaleMarks

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSubdivisionMarkSymbol

public ILineSymbol getSubdivisionMarkSymbol()
                                     throws java.io.IOException,
                                            AutomationException

Symbol used to draw the subdivision marks.

Specified by:

getSubdivisionMarkSymbol in interface IScaleMarks

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSubdivisionMarkSymbol

public void setSubdivisionMarkSymbol(ILineSymbol symbol)
                              throws java.io.IOException,
                                     AutomationException

Symbol used to draw the subdivision marks.

Specified by:

setSubdivisionMarkSymbol in interface IScaleMarks

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDivisionMarkHeight

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

Height of division marks in points (1/72 inch). Use esriAutoScaleBar to automatically calculate.

Specified by:

getDivisionMarkHeight in interface IScaleMarks

Returns:

The points

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDivisionMarkHeight

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

Height of division marks in points (1/72 inch). Use esriAutoScaleBar to automatically calculate.

Specified by:

setDivisionMarkHeight in interface IScaleMarks

Parameters:

points - The points (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSubdivisionMarkHeight

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

Height of subdivision marks in points (1/72 inch). Use esriAutoScaleBar to automatically calculate.

Specified by:

getSubdivisionMarkHeight in interface IScaleMarks

Returns:

The points

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSubdivisionMarkHeight

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

Height of subdivision marks in points (1/72 inch). Use esriAutoScaleBar to automatically calculate.

Specified by:

setSubdivisionMarkHeight in interface IScaleMarks

Parameters:

points - The points (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMarkPosition

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

Vertical positioning of the marks relative to the bar.

Specified by:

getMarkPosition in interface IScaleMarks

Returns:

A com.esri.arcgis.carto.esriVertPosEnum constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMarkPosition

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

Vertical positioning of the marks relative to the bar.

Specified by:

setMarkPosition in interface IScaleMarks

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMarkFrequency

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

Mark frequency.

Specified by:

getMarkFrequency in interface IScaleMarks

Returns:

A com.esri.arcgis.carto.esriScaleBarFrequency constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMarkFrequency

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

Mark frequency.

Specified by:

setMarkFrequency in interface IScaleMarks

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

querySize

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

Get the size in points.

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:

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

AutomationException - If the ArcObject component throws an exception.

isFixedAspectRatio

public boolean isFixedAspectRatio()
                           throws java.io.IOException,
                                  AutomationException

Indicates if the bounds has a fixed aspect ratio.

Specified by:

isFixedAspectRatio in interface IBoundsProperties

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFixedAspectRatio

public void setFixedAspectRatio(boolean flag)
                         throws java.io.IOException,
                                AutomationException

Indicates if the bounds has a fixed aspect ratio.

Specified by:

setFixedAspectRatio in interface IBoundsProperties

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isFixedSize

public boolean isFixedSize()
                    throws java.io.IOException,
                           AutomationException

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

Specified by:

isFixedSize in interface IBoundsProperties

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

boundsUpdated

public void boundsUpdated(ITransformEventsBoundsUpdatedEvent theEvent)
                   throws java.io.IOException,
                          AutomationException

Notifies clients when the bounds is updated.

Specified by:

boundsUpdated in interface ITransformEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

visibleBoundsUpdated

public void visibleBoundsUpdated(ITransformEventsVisibleBoundsUpdatedEvent theEvent)
                          throws java.io.IOException,
                                 AutomationException

Notifies clients when the visible bounds is updated.

Specified by:

visibleBoundsUpdated in interface ITransformEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deviceFrameUpdated

public void deviceFrameUpdated(ITransformEventsDeviceFrameUpdatedEvent theEvent)
                        throws java.io.IOException,
                               AutomationException

Notifies clients when the device frame is updated.

Specified by:

deviceFrameUpdated in interface ITransformEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

resolutionUpdated

public void resolutionUpdated(ITransformEventsResolutionUpdatedEvent theEvent)
                       throws java.io.IOException,
                              AutomationException

Notifies clients when the resolution is updated.

Specified by:

resolutionUpdated in interface ITransformEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

rotationUpdated

public void rotationUpdated(ITransformEventsRotationUpdatedEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

Notifies clients when the rotation angle is updated.

Specified by:

rotationUpdated in interface ITransformEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

unitsUpdated

public void unitsUpdated(ITransformEventsUnitsUpdatedEvent theEvent)
                  throws java.io.IOException,
                         AutomationException

Notifies clients when the units are updated.

Specified by:

unitsUpdated in interface ITransformEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

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

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

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

save

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

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

Returns:

The equal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

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

Returns:

The identical

Throws:

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

AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

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

enumConnectionPoints

Specified by:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

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

findConnectionPoint

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:

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

AutomationException - If the ArcObject component throws an exception.

getGraphics

public IEnumElement getGraphics(IDisplay display,
                                java.lang.Object data)
                         throws java.io.IOException,
                                AutomationException

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

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:

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

AutomationException - If the ArcObject component throws an exception.

applies

public boolean applies(java.lang.Object pUnk)
                throws java.io.IOException,
                       AutomationException

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

Specified by:

applies in interface IPropertySupport

Parameters:

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

Returns:

The applies

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canApply

public boolean canApply(java.lang.Object pUnk)
                 throws java.io.IOException,
                        AutomationException

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

Specified by:

canApply in interface IPropertySupport

Parameters:

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

Returns:

The canApply

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrent

public java.lang.Object getCurrent(java.lang.Object pUnk)
                            throws java.io.IOException,
                                   AutomationException

The object currently being used.

Specified by:

getCurrent in interface IPropertySupport

Parameters:

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

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

apply

public java.lang.Object apply(java.lang.Object newObject)
                       throws java.io.IOException,
                              AutomationException

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

Specified by:

apply in interface IPropertySupport

Parameters:

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

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException