com.esri.arcgis.carto

Class MapServerLegendClasses

java.lang.Object

com.esri.arcgis.carto.MapServerLegendClasses

All Implemented Interfaces:

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

public class MapServerLegendClasses
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IMapServerLegendClasses, IXMLSerialize, IXMLVersionSupport, IPersistStream, IPersist, java.io.Externalizable

COM Class 'MapServerLegendClasses'. Generated 9/21/2023 10:01:44 AM from 'X:\ArcGIS\com\server\esriCarto.tlb'

Description 'A collection of Map Server Legend Class objects.' 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

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

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

IID, IID1707d0e5_60c5_494c_a283_9b7de5d9e6ec, xxDummy

Fields inherited from interface com.esri.arcgis.system.IXMLSerialize

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

Fields inherited from interface com.esri.arcgis.system.IXMLVersionSupport

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

Constructor Summary

Constructors

Constructor and Description
MapServerLegendClasses() Constructs a MapServerLegendClasses using ArcGIS Engine.
MapServerLegendClasses(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. MapServerLegendClasses theMapServerLegendClasses = (MapServerLegendClasses) obj;

Method Summary

Modifier and Type	Method and Description
void	add(IMapServerLegendClass legendClass) Adds a legend class.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(java.lang.Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
int	getCount() The legend class count.
IMapServerLegendClass	getElement(int index) The legend class at the specified position.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
java.lang.String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
void	insert(int index, IMapServerLegendClass legendClass) Adds a legend class at the specified position.
void	isDirty() isDirty
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release this COM object reference
void	remove(int index) Removes the legend class at the specified position.
void	removeAll() Removes all legend classes.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
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

MapServerLegendClasses

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

Constructs a MapServerLegendClasses using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

MapServerLegendClasses

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

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

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

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()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

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

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

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

getCount

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

The legend class count.

Specified by:

getCount in interface IMapServerLegendClasses

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getElement

public IMapServerLegendClass getElement(int index)
                                 throws java.io.IOException,
                                        AutomationException

The legend class at the specified position.

Specified by:

getElement in interface IMapServerLegendClasses

Parameters:

index - The index (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

remove

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

Removes the legend class at the specified position.

Specified by:

remove in interface IMapServerLegendClasses

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeAll

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

Removes all legend classes.

Specified by:

removeAll in interface IMapServerLegendClasses

Throws:

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

AutomationException - If the ArcObject component throws an exception.

add

public void add(IMapServerLegendClass legendClass)
         throws java.io.IOException,
                AutomationException

Adds a legend class.

Specified by:

add in interface IMapServerLegendClasses

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

insert

public void insert(int index,
                   IMapServerLegendClass legendClass)
            throws java.io.IOException,
                   AutomationException

Adds a legend class at the specified position.

Specified by:

insert in interface IMapServerLegendClasses

Parameters:

index - The index (in)

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

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.

getMinNamespaceSupported

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

The minimum namespace the class can serialize to (eg the 90 namespace).

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

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.

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