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 ILegendFormatProxy

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

Description: 'Provides access to members that control formatting information for 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 ILegendFormatProxy
extends com.esri.arcgis.interop.Dispatch
implements ILegendFormat, 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.ILegendFormat
IID, IID52aa5bc1_cb21_11d0_87f9_080009ec732a
 
Constructor Summary
  ILegendFormatProxy()
          Deprecated. For internal use only
  ILegendFormatProxy(java.lang.Object obj)
          Deprecated.  
protected ILegendFormatProxy(java.lang.Object obj, java.lang.String iid)
          Deprecated.  
  ILegendFormatProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
          Deprecated.  
protected ILegendFormatProxy(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.  
 IAreaPatch getDefaultAreaPatch()
          Deprecated. Area patch.
 ILinePatch getDefaultLinePatch()
          Deprecated. Line patch.
 double getDefaultPatchHeight()
          Deprecated. Patch height in points.
 double getDefaultPatchWidth()
          Deprecated. Patch width in points.
 double getGroupGap()
          Deprecated. Vertical distance in points between legend groups.
 double getHeadingGap()
          Deprecated. Vertical distance in points between a heading and the legend graphics that follow.
 double getHorizontalItemGap()
          Deprecated. Horizontal distance in points between legend item columns.
 double getHorizontalPatchGap()
          Deprecated. Horizontal distance in points between a patch and the legend graphics before and after.
 double getLayerNameGap()
          Deprecated. Vertical distance in points between layer names and the legend graphics that follow.
 double getTextGap()
          Deprecated. Horizontal distance in points between labels and descriptions.
 double getTitleGap()
          Deprecated. Vertical distance in points between title and first legend item.
 int getTitlePosition()
          Deprecated. Legend title position.
 ITextSymbol getTitleSymbol()
          Deprecated. Text symbol used to draw the legend title.
 double getVerticalItemGap()
          Deprecated. Vertical distance in points between legend items.
 double getVerticalPatchGap()
          Deprecated. Vertical distance in points between patches.
 boolean isShowTitle()
          Deprecated. Indicates if title is visibile.
 void removeListener(java.lang.String iidStr, java.lang.Object theListener)
          Deprecated.  
 void scale(double xScale, double yScale)
          Deprecated. Multiply all distances, gaps, and size property values on this interface by the specified scale factors.
 void setDefaultAreaPatch(IAreaPatch patch)
          Deprecated. Area patch.
 void setDefaultLinePatch(ILinePatch patch)
          Deprecated. Line patch.
 void setDefaultPatchHeight(double height)
          Deprecated. Patch height in points.
 void setDefaultPatchWidth(double width)
          Deprecated. Patch width in points.
 void setGroupGap(double gap)
          Deprecated. Vertical distance in points between legend groups.
 void setHeadingGap(double gap)
          Deprecated. Vertical distance in points between a heading and the legend graphics that follow.
 void setHorizontalItemGap(double gap)
          Deprecated. Horizontal distance in points between legend item columns.
 void setHorizontalPatchGap(double gap)
          Deprecated. Horizontal distance in points between a patch and the legend graphics before and after.
 void setLayerNameGap(double gap)
          Deprecated. Vertical distance in points between layer names and the legend graphics that follow.
 void setShowTitle(boolean showTitle)
          Deprecated. Indicates if title is visibile.
 void setTextGap(double gap)
          Deprecated. Horizontal distance in points between labels and descriptions.
 void setTitleGap(double gap)
          Deprecated. Vertical distance in points between title and first legend item.
 void setTitlePosition(int pos)
          Deprecated. Legend title position.
 void setTitleSymbol(ITextSymbol symbol)
          Deprecated. Text symbol used to draw the legend title.
 void setVerticalItemGap(double gap)
          Deprecated. Vertical distance in points between legend items.
 void setVerticalPatchGap(double gap)
          Deprecated. Vertical distance in points between patches.
 
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

ILegendFormatProxy

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

ILegendFormatProxy

public ILegendFormatProxy()
Deprecated. 
For internal use only

ILegendFormatProxy

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

ILegendFormatProxy

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

ILegendFormatProxy

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

isShowTitle

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

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

setShowTitle

public void setShowTitle(boolean showTitle)
                  throws java.io.IOException,
                         AutomationException
Deprecated. 
Indicates if title is visibile.

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

getTitleSymbol

public ITextSymbol getTitleSymbol()
                           throws java.io.IOException,
                                  AutomationException
Deprecated. 
Text symbol used to draw the legend title.

Specified by:
getTitleSymbol in interface ILegendFormat
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.

setTitleSymbol

public void setTitleSymbol(ITextSymbol symbol)
                    throws java.io.IOException,
                           AutomationException
Deprecated. 
Text symbol used to draw the legend title.

Specified by:
setTitleSymbol in interface ILegendFormat
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.

getTitlePosition

public int getTitlePosition()
                     throws java.io.IOException,
                            AutomationException
Deprecated. 
Legend title position.

Specified by:
getTitlePosition in interface ILegendFormat
Returns:
A com.esri.arcgis.carto.esriRectanglePosition constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTitlePosition

public void setTitlePosition(int pos)
                      throws java.io.IOException,
                             AutomationException
Deprecated. 
Legend title position.

Specified by:
setTitlePosition in interface ILegendFormat
Parameters:
pos - A com.esri.arcgis.carto.esriRectanglePosition constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTitleGap

public double getTitleGap()
                   throws java.io.IOException,
                          AutomationException
Deprecated. 
Vertical distance in points between title and first legend item.

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

setTitleGap

public void setTitleGap(double gap)
                 throws java.io.IOException,
                        AutomationException
Deprecated. 
Vertical distance in points between title and first legend item.

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

getVerticalItemGap

public double getVerticalItemGap()
                          throws java.io.IOException,
                                 AutomationException
Deprecated. 
Vertical distance in points between legend items.

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

setVerticalItemGap

public void setVerticalItemGap(double gap)
                        throws java.io.IOException,
                               AutomationException
Deprecated. 
Vertical distance in points between legend items.

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

getHorizontalItemGap

public double getHorizontalItemGap()
                            throws java.io.IOException,
                                   AutomationException
Deprecated. 
Horizontal distance in points between legend item columns. Used for legends that have more than one column.

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

setHorizontalItemGap

public void setHorizontalItemGap(double gap)
                          throws java.io.IOException,
                                 AutomationException
Deprecated. 
Horizontal distance in points between legend item columns. Used for legends that have more than one column.

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

getLayerNameGap

public double getLayerNameGap()
                       throws java.io.IOException,
                              AutomationException
Deprecated. 
Vertical distance in points between layer names and the legend graphics that follow.

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

setLayerNameGap

public void setLayerNameGap(double gap)
                     throws java.io.IOException,
                            AutomationException
Deprecated. 
Vertical distance in points between layer names and the legend graphics that follow.

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

getGroupGap

public double getGroupGap()
                   throws java.io.IOException,
                          AutomationException
Deprecated. 
Vertical distance in points between legend groups.

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

setGroupGap

public void setGroupGap(double gap)
                 throws java.io.IOException,
                        AutomationException
Deprecated. 
Vertical distance in points between legend groups.

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

getHeadingGap

public double getHeadingGap()
                     throws java.io.IOException,
                            AutomationException
Deprecated. 
Vertical distance in points between a heading and the legend graphics that follow.

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

setHeadingGap

public void setHeadingGap(double gap)
                   throws java.io.IOException,
                          AutomationException
Deprecated. 
Vertical distance in points between a heading and the legend graphics that follow.

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

getTextGap

public double getTextGap()
                  throws java.io.IOException,
                         AutomationException
Deprecated. 
Horizontal distance in points between labels and descriptions.

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

setTextGap

public void setTextGap(double gap)
                throws java.io.IOException,
                       AutomationException
Deprecated. 
Horizontal distance in points between labels and descriptions.

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

getVerticalPatchGap

public double getVerticalPatchGap()
                           throws java.io.IOException,
                                  AutomationException
Deprecated. 
Vertical distance in points between patches.

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

setVerticalPatchGap

public void setVerticalPatchGap(double gap)
                         throws java.io.IOException,
                                AutomationException
Deprecated. 
Vertical distance in points between patches.

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

getHorizontalPatchGap

public double getHorizontalPatchGap()
                             throws java.io.IOException,
                                    AutomationException
Deprecated. 
Horizontal distance in points between a patch and the legend graphics before and after.

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

setHorizontalPatchGap

public void setHorizontalPatchGap(double gap)
                           throws java.io.IOException,
                                  AutomationException
Deprecated. 
Horizontal distance in points between a patch and the legend graphics before and after.

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

getDefaultPatchWidth

public double getDefaultPatchWidth()
                            throws java.io.IOException,
                                   AutomationException
Deprecated. 
Patch width in points. Can be overridden by the LegendItem.

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

setDefaultPatchWidth

public void setDefaultPatchWidth(double width)
                          throws java.io.IOException,
                                 AutomationException
Deprecated. 
Patch width in points. Can be overridden by the LegendItem.

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

getDefaultPatchHeight

public double getDefaultPatchHeight()
                             throws java.io.IOException,
                                    AutomationException
Deprecated. 
Patch height in points. Can be overridden by the LegendItem.

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

setDefaultPatchHeight

public void setDefaultPatchHeight(double height)
                           throws java.io.IOException,
                                  AutomationException
Deprecated. 
Patch height in points. Can be overridden by the LegendItem.

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

getDefaultLinePatch

public ILinePatch getDefaultLinePatch()
                               throws java.io.IOException,
                                      AutomationException
Deprecated. 
Line patch. Can be overridden by the LegendItem.

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

setDefaultLinePatch

public void setDefaultLinePatch(ILinePatch patch)
                         throws java.io.IOException,
                                AutomationException
Deprecated. 
Line patch. Can be overridden by the LegendItem.

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

getDefaultAreaPatch

public IAreaPatch getDefaultAreaPatch()
                               throws java.io.IOException,
                                      AutomationException
Deprecated. 
Area patch. Can be overridden by the LegendItem.

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

setDefaultAreaPatch

public void setDefaultAreaPatch(IAreaPatch patch)
                         throws java.io.IOException,
                                AutomationException
Deprecated. 
Area patch. Can be overridden by the LegendItem.

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

scale

public void scale(double xScale,
                  double yScale)
           throws java.io.IOException,
                  AutomationException
Deprecated. 
Multiply all distances, gaps, and size property values on this interface by the specified scale factors.

Specified by:
scale in interface ILegendFormat
Parameters:
xScale - The xScale (in)
yScale - The yScale (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