com.esri.arcgis.carto
Class Legend

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

All Implemented Interfaces:

IActiveViewEvents, IBoundsProperties, IGraphicsComposite, ILegend, ILegend2, IMapSurround, IQuerySize, IReadingDirection, IConnectionPointContainer, ITransformEvents, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IPropertySupport, java.io.Externalizable, java.io.Serializable, java.util.EventListener

public class Legend
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ILegend, ILegend2, IMapSurround, IQuerySize, IBoundsProperties, IGraphicsComposite, IConnectionPointContainer, IPropertySupport, IReadingDirection, IPersistStream, IPersist, IClone, IActiveViewEvents, ITransformEvents, java.io.Externalizable

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

Description 'A map surround for displaying a legend.' 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.ILegend

IID, IID3141f307_38e2_11d1_8809_080009ec732a, xxDummy

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

IIDfe3115e9_ed6c_11d0_8683_0000f8751720

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

IID, IID15abe7f6_49e8_4012_be72_d14e5a755ace, 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.carto.IGraphicsComposite

IID, IID969cde4a_82d4_11d2_87dd_0000f8751720, xxDummy

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

IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy

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

IID, IID8a11ad55_2f4f_11d3_9fa0_00c04f6bc6a5, xxDummy

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

IID, IIDb5b5e78f_ab9a_445c_8af6_daf9c3726d0c, 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.carto.IActiveViewEvents

IID, IIDe79c5940_52dd_11d0_98be_00805f7ced21, xxDummy

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

IID, IIDe6bdb001_4d35_11d0_98be_00805f7ced21, xxDummy

Constructor Summary

Legend()
Constructs a Legend using ArcGIS Engine.

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

Method Summary

void	addIMapSurroundEventsListener(IMapSurroundEvents theListener) addIMapSurroundEventsListener.
void	addItem(ILegendItem item) Adds a new item to the legend (to the end of the list).
void	adjustColumns(int columns) Adjust the item settings so that the legend contains the specified number of columns.
void	afterDraw(IActiveViewEventsAfterDrawEvent theEvent) Fired after the specified phase is drawn.
void	afterItemDraw(IActiveViewEventsAfterItemDrawEvent theEvent) Fired after an individual view item is drawn.
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	clearItems() Removes all items from the legend.
void	contentsChanged(IActiveViewEventsContentsChangedEvent theEvent) Fired when the contents of the view changes.
void	contentsCleared(IActiveViewEventsContentsClearedEvent theEvent) Fired when the contents of the view is cleared.
void	delayEvents(boolean delay) Used to batch operations together to minimize notifications.
void	deviceFrameUpdated(ITransformEventsDeviceFrameUpdatedEvent theEvent) Notifies clients when the device frame is updated.
void	draw(IDisplay display, ITrackCancel trackCancel, IEnvelope bounds) Draws the map surround into the specified display bounds.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(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.
void	focusMapChanged(IActiveViewEventsFocusMapChangedEvent theEvent) Fired when a new map is made active.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
java.lang.Object	getCurrent(java.lang.Object pUnk) The object currently being used.
ILegendItem	getDefaultLegendItem(ILayer layer) The default legend item for the specified layer.
ILegendFormat	getFormat() The formatting options for the legend (can be stored in the style gallery).
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.
ILegendItem	getItem(int index) The specified item from the legend.
int	getItemCount() Number of items in the legend.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
IMap	getMap() The parent map.
java.lang.String	getName() Name of the map surround.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
java.lang.String	getTitle() Title.
int	hashCode() the hashcode for this object
void	insertItem(int index, ILegendItem item) Inserts a new item into the legend (at the location specified by index).
boolean	isAutoAdd() Indicates if a new item should be added when a new layer is added to the map.
boolean	isAutoReorder() Indicates if the legend items should be kept in the same order as the layers.
boolean	isAutoVisibility() Indicates if items should be shown only when associated layers are visible.
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	isFlowRight() Reserved for future use.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isRightToLeft() Indicates if the reading direction is right to left.
boolean	isScaleSymbols() Indicates if symbols are scaled for the layer.
void	itemAdded(IActiveViewEventsItemAddedEvent theEvent) Fired when an item is added to the view.
void	itemDeleted(IActiveViewEventsItemDeletedEvent theEvent) Fired when an item is deleted from the view.
void	itemReordered(IActiveViewEventsItemReorderedEvent theEvent) Fired when a view item is reordered.
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 Legend.
void	removeIMapSurroundEventsListener(IMapSurroundEvents theListener) removeIMapSurroundEventsListener.
void	removeItem(int index) Removes the specified item from the legend.
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	selectionChanged(IActiveViewEventsSelectionChangedEvent theEvent) Call this function to fire the selection changed event.
void	setAutoAdd(boolean autoAdd) Indicates if a new item should be added when a new layer is added to the map.
void	setAutoReorder(boolean autoReorder) Indicates if the legend items should be kept in the same order as the layers.
void	setAutoVisibility(boolean autoVisibility) Indicates if items should be shown only when associated layers are visible.
void	setFixedAspectRatio(boolean flag) Indicates if the bounds has a fixed aspect ratio.
void	setFlowRight(boolean flag) Reserved for future use.
void	setFormatByRef(ILegendFormat legendFormat) The formatting options for the legend (can be stored in the style gallery).
void	setMapByRef(IMap map) The parent map.
void	setName(java.lang.String name) Name of the map surround.
void	setRightToLeft(boolean rightToLeft) Indicates if the reading direction is right to left.
void	setScaleSymbols(boolean scale) Indicates if symbols are scaled for the layer.
void	setTitle(java.lang.String title) Title.
void	spatialReferenceChanged(IActiveViewEventsSpatialReferenceChangedEvent theEvent) Fired when the spatial reference is changed.
void	unitsUpdated(ITransformEventsUnitsUpdatedEvent theEvent) Notifies clients when the units are updated.
void	viewRefreshed(IActiveViewEventsViewRefreshedEvent theEvent) Fired when view is refreshed before draw happens.
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

Legend

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

Constructs a Legend using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

Legend

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

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

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

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

Specified by:

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

getFormat

public ILegendFormat getFormat()
                        throws java.io.IOException,
                               AutomationException

The formatting options for the legend (can be stored in the style gallery).

Specified by:

getFormat in interface ILegend

Specified by:

getFormat in interface ILegend2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFormatByRef

public void setFormatByRef(ILegendFormat legendFormat)
                    throws java.io.IOException,
                           AutomationException

The formatting options for the legend (can be stored in the style gallery).

Specified by:

setFormatByRef in interface ILegend

Specified by:

setFormatByRef in interface ILegend2

Parameters:

legendFormat - A reference to a com.esri.arcgis.carto.ILegendFormat (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTitle

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

Title.

Specified by:

getTitle in interface ILegend

Specified by:

getTitle in interface ILegend2

Returns:

The title

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTitle

public void setTitle(java.lang.String title)
              throws java.io.IOException,
                     AutomationException

Title.

Specified by:

setTitle in interface ILegend

Specified by:

setTitle in interface ILegend2

Parameters:

title - The title (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAutoAdd

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

Indicates if a new item should be added when a new layer is added to the map.

Specified by:

isAutoAdd in interface ILegend

Specified by:

isAutoAdd in interface ILegend2

Returns:

The autoAdd

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAutoAdd

public void setAutoAdd(boolean autoAdd)
                throws java.io.IOException,
                       AutomationException

Indicates if a new item should be added when a new layer is added to the map.

Specified by:

setAutoAdd in interface ILegend

Specified by:

setAutoAdd in interface ILegend2

Parameters:

autoAdd - The autoAdd (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAutoReorder

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

Indicates if the legend items should be kept in the same order as the layers.

Specified by:

isAutoReorder in interface ILegend

Specified by:

isAutoReorder in interface ILegend2

Returns:

The autoReorder

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAutoReorder

public void setAutoReorder(boolean autoReorder)
                    throws java.io.IOException,
                           AutomationException

Indicates if the legend items should be kept in the same order as the layers.

Specified by:

setAutoReorder in interface ILegend

Specified by:

setAutoReorder in interface ILegend2

Parameters:

autoReorder - The autoReorder (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAutoVisibility

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

Indicates if items should be shown only when associated layers are visible.

Specified by:

isAutoVisibility in interface ILegend

Specified by:

isAutoVisibility in interface ILegend2

Returns:

The autoVisibility

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAutoVisibility

public void setAutoVisibility(boolean autoVisibility)
                       throws java.io.IOException,
                              AutomationException

Indicates if items should be shown only when associated layers are visible.

Specified by:

setAutoVisibility in interface ILegend

Specified by:

setAutoVisibility in interface ILegend2

Parameters:

autoVisibility - The autoVisibility (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isFlowRight

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

Reserved for future use.

Specified by:

isFlowRight in interface ILegend

Specified by:

isFlowRight in interface ILegend2

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFlowRight

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

Reserved for future use.

Specified by:

setFlowRight in interface ILegend

Specified by:

setFlowRight in interface ILegend2

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getItemCount

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

Number of items in the legend.

Specified by:

getItemCount in interface ILegend

Specified by:

getItemCount in interface ILegend2

Returns:

The numItems

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getItem

public ILegendItem getItem(int index)
                    throws java.io.IOException,
                           AutomationException

The specified item from the legend.

Specified by:

getItem in interface ILegend

Specified by:

getItem in interface ILegend2

Parameters:

index - The index (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addItem

public void addItem(ILegendItem item)
             throws java.io.IOException,
                    AutomationException

Adds a new item to the legend (to the end of the list).

Specified by:

addItem in interface ILegend

Specified by:

addItem in interface ILegend2

Parameters:

item - A reference to a com.esri.arcgis.carto.ILegendItem (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

insertItem

public void insertItem(int index,
                       ILegendItem item)
                throws java.io.IOException,
                       AutomationException

Inserts a new item into the legend (at the location specified by index).

Specified by:

insertItem in interface ILegend

Specified by:

insertItem in interface ILegend2

Parameters:

index - The index (in)

item - A reference to a com.esri.arcgis.carto.ILegendItem (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeItem

public void removeItem(int index)
                throws java.io.IOException,
                       AutomationException

Removes the specified item from the legend.

Specified by:

removeItem in interface ILegend

Specified by:

removeItem in interface ILegend2

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

clearItems

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

Removes all items from the legend.

Specified by:

clearItems in interface ILegend

Specified by:

clearItems in interface ILegend2

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 ILegend2

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 ILegend2

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 ILegend2

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 ILegend2

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 ILegend2

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 ILegend2

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 ILegend2

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 ILegend2

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 ILegend2

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 ILegend2

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.

getDefaultLegendItem

public ILegendItem getDefaultLegendItem(ILayer layer)
                                 throws java.io.IOException,
                                        AutomationException

The default legend item for the specified layer.

Specified by:

getDefaultLegendItem in interface ILegend2

Parameters:

layer - A reference to a com.esri.arcgis.carto.ILayer (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isScaleSymbols

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

Indicates if symbols are scaled for the layer.

Specified by:

isScaleSymbols in interface ILegend2

Returns:

The scale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setScaleSymbols

public void setScaleSymbols(boolean scale)
                     throws java.io.IOException,
                            AutomationException

Indicates if symbols are scaled for the layer.

Specified by:

setScaleSymbols in interface ILegend2

Parameters:

scale - The scale (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

adjustColumns

public void adjustColumns(int columns)
                   throws java.io.IOException,
                          AutomationException

Adjust the item settings so that the legend contains the specified number of columns.

Specified by:

adjustColumns in interface ILegend2

Parameters:

columns - The columns (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.

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.

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.

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.

isRightToLeft

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

Indicates if the reading direction is right to left.

Specified by:

isRightToLeft in interface IReadingDirection

Returns:

The rightToLeft

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRightToLeft

public void setRightToLeft(boolean rightToLeft)
                    throws java.io.IOException,
                           AutomationException

Indicates if the reading direction is right to left.

Specified by:

setRightToLeft in interface IReadingDirection

Parameters:

rightToLeft - The rightToLeft (in)

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.

contentsChanged

public void contentsChanged(IActiveViewEventsContentsChangedEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

Fired when the contents of the view changes.

Specified by:

contentsChanged in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

contentsCleared

public void contentsCleared(IActiveViewEventsContentsClearedEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

Fired when the contents of the view is cleared.

Specified by:

contentsCleared in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

itemAdded

public void itemAdded(IActiveViewEventsItemAddedEvent theEvent)
               throws java.io.IOException,
                      AutomationException

Fired when an item is added to the view.

Specified by:

itemAdded in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

itemDeleted

public void itemDeleted(IActiveViewEventsItemDeletedEvent theEvent)
                 throws java.io.IOException,
                        AutomationException

Fired when an item is deleted from the view.

Specified by:

itemDeleted in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

itemReordered

public void itemReordered(IActiveViewEventsItemReorderedEvent theEvent)
                   throws java.io.IOException,
                          AutomationException

Fired when a view item is reordered.

Specified by:

itemReordered in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

selectionChanged

public void selectionChanged(IActiveViewEventsSelectionChangedEvent theEvent)
                      throws java.io.IOException,
                             AutomationException

Call this function to fire the selection changed event.

Specified by:

selectionChanged in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

viewRefreshed

public void viewRefreshed(IActiveViewEventsViewRefreshedEvent theEvent)
                   throws java.io.IOException,
                          AutomationException

Fired when view is refreshed before draw happens.

Specified by:

viewRefreshed in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

afterDraw

public void afterDraw(IActiveViewEventsAfterDrawEvent theEvent)
               throws java.io.IOException,
                      AutomationException

Fired after the specified phase is drawn.

Specified by:

afterDraw in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

afterItemDraw

public void afterItemDraw(IActiveViewEventsAfterItemDrawEvent theEvent)
                   throws java.io.IOException,
                          AutomationException

Fired after an individual view item is drawn. Example: view items include layers in a map or elements in a page layout.

Specified by:

afterItemDraw in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

focusMapChanged

public void focusMapChanged(IActiveViewEventsFocusMapChangedEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

Fired when a new map is made active.

Specified by:

focusMapChanged in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

spatialReferenceChanged

public void spatialReferenceChanged(IActiveViewEventsSpatialReferenceChangedEvent theEvent)
                             throws java.io.IOException,
                                    AutomationException

Fired when the spatial reference is changed.

Specified by:

spatialReferenceChanged in interface IActiveViewEvents

Parameters:

theEvent - The event

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.

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