com.esri.arcgis.carto
Class RepresentationLegendClass

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

All Implemented Interfaces:

ILegendClass, IRepresentationLegendClass, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class RepresentationLegendClass
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRepresentationLegendClass, ILegendClass

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

Description 'A legend class object identifying a representation rule.' 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 inherited from interface com.esri.arcgis.carto.IRepresentationLegendClass

IID, IID9543ded1_d4aa_4ece_b21a_90ce2585c8ad, xxDummy

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

IID, IID167c5e9e_af20_11d1_8817_080009ec732a, xxDummy

Constructor Summary

RepresentationLegendClass(java.lang.Object obj)
Construct a RepresentationLegendClass using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
java.lang.String	getDescription() Legend class description.
ILegendClassFormat	getFormat() Optional.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getLabel() Legend class label.
IRepresentationClass	getRepresentationClass() The feature class representation identified by the legend class.
int	getRuleID() The rule ID identified by the legend class.
ISymbol	getSymbol() Legend class symbol.
int	hashCode() the hashcode for this object
void	release() Release a RepresentationLegendClass.
void	setDescription(java.lang.String label) Legend class description.
void	setFormat(ILegendClassFormat format) Optional.
void	setLabel(java.lang.String label) Legend class label.
void	setSymbolByRef(ISymbol symbol) Legend class symbol.

Methods inherited from class java.lang.Object

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

Constructor Detail

RepresentationLegendClass

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

Construct a RepresentationLegendClass using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to RepresentationLegendClass.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
RepresentationLegendClass o = (RepresentationLegendClass)obj; // will not work

RepresentationLegendClass o = new RepresentationLegendClass(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems RepresentationLegendClass theRepresentationLegendClass = (RepresentationLegendClass) obj;

Method Detail

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

Specified by:

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

getRepresentationClass

public IRepresentationClass getRepresentationClass()
                                            throws java.io.IOException,
                                                   AutomationException

The feature class representation identified by the legend class.

Specified by:

getRepresentationClass in interface IRepresentationLegendClass

Returns:

A reference to a com.esri.arcgis.geodatabase.IRepresentationClass

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRuleID

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

The rule ID identified by the legend class.

Specified by:

getRuleID in interface IRepresentationLegendClass

Returns:

The ruleID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSymbol

public ISymbol getSymbol()
                  throws java.io.IOException,
                         AutomationException

Legend class symbol.

Specified by:

getSymbol in interface ILegendClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSymbolByRef

public void setSymbolByRef(ISymbol symbol)
                    throws java.io.IOException,
                           AutomationException

Legend class symbol.

Specified by:

setSymbolByRef in interface ILegendClass

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLabel

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

Legend class label.

Specified by:

getLabel in interface ILegendClass

Returns:

The label

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLabel

public void setLabel(java.lang.String label)
              throws java.io.IOException,
                     AutomationException

Legend class label.

Specified by:

setLabel in interface ILegendClass

Parameters:

label - The label (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDescription

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

Legend class description.

Specified by:

getDescription in interface ILegendClass

Returns:

The label

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(java.lang.String label)
                    throws java.io.IOException,
                           AutomationException

Legend class description.

Specified by:

setDescription in interface ILegendClass

Parameters:

label - The label (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFormat

public ILegendClassFormat getFormat()
                             throws java.io.IOException,
                                    AutomationException

Optional. If non-null, then layer specifies class formatting information.

Specified by:

getFormat in interface ILegendClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFormat

public void setFormat(ILegendClassFormat format)
               throws java.io.IOException,
                      AutomationException

Optional. If non-null, then layer specifies class formatting information.

Specified by:

setFormat in interface ILegendClass

Parameters:

format - A reference to a com.esri.arcgis.carto.ILegendClassFormat (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.