com.esri.arcgis.carto
Class ILegend3Proxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.carto.ILegend3Proxy

All Implemented Interfaces:

ILegend3, java.io.Externalizable, java.io.Serializable

Deprecated. Internal use only. Proxy for COM Interface 'ILegend3'. Generated 3/19/2015 1:20:52 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to additional members that control 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 =

public class ILegend3Proxy
extends com.esri.arcgis.interop.Dispatch
implements ILegend3, java.io.Serializable

Internal use class

See Also:

Serialized Form

Field Summary

boolean	noncastable Deprecated.
static java.lang.Class	targetClass Deprecated.

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

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

IID, IID15abe7f7_49e8_4012_be72_d14e5a755ace

Constructor Summary

	ILegend3Proxy() Deprecated. For internal use only
	ILegend3Proxy(java.lang.Object obj) Deprecated.
protected	ILegend3Proxy(java.lang.Object obj, java.lang.String iid) Deprecated.
	ILegend3Proxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo) Deprecated.
protected	ILegend3Proxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo) Deprecated.

Method Summary

void	addItem(ILegendItem item) Deprecated. Adds a new item to the legend (to the end of the list).
void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource) Deprecated.
void	adjustColumns(int columns) Deprecated. Adjust the item settings so that the legend contains the specified number of columns.
void	clearItems() Deprecated. Removes all items from the legend.
void	delayEvents(boolean delay) Deprecated. Used to batch operations together to minimize notifications.
void	draw(IDisplay display, ITrackCancel trackCancel, IEnvelope bounds) Deprecated. Draws the map surround into the specified display bounds.
void	fitToBounds(IDisplay display, IEnvelope bounds, boolean[] changed) Deprecated. Adjusts the map surround to fit the bounds.
ILegendItem	getDefaultLegendItem(ILayer layer) Deprecated. The default legend item for the specified layer.
ILegendFormat	getFormat() Deprecated. The formatting options for the legend (can be stored in the style gallery).
int	getIcon() Deprecated. Icon used to represent the map surround.
ILegendItem	getItem(int index) Deprecated. The specified item from the legend.
int	getItemCount() Deprecated. Number of items in the legend.
IMap	getMap() Deprecated. The parent map.
double	getMinFontSize() Deprecated. Minimumn font size when AutoFit is true.
java.lang.String	getName() Deprecated. Name of the map surround.
java.lang.String	getTitle() Deprecated. Title.
void	insertItem(int index, ILegendItem item) Deprecated. Inserts a new item into the legend (at the location specified by index).
boolean	isAutoAdd() Deprecated. Indicates if a new item should be added when a new layer is added to the map.
boolean	isAutoColumns() Deprecated. Automatically flow legend items to fit fixed frame.
boolean	isAutoFit() Deprecated. Automatically resize legend items to fit fixed frame.
boolean	isAutoReorder() Deprecated. Indicates if the legend items should be kept in the same order as the layers.
boolean	isAutoVisibility() Deprecated. Indicates if items should be shown only when associated layers are visible.
boolean	isFixedFrame() Deprecated. Indicates frame should not shrink or grow with legend.
boolean	isFlowRight() Deprecated. Reserved for future use.
boolean	isScaleSymbols() Deprecated. Indicates if symbols are scaled for the layer.
boolean	isSupportsAutoColumns() Deprecated. Can legend items be automatically flowed to fit fixed frame?
void	queryBounds(IDisplay display, IEnvelope oldBounds, IEnvelope newBounds) Deprecated. Returns the bounds of the map surround.
void	refresh() Deprecated. Makes sure the latest updates are refected the next time the Map Surround is drawn.
void	removeItem(int index) Deprecated. Removes the specified item from the legend.
void	removeListener(java.lang.String iidStr, java.lang.Object theListener) Deprecated.
void	setAutoAdd(boolean autoAdd) Deprecated. Indicates if a new item should be added when a new layer is added to the map.
void	setAutoColumns(boolean flag) Deprecated. Automatically flow legend items to fit fixed frame.
void	setAutoFit(boolean flag) Deprecated. Automatically resize legend items to fit fixed frame.
void	setAutoReorder(boolean autoReorder) Deprecated. Indicates if the legend items should be kept in the same order as the layers.
void	setAutoVisibility(boolean autoVisibility) Deprecated. Indicates if items should be shown only when associated layers are visible.
void	setFixedFrame(boolean flag) Deprecated. Indicates frame should not shrink or grow with legend.
void	setFlowRight(boolean flag) Deprecated. Reserved for future use.
void	setFormatByRef(ILegendFormat legendFormat) Deprecated. The formatting options for the legend (can be stored in the style gallery).
void	setMapByRef(IMap map) Deprecated. The parent map.
void	setMinFontSize(double fontSize) Deprecated. Minimumn font size when AutoFit is true.
void	setName(java.lang.String name) Deprecated. Name of the map surround.
void	setScaleSymbols(boolean scale) Deprecated. Indicates if symbols are scaled for the layer.
void	setTitle(java.lang.String title) Deprecated. Title.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

targetClass

public static final java.lang.Class targetClass

Deprecated.

noncastable

public boolean noncastable

Deprecated.

Constructor Detail

ILegend3Proxy

public ILegend3Proxy(java.lang.String CLSID,
                     java.lang.String host,
                     com.esri.arcgis.interop.AuthInfo authInfo)
              throws java.net.UnknownHostException,
                     java.io.IOException

Deprecated.

Throws:

java.net.UnknownHostException

java.io.IOException

ILegend3Proxy

public ILegend3Proxy()

Deprecated.

For internal use only

ILegend3Proxy

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

Deprecated.

Throws:

java.io.IOException

ILegend3Proxy

protected ILegend3Proxy(java.lang.Object obj,
                        java.lang.String iid)
                 throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

ILegend3Proxy

protected ILegend3Proxy(java.lang.String CLSID,
                        java.lang.String iid,
                        java.lang.String host,
                        com.esri.arcgis.interop.AuthInfo authInfo)
                 throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException

Deprecated.

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException

Deprecated.

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

java.io.IOException

getMap

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

Deprecated.

The parent map.

Specified by:

getMap in interface ILegend3

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

Deprecated.

The parent map.

Specified by:

setMapByRef in interface ILegend3

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

Deprecated.

Name of the map surround.

Specified by:

getName in interface ILegend3

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

Deprecated.

Name of the map surround.

Specified by:

setName in interface ILegend3

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

Deprecated.

Icon used to represent the map surround.

Specified by:

getIcon in interface ILegend3

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

Deprecated.

Returns the bounds of the map surround.

Specified by:

queryBounds in interface ILegend3

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

Deprecated.

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 ILegend3

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

Deprecated.

Used to batch operations together to minimize notifications.

Specified by:

delayEvents in interface ILegend3

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

Deprecated.

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

Specified by:

refresh in interface ILegend3

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

Deprecated.

Draws the map surround into the specified display bounds.

Specified by:

draw in interface ILegend3

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.

getFormat

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

Deprecated.

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

Specified by:

getFormat in interface ILegend3

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

Deprecated.

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

Specified by:

setFormatByRef in interface ILegend3

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

Deprecated.

Title.

Specified by:

getTitle in interface ILegend3

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

Deprecated.

Title.

Specified by:

setTitle in interface ILegend3

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

Deprecated.

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

Specified by:

isAutoAdd in interface ILegend3

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

Deprecated.

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

Specified by:

setAutoAdd in interface ILegend3

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

Deprecated.

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

Specified by:

isAutoReorder in interface ILegend3

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

Deprecated.

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

Specified by:

setAutoReorder in interface ILegend3

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

Deprecated.

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

Specified by:

isAutoVisibility in interface ILegend3

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

Deprecated.

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

Specified by:

setAutoVisibility in interface ILegend3

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

Deprecated.

Reserved for future use.

Specified by:

isFlowRight in interface ILegend3

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

Deprecated.

Reserved for future use.

Specified by:

setFlowRight in interface ILegend3

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

Deprecated.

Number of items in the legend.

Specified by:

getItemCount in interface ILegend3

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

Deprecated.

The specified item from the legend.

Specified by:

getItem in interface ILegend3

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

Deprecated.

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

Specified by:

addItem in interface ILegend3

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

Deprecated.

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

Specified by:

insertItem in interface ILegend3

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

Deprecated.

Removes the specified item from the legend.

Specified by:

removeItem in interface ILegend3

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

Deprecated.

Removes all items from the legend.

Specified by:

clearItems in interface ILegend3

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

Deprecated.

The default legend item for the specified layer.

Specified by:

getDefaultLegendItem in interface ILegend3

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

Deprecated.

Indicates if symbols are scaled for the layer.

Specified by:

isScaleSymbols in interface ILegend3

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

Deprecated.

Indicates if symbols are scaled for the layer.

Specified by:

setScaleSymbols in interface ILegend3

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

Deprecated.

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

Specified by:

adjustColumns in interface ILegend3

Parameters:

columns - The columns (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isFixedFrame

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

Deprecated.

Indicates frame should not shrink or grow with legend. Enables AutoColumns and AutoFit.

Specified by:

isFixedFrame in interface ILegend3

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFixedFrame

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

Deprecated.

Indicates frame should not shrink or grow with legend. Enables AutoColumns and AutoFit.

Specified by:

setFixedFrame in interface ILegend3

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAutoColumns

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

Deprecated.

Automatically flow legend items to fit fixed frame.

Specified by:

isAutoColumns in interface ILegend3

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAutoColumns

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

Deprecated.

Automatically flow legend items to fit fixed frame.

Specified by:

setAutoColumns in interface ILegend3

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAutoFit

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

Deprecated.

Automatically resize legend items to fit fixed frame.

Specified by:

isAutoFit in interface ILegend3

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAutoFit

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

Deprecated.

Automatically resize legend items to fit fixed frame.

Specified by:

setAutoFit in interface ILegend3

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinFontSize

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

Deprecated.

Minimumn font size when AutoFit is true.

Specified by:

getMinFontSize in interface ILegend3

Returns:

The fontSize

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMinFontSize

public void setMinFontSize(double fontSize)
                    throws java.io.IOException,
                           AutomationException

Deprecated.

Minimumn font size when AutoFit is true.

Specified by:

setMinFontSize in interface ILegend3

Parameters:

fontSize - The fontSize (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportsAutoColumns

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

Deprecated.

Can legend items be automatically flowed to fit fixed frame?

Specified by:

isSupportsAutoColumns in interface ILegend3

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.