com.esri.arcgis.carto
Class LegendGroup

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

All Implemented Interfaces:

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

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

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

Description 'The collection of legend classes provided by a renderer.' 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.ILegendGroup

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

LegendGroup()
Constructs a LegendGroup using ArcGIS Engine.

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

Method Summary

void	addClass(ILegendClass legendClass) Adds a new legend class to the group at the end of list.
void	clearClasses() Removes all classes from the group.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(java.lang.Object o) Compare this object with another
ILegendClass	esri_getClass(int index) Legend class at the specified index.
int	getClassCount() Number of legend classes in the group.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
java.lang.String	getHeading() String heading.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
void	insertClass(int index, ILegendClass legendClass) Inserts a new legend class into the group at the specified index.
void	isDirty() isDirty
boolean	isEditable() Indicates if the group can be edited.
boolean	isVisible() Indicates if the group is displayed.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release a LegendGroup.
void	removeClass(int index) Removes the legend class from the group at the specified index.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setEditable(boolean editable) Indicates if the group can be edited.
void	setHeading(java.lang.String heading) String heading.
void	setVisible(boolean visible) Indicates if the group is displayed.
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

LegendGroup

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

Constructs a LegendGroup using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

LegendGroup

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

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

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

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

Specified by:

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

isVisible

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

Indicates if the group is displayed.

Specified by:

isVisible in interface ILegendGroup

Returns:

The visible

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean visible)
                throws java.io.IOException,
                       AutomationException

Indicates if the group is displayed.

Specified by:

setVisible in interface ILegendGroup

Parameters:

visible - The visible (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEditable

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

Indicates if the group can be edited. Default is editable.

Specified by:

isEditable in interface ILegendGroup

Returns:

The editable

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEditable

public void setEditable(boolean editable)
                 throws java.io.IOException,
                        AutomationException

Indicates if the group can be edited. Default is editable.

Specified by:

setEditable in interface ILegendGroup

Parameters:

editable - The editable (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHeading

public java.lang.String getHeading()
                            throws java.io.IOException,
                                   AutomationException

String heading.

Specified by:

getHeading in interface ILegendGroup

Returns:

The heading

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHeading

public void setHeading(java.lang.String heading)
                throws java.io.IOException,
                       AutomationException

String heading.

Specified by:

setHeading in interface ILegendGroup

Parameters:

heading - The heading (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassCount

public int getClassCount()
                  throws java.io.IOException,
                         AutomationException

Number of legend classes in the group.

Specified by:

getClassCount in interface ILegendGroup

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_getClass

public ILegendClass esri_getClass(int index)
                           throws java.io.IOException,
                                  AutomationException

Legend class at the specified index.

Specified by:

esri_getClass in interface ILegendGroup

Parameters:

index - The index (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addClass

public void addClass(ILegendClass legendClass)
              throws java.io.IOException,
                     AutomationException

Adds a new legend class to the group at the end of list.

Specified by:

addClass in interface ILegendGroup

Parameters:

legendClass - A reference to a com.esri.arcgis.carto.ILegendClass (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

insertClass

public void insertClass(int index,
                        ILegendClass legendClass)
                 throws java.io.IOException,
                        AutomationException

Inserts a new legend class into the group at the specified index.

Specified by:

insertClass in interface ILegendGroup

Parameters:

index - The index (in)

legendClass - A reference to a com.esri.arcgis.carto.ILegendClass (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeClass

public void removeClass(int index)
                 throws java.io.IOException,
                        AutomationException

Removes the legend class from the group at the specified index.

Specified by:

removeClass in interface ILegendGroup

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

clearClasses

public void clearClasses()
                  throws java.io.IOException,
                         AutomationException

Removes all classes from the group.

Specified by:

clearClasses in interface ILegendGroup

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