com.esri.arcgis.carto
Class LegendFormat

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

All Implemented Interfaces:

ILegendFormat, ILegendLayout, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class LegendFormat
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ILegendFormat, ILegendLayout, IPersistStream, IPersist, IClone, java.io.Externalizable

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

Description 'A legend format.' 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.ILegendFormat

IID, IID52aa5bc1_cb21_11d0_87f9_080009ec732a, xxDummy

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

IID, IIDa7e5770d_ec6a_11d2_b86e_00600802e603, 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

Constructor Summary

LegendFormat()
Constructs a LegendFormat using ArcGIS Engine.

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

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
IAreaPatch	getDefaultAreaPatch() Area patch.
ILinePatch	getDefaultLinePatch() Line patch.
double	getDefaultPatchHeight() Patch height in points.
double	getDefaultPatchWidth() Patch width in points.
double	getGroupGap() Vertical distance in points between legend groups.
double	getHeadingGap() Vertical distance in points between a heading and the legend graphics that follow.
double	getHorizontalItemGap() Horizontal distance in points between legend item columns.
double	getHorizontalPatchGap() Horizontal distance in points between a patch and the legend graphics before and after.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
double	getLayerNameGap() Vertical distance in points between layer names and the legend graphics that follow.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
double	getTextGap() Horizontal distance in points between labels and descriptions.
double	getTitleGap() Vertical distance in points between title and first legend item.
int	getTitlePosition() Legend title position.
ITextSymbol	getTitleSymbol() Text symbol used to draw the legend title.
double	getVerticalItemGap() Vertical distance in points between legend items.
double	getVerticalPatchGap() Vertical distance in points between patches.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isScaleGraphicsOnResize() Indicates if graphics are scaled when the legend is resized.
boolean	isShowTitle() Indicates if title is visibile.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release a LegendFormat.
void	save(IStream pstm, int fClearDirty) save
void	scale(double xScale, double yScale) Multiply all distances, gaps, and size property values on this interface by the specified scale factors.
void	setDefaultAreaPatch(IAreaPatch patch) Area patch.
void	setDefaultLinePatch(ILinePatch patch) Line patch.
void	setDefaultPatchHeight(double height) Patch height in points.
void	setDefaultPatchWidth(double width) Patch width in points.
void	setGroupGap(double gap) Vertical distance in points between legend groups.
void	setHeadingGap(double gap) Vertical distance in points between a heading and the legend graphics that follow.
void	setHorizontalItemGap(double gap) Horizontal distance in points between legend item columns.
void	setHorizontalPatchGap(double gap) Horizontal distance in points between a patch and the legend graphics before and after.
void	setLayerNameGap(double gap) Vertical distance in points between layer names and the legend graphics that follow.
void	setScaleGraphicsOnResize(boolean scaleGraphicsOnResize) Indicates if graphics are scaled when the legend is resized.
void	setShowTitle(boolean showTitle) Indicates if title is visibile.
void	setTextGap(double gap) Horizontal distance in points between labels and descriptions.
void	setTitleGap(double gap) Vertical distance in points between title and first legend item.
void	setTitlePosition(int pos) Legend title position.
void	setTitleSymbol(ITextSymbol symbol) Text symbol used to draw the legend title.
void	setVerticalItemGap(double gap) Vertical distance in points between legend items.
void	setVerticalPatchGap(double gap) Vertical distance in points between patches.
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

LegendFormat

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

Constructs a LegendFormat using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

LegendFormat

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

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

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

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

release

public void release()

Release a LegendFormat.

Specified by:

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

isShowTitle

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

setScaleGraphicsOnResize

public void setScaleGraphicsOnResize(boolean scaleGraphicsOnResize)
                              throws java.io.IOException,
                                     AutomationException

Indicates if graphics are scaled when the legend is resized.

Specified by:

setScaleGraphicsOnResize in interface ILegendLayout

Parameters:

scaleGraphicsOnResize - The scaleGraphicsOnResize (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isScaleGraphicsOnResize

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

Indicates if graphics are scaled when the legend is resized.

Specified by:

isScaleGraphicsOnResize in interface ILegendLayout

Returns:

The scaleGraphicsOnResize

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.

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