com.esri.arcgis.carto
Class LegendClassFormat

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

All Implemented Interfaces:

ILegendClassFormat, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable, java.io.Serializable

public class LegendClassFormat
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ILegendClassFormat, IPersistStream, IPersist, IXMLSerialize, java.io.Externalizable

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

Description 'Formatting information for the legend/TOC entry of a renderer class.' 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.ILegendClassFormat

IID, IID52aa5bc2_cb21_11d0_87f9_080009ec732a, 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.IXMLSerialize

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

Constructor Summary

LegendClassFormat()
Constructs a LegendClassFormat using ArcGIS Engine.

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

Method Summary

void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(java.lang.Object o) Compare this object with another
IAreaPatch	getAreaPatch() The area patch.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
ITextSymbol	getDescriptionSymbol() Text symbol used to draw legend group descriptions.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
ITextSymbol	getLabelSymbol() Text symbol used to draw the legend group labels.
ILinePatch	getLinePatch() The line patch.
double	getPatchHeight() Height of the patch in points.
double	getPatchWidth() Width of the patch in points.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
void	isDirty() isDirty
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release a LegendClassFormat.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setAreaPatch(IAreaPatch shape) The area patch.
void	setDescriptionSymbol(ITextSymbol symbol) Text symbol used to draw legend group descriptions.
void	setLabelSymbol(ITextSymbol symbol) Text symbol used to draw the legend group labels.
void	setLinePatch(ILinePatch shape) The line patch.
void	setPatchHeight(double height) Height of the patch in points.
void	setPatchWidth(double width) Width of the patch in points.
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

LegendClassFormat

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

Constructs a LegendClassFormat using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

LegendClassFormat

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

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

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

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 LegendClassFormat.

Specified by:

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

getLabelSymbol

public ITextSymbol getLabelSymbol()
                           throws java.io.IOException,
                                  AutomationException

Text symbol used to draw the legend group labels.

Specified by:

getLabelSymbol in interface ILegendClassFormat

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.

setLabelSymbol

public void setLabelSymbol(ITextSymbol symbol)
                    throws java.io.IOException,
                           AutomationException

Text symbol used to draw the legend group labels.

Specified by:

setLabelSymbol in interface ILegendClassFormat

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.

getDescriptionSymbol

public ITextSymbol getDescriptionSymbol()
                                 throws java.io.IOException,
                                        AutomationException

Text symbol used to draw legend group descriptions.

Specified by:

getDescriptionSymbol in interface ILegendClassFormat

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.

setDescriptionSymbol

public void setDescriptionSymbol(ITextSymbol symbol)
                          throws java.io.IOException,
                                 AutomationException

Text symbol used to draw legend group descriptions.

Specified by:

setDescriptionSymbol in interface ILegendClassFormat

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.

getPatchWidth

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

Width of the patch in points.

Specified by:

getPatchWidth in interface ILegendClassFormat

Returns:

The width

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPatchWidth

public void setPatchWidth(double width)
                   throws java.io.IOException,
                          AutomationException

Width of the patch in points.

Specified by:

setPatchWidth in interface ILegendClassFormat

Parameters:

width - The width (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPatchHeight

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

Height of the patch in points.

Specified by:

getPatchHeight in interface ILegendClassFormat

Returns:

The height

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPatchHeight

public void setPatchHeight(double height)
                    throws java.io.IOException,
                           AutomationException

Height of the patch in points.

Specified by:

setPatchHeight in interface ILegendClassFormat

Parameters:

height - The height (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLinePatch

public ILinePatch getLinePatch()
                        throws java.io.IOException,
                               AutomationException

The line patch. (Optional. If non-null, this overrides default line patch specified by ILegend.LegendFormat).

Specified by:

getLinePatch in interface ILegendClassFormat

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.

setLinePatch

public void setLinePatch(ILinePatch shape)
                  throws java.io.IOException,
                         AutomationException

The line patch. (Optional. If non-null, this overrides default line patch specified by ILegend.LegendFormat).

Specified by:

setLinePatch in interface ILegendClassFormat

Parameters:

shape - 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.

getAreaPatch

public IAreaPatch getAreaPatch()
                        throws java.io.IOException,
                               AutomationException

The area patch. (Optional. If non-null, this overrides default area patch specified by ILegend.LegendFormat).

Specified by:

getAreaPatch in interface ILegendClassFormat

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.

setAreaPatch

public void setAreaPatch(IAreaPatch shape)
                  throws java.io.IOException,
                         AutomationException

The area patch. (Optional. If non-null, this overrides default area patch specified by ILegend.LegendFormat).

Specified by:

setAreaPatch in interface ILegendClassFormat

Parameters:

shape - 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.

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.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

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