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, Externalizable, Serializable

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

Formatting information for the legend/TOC entry of a renderer class.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

LegendClassFormat()
Constructs a LegendClassFormat using ArcGIS Engine.

LegendClassFormat(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(Object o) Compare this object with another
IAreaPatch	getAreaPatch() The area patch.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
ITextSymbol	getDescriptionSymbol() Text symbol used to draw legend group descriptions.
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(ObjectInput in)
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(ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

LegendClassFormat

public LegendClassFormat()
                  throws IOException,
                         UnknownHostException

Constructs a LegendClassFormat using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

LegendClassFormat

public LegendClassFormat(Object obj)
                  throws 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:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getLabelSymbol

public ITextSymbol getLabelSymbol()
                           throws IOException,
                                  AutomationException

Text symbol used to draw the legend group labels.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLabelSymbol in interface ILegendClassFormat

Returns:

A reference to a com.esri.arcgis.display.ITextSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelSymbol

public void setLabelSymbol(ITextSymbol symbol)
                    throws IOException,
                           AutomationException

Text symbol used to draw the legend group labels.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLabelSymbol in interface ILegendClassFormat

Parameters:

symbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescriptionSymbol

public ITextSymbol getDescriptionSymbol()
                                 throws IOException,
                                        AutomationException

Text symbol used to draw legend group descriptions.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDescriptionSymbol in interface ILegendClassFormat

Returns:

A reference to a com.esri.arcgis.display.ITextSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescriptionSymbol

public void setDescriptionSymbol(ITextSymbol symbol)
                          throws IOException,
                                 AutomationException

Text symbol used to draw legend group descriptions.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDescriptionSymbol in interface ILegendClassFormat

Parameters:

symbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPatchWidth

public double getPatchWidth()
                     throws IOException,
                            AutomationException

Width of the patch in points.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPatchWidth in interface ILegendClassFormat

Returns:

The width

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPatchWidth

public void setPatchWidth(double width)
                   throws IOException,
                          AutomationException

Width of the patch in points.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPatchWidth in interface ILegendClassFormat

Parameters:

width - The width (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPatchHeight

public double getPatchHeight()
                      throws IOException,
                             AutomationException

Height of the patch in points.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPatchHeight in interface ILegendClassFormat

Returns:

The height

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPatchHeight

public void setPatchHeight(double height)
                    throws IOException,
                           AutomationException

Height of the patch in points.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPatchHeight in interface ILegendClassFormat

Parameters:

height - The height (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLinePatch

public ILinePatch getLinePatch()
                        throws IOException,
                               AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLinePatch in interface ILegendClassFormat

Returns:

A reference to a com.esri.arcgis.carto.ILinePatch

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLinePatch

public void setLinePatch(ILinePatch shape)
                  throws IOException,
                         AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLinePatch in interface ILegendClassFormat

Parameters:

shape - A reference to a com.esri.arcgis.carto.ILinePatch (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAreaPatch

public IAreaPatch getAreaPatch()
                        throws IOException,
                               AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAreaPatch in interface ILegendClassFormat

Returns:

A reference to a com.esri.arcgis.carto.IAreaPatch

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAreaPatch

public void setAreaPatch(IAreaPatch shape)
                  throws IOException,
                         AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAreaPatch in interface ILegendClassFormat

Parameters:

shape - A reference to a com.esri.arcgis.carto.IAreaPatch (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException