Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.carto
Class ILegendItem3Proxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.carto.ILegendItem3Proxy
All Implemented Interfaces:
ILegendItem3, java.io.Externalizable, java.io.Serializable
Deprecated. Internal use only. Proxy for COM Interface 'ILegendItem3'. Generated 3/19/2015 1:20:52 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to members that control how a layer appears in a legend. Can be stored in a style.' 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 ILegendItem3Proxy
extends com.esri.arcgis.interop.Dispatch
implements ILegendItem3, 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.ILegendItem3
IID, IID1dc64b35_9613_4007_bec5_3ad4f1b9dfb7
 
Constructor Summary
  ILegendItem3Proxy()
          Deprecated. For internal use only
  ILegendItem3Proxy(java.lang.Object obj)
          Deprecated.  
protected ILegendItem3Proxy(java.lang.Object obj, java.lang.String iid)
          Deprecated.  
  ILegendItem3Proxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
          Deprecated.  
protected ILegendItem3Proxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
          Deprecated.  
 
Method Summary
 void addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
          Deprecated.  
 void changeFlowDirection(boolean rightToLeft)
          Deprecated. Indicates if a legend's flow direction changes.
 void createGraphics(IDisplay display, ILegendFormat legendFormat)
          Deprecated. Rebuilds the list of graphics.
 short getColumns()
          Deprecated. Number of columns in the legend item.
 IEnumElement getGraphics()
          Deprecated. List of graphics that represent the legend item.
 int getGroupIndex()
          Deprecated. Zero-based index of the legend group shown by this item.
 ITextSymbol getHeadingSymbol()
          Deprecated. Text symbol used to draw the heading.
 double getHeight()
          Deprecated. Height of the item in points.
 ILayer getLayer()
          Deprecated. Associated layer.
 ITextSymbol getLayerNameSymbol()
          Deprecated. Text symbol used to draw the layer name.
 ILegendClassFormat getLegendClassFormat()
          Deprecated. Default formatting information for the legend classes.
 java.lang.String getName()
          Deprecated. Name of the style.
 double getReferenceScaleRatio()
          Deprecated. The ratio calculated by dividing the map reference scale by the map scale.
 double getWidth()
          Deprecated. Width of the item in points.
 boolean isCanDisplay(ILayer layer)
          Deprecated. Indicates if the style is compatible with the specified layer.
 boolean isKeepTogether()
          Deprecated. Indicates if classes must appear in a single column or whether they can be split across multiple columns.
 boolean isNewColumn()
          Deprecated. Indicates if the item starts a new column in the legend.
 boolean isShowDescriptions()
          Deprecated. Indicates if descriptions are visible.
 boolean isShowHeading()
          Deprecated. Indicates if heading is visibile.
 boolean isShowLabels()
          Deprecated. Indicates if labels are visible.
 boolean isShowLayerName()
          Deprecated. Indicates if layer name is visibile.
 void removeListener(java.lang.String iidStr, java.lang.Object theListener)
          Deprecated.  
 void setColumns(short columns)
          Deprecated. Number of columns in the legend item.
 void setGroupIndex(int index)
          Deprecated. Zero-based index of the legend group shown by this item.
 void setHeadingSymbol(ITextSymbol symbol)
          Deprecated. Text symbol used to draw the heading.
 void setKeepTogether(boolean flag)
          Deprecated. Indicates if classes must appear in a single column or whether they can be split across multiple columns.
 void setLayerByRef(ILayer layer)
          Deprecated. Associated layer.
 void setLayerNameSymbol(ITextSymbol symbol)
          Deprecated. Text symbol used to draw the layer name.
 void setLegendClassFormat(ILegendClassFormat format)
          Deprecated. Default formatting information for the legend classes.
 void setNewColumn(boolean flag)
          Deprecated. Indicates if the item starts a new column in the legend.
 void setReferenceScaleRatio(double ratio)
          Deprecated. The ratio calculated by dividing the map reference scale by the map scale.
 void setShowDescriptions(boolean showDescriptions)
          Deprecated. Indicates if descriptions are visible.
 void setShowHeading(boolean showHeading)
          Deprecated. Indicates if heading is visibile.
 void setShowLabels(boolean showLabels)
          Deprecated. Indicates if labels are visible.
 void setShowLayerName(boolean showLayerName)
          Deprecated. Indicates if layer name is visibile.
 
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

ILegendItem3Proxy

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

ILegendItem3Proxy

public ILegendItem3Proxy()
Deprecated. 
For internal use only

ILegendItem3Proxy

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

ILegendItem3Proxy

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

ILegendItem3Proxy

protected ILegendItem3Proxy(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

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
Deprecated. 
Name of the style.

Specified by:
getName in interface ILegendItem3
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanDisplay

public boolean isCanDisplay(ILayer layer)
                     throws java.io.IOException,
                            AutomationException
Deprecated. 
Indicates if the style is compatible with the specified layer.

Specified by:
isCanDisplay in interface ILegendItem3
Parameters:
layer - A reference to a com.esri.arcgis.carto.ILayer (in)
Returns:
The result
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayer

public ILayer getLayer()
                throws java.io.IOException,
                       AutomationException
Deprecated. 
Associated layer.

Specified by:
getLayer in interface ILegendItem3
Returns:
A reference to a com.esri.arcgis.carto.ILayer
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLayerByRef

public void setLayerByRef(ILayer layer)
                   throws java.io.IOException,
                          AutomationException
Deprecated. 
Associated layer.

Specified by:
setLayerByRef in interface ILegendItem3
Parameters:
layer - A reference to a com.esri.arcgis.carto.ILayer (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isNewColumn

public boolean isNewColumn()
                    throws java.io.IOException,
                           AutomationException
Deprecated. 
Indicates if the item starts a new column in the legend.

Specified by:
isNewColumn in interface ILegendItem3
Returns:
The flag
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNewColumn

public void setNewColumn(boolean flag)
                  throws java.io.IOException,
                         AutomationException
Deprecated. 
Indicates if the item starts a new column in the legend.

Specified by:
setNewColumn in interface ILegendItem3
Parameters:
flag - The flag (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColumns

public short getColumns()
                 throws java.io.IOException,
                        AutomationException
Deprecated. 
Number of columns in the legend item.

Specified by:
getColumns in interface ILegendItem3
Returns:
The columns
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setColumns

public void setColumns(short columns)
                throws java.io.IOException,
                       AutomationException
Deprecated. 
Number of columns in the legend item.

Specified by:
setColumns in interface ILegendItem3
Parameters:
columns - The columns (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isKeepTogether

public boolean isKeepTogether()
                       throws java.io.IOException,
                              AutomationException
Deprecated. 
Indicates if classes must appear in a single column or whether they can be split across multiple columns.

Specified by:
isKeepTogether in interface ILegendItem3
Returns:
The flag
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setKeepTogether

public void setKeepTogether(boolean flag)
                     throws java.io.IOException,
                            AutomationException
Deprecated. 
Indicates if classes must appear in a single column or whether they can be split across multiple columns.

Specified by:
setKeepTogether in interface ILegendItem3
Parameters:
flag - The flag (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowLayerName

public boolean isShowLayerName()
                        throws java.io.IOException,
                               AutomationException
Deprecated. 
Indicates if layer name is visibile.

Specified by:
isShowLayerName in interface ILegendItem3
Returns:
The showLayerName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowLayerName

public void setShowLayerName(boolean showLayerName)
                      throws java.io.IOException,
                             AutomationException
Deprecated. 
Indicates if layer name is visibile.

Specified by:
setShowLayerName in interface ILegendItem3
Parameters:
showLayerName - The showLayerName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayerNameSymbol

public ITextSymbol getLayerNameSymbol()
                               throws java.io.IOException,
                                      AutomationException
Deprecated. 
Text symbol used to draw the layer name.

Specified by:
getLayerNameSymbol in interface ILegendItem3
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.

setLayerNameSymbol

public void setLayerNameSymbol(ITextSymbol symbol)
                        throws java.io.IOException,
                               AutomationException
Deprecated. 
Text symbol used to draw the layer name.

Specified by:
setLayerNameSymbol in interface ILegendItem3
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.

getGroupIndex

public int getGroupIndex()
                  throws java.io.IOException,
                         AutomationException
Deprecated. 
Zero-based index of the legend group shown by this item. Use -1 to show all legend groups using this item.

Specified by:
getGroupIndex in interface ILegendItem3
Returns:
The index
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGroupIndex

public void setGroupIndex(int index)
                   throws java.io.IOException,
                          AutomationException
Deprecated. 
Zero-based index of the legend group shown by this item. Use -1 to show all legend groups using this item.

Specified by:
setGroupIndex in interface ILegendItem3
Parameters:
index - The index (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowHeading

public boolean isShowHeading()
                      throws java.io.IOException,
                             AutomationException
Deprecated. 
Indicates if heading is visibile.

Specified by:
isShowHeading in interface ILegendItem3
Returns:
The showHeading
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowHeading

public void setShowHeading(boolean showHeading)
                    throws java.io.IOException,
                           AutomationException
Deprecated. 
Indicates if heading is visibile.

Specified by:
setShowHeading in interface ILegendItem3
Parameters:
showHeading - The showHeading (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHeadingSymbol

public ITextSymbol getHeadingSymbol()
                             throws java.io.IOException,
                                    AutomationException
Deprecated. 
Text symbol used to draw the heading.

Specified by:
getHeadingSymbol in interface ILegendItem3
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.

setHeadingSymbol

public void setHeadingSymbol(ITextSymbol symbol)
                      throws java.io.IOException,
                             AutomationException
Deprecated. 
Text symbol used to draw the heading.

Specified by:
setHeadingSymbol in interface ILegendItem3
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.

getLegendClassFormat

public ILegendClassFormat getLegendClassFormat()
                                        throws java.io.IOException,
                                               AutomationException
Deprecated. 
Default formatting information for the legend classes. Renderer may override.

Specified by:
getLegendClassFormat in interface ILegendItem3
Returns:
A reference to a com.esri.arcgis.carto.ILegendClassFormat
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLegendClassFormat

public void setLegendClassFormat(ILegendClassFormat format)
                          throws java.io.IOException,
                                 AutomationException
Deprecated. 
Default formatting information for the legend classes. Renderer may override.

Specified by:
setLegendClassFormat in interface ILegendItem3
Parameters:
format - A reference to a com.esri.arcgis.carto.ILegendClassFormat (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowLabels

public boolean isShowLabels()
                     throws java.io.IOException,
                            AutomationException
Deprecated. 
Indicates if labels are visible.

Specified by:
isShowLabels in interface ILegendItem3
Returns:
The showLabels
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowLabels

public void setShowLabels(boolean showLabels)
                   throws java.io.IOException,
                          AutomationException
Deprecated. 
Indicates if labels are visible.

Specified by:
setShowLabels in interface ILegendItem3
Parameters:
showLabels - The showLabels (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowDescriptions

public boolean isShowDescriptions()
                           throws java.io.IOException,
                                  AutomationException
Deprecated. 
Indicates if descriptions are visible.

Specified by:
isShowDescriptions in interface ILegendItem3
Returns:
The showDescriptions
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowDescriptions

public void setShowDescriptions(boolean showDescriptions)
                         throws java.io.IOException,
                                AutomationException
Deprecated. 
Indicates if descriptions are visible.

Specified by:
setShowDescriptions in interface ILegendItem3
Parameters:
showDescriptions - The showDescriptions (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createGraphics

public void createGraphics(IDisplay display,
                           ILegendFormat legendFormat)
                    throws java.io.IOException,
                           AutomationException
Deprecated. 
Rebuilds the list of graphics. Call whenever the associated layer changes.

Specified by:
createGraphics in interface ILegendItem3
Parameters:
display - A reference to a com.esri.arcgis.display.IDisplay (in)
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.

getWidth

public double getWidth()
                throws java.io.IOException,
                       AutomationException
Deprecated. 
Width of the item in points. Must call CreateGraphics first.

Specified by:
getWidth in interface ILegendItem3
Returns:
The width
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHeight

public double getHeight()
                 throws java.io.IOException,
                        AutomationException
Deprecated. 
Height of the item in points. Must call CreateGraphics first.

Specified by:
getHeight in interface ILegendItem3
Returns:
The height
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGraphics

public IEnumElement getGraphics()
                         throws java.io.IOException,
                                AutomationException
Deprecated. 
List of graphics that represent the legend item. Must call CreateGraphics first.

Specified by:
getGraphics in interface ILegendItem3
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.

changeFlowDirection

public void changeFlowDirection(boolean rightToLeft)
                         throws java.io.IOException,
                                AutomationException
Deprecated. 
Indicates if a legend's flow direction changes. Update alignment settings.

Specified by:
changeFlowDirection in interface ILegendItem3
Parameters:
rightToLeft - The rightToLeft (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getReferenceScaleRatio

public double getReferenceScaleRatio()
                              throws java.io.IOException,
                                     AutomationException
Deprecated. 
The ratio calculated by dividing the map reference scale by the map scale. Allows legend symbols to honor the map's reference scale.

Specified by:
getReferenceScaleRatio in interface ILegendItem3
Returns:
The ratio
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReferenceScaleRatio

public void setReferenceScaleRatio(double ratio)
                            throws java.io.IOException,
                                   AutomationException
Deprecated. 
The ratio calculated by dividing the map reference scale by the map scale. Allows legend symbols to honor the map's reference scale.

Specified by:
setReferenceScaleRatio in interface ILegendItem3
Parameters:
ratio - The ratio (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD