com.esri.arcgis.carto
Class ILegendProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.carto.IMapSurroundProxy
          extended by com.esri.arcgis.carto.ILegendProxy
All Implemented Interfaces:
ILegend, IMapSurround, java.io.Externalizable, java.io.Serializable

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

Description: 'Provides access to 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 ILegendProxy
extends IMapSurroundProxy
implements ILegend, 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.ILegend
IID, IID3141f307_38e2_11d1_8809_080009ec732a
 
Fields inherited from interface com.esri.arcgis.carto.IMapSurround
IIDfe3115e9_ed6c_11d0_8683_0000f8751720
 
Constructor Summary
  ILegendProxy()
          Deprecated. For internal use only
  ILegendProxy(java.lang.Object obj)
          Deprecated.  
protected ILegendProxy(java.lang.Object obj, java.lang.String iid)
          Deprecated.  
  ILegendProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
          Deprecated.  
protected ILegendProxy(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 clearItems()
          Deprecated. Removes all items from the legend.
 ILegendFormat getFormat()
          Deprecated. The formatting options for the legend (can be stored in the style gallery).
 ILegendItem getItem(int index)
          Deprecated. The specified item from the legend.
 int getItemCount()
          Deprecated. Number of items in the legend.
 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 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 isFlowRight()
          Deprecated. Reserved for future use.
 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 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 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 setTitle(java.lang.String title)
          Deprecated. Title.
 
Methods inherited from class com.esri.arcgis.carto.IMapSurroundProxy
delayEvents, draw, fitToBounds, getIcon, getMap, getName, queryBounds, refresh, setMapByRef, setName
 
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
 
Methods inherited from interface com.esri.arcgis.carto.IMapSurround
delayEvents, draw, fitToBounds, getIcon, getMap, getName, queryBounds, refresh, setMapByRef, setName
 

Field Detail

targetClass

public static final java.lang.Class targetClass
Deprecated. 

noncastable

public boolean noncastable
Deprecated. 
Constructor Detail

ILegendProxy

public ILegendProxy(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

ILegendProxy

public ILegendProxy()
Deprecated. 
For internal use only


ILegendProxy

public ILegendProxy(java.lang.Object obj)
             throws java.io.IOException
Deprecated. 
Throws:
java.io.IOException

ILegendProxy

protected ILegendProxy(java.lang.Object obj,
                       java.lang.String iid)
                throws java.io.IOException
Deprecated. 
Throws:
java.io.IOException

ILegendProxy

protected ILegendProxy(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 IMapSurroundProxy
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 IMapSurroundProxy
Throws:
java.io.IOException

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 ILegend
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 ILegend
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 ILegend
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 ILegend
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 ILegend
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 ILegend
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 ILegend
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 ILegend
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 ILegend
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 ILegend
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 ILegend
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 ILegend
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 ILegend
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 ILegend
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 ILegend
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 ILegend
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 ILegend
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 ILegend
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.