com.esri.arcgis.carto
Class LabelClassDescription

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

All Implemented Interfaces:

ILabelClassDescription, ILabelClassDescription2, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable, java.io.Serializable

public class LabelClassDescription
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ILabelClassDescription, ILabelClassDescription2, IXMLSerialize, IPersistStream, IXMLVersionSupport, IDocumentVersionSupportGEN, java.io.Externalizable

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

Description 'Lable Class Description coclass.' 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.ILabelClassDescription

IID, IID63882c74_6b36_497b_9e27_efd67226e583, xxDummy

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

IID, IIDc9559563_104d_4895_9dbc_e3ef873c50e7, 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.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.IXMLVersionSupport

IID, IID72ca65b9_13de_48b7_8443_717b69b72a99, xxDummy

Constructor Summary

LabelClassDescription()
Constructs a LabelClassDescription using ArcGIS Engine.

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

Method Summary

java.lang.Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
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	getExpressionType() ExpressionType.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getLabelExpression() The Label Expression.
ILabelPlacementDescription	getLabelPlacementDescription() LabelPlacementDescription.
double	getMaximumScale() Maximum scale at which the symbol will display.
double	getMinimumScale() Minimum scale at which the symbol will display.
java.lang.String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
ITextSymbol	getSymbol() The text symbol used to draw the label.
java.lang.String	getWhereClause() The SQL WhereClause for the label.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
boolean	isUseCodedValue() Indicates whether Coded Value Should be used when displaying label expression.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release a LabelClassDescription.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setExpressionType(int expressionType) ExpressionType.
void	setLabelExpression(java.lang.String labelExpression) The Label Expression.
void	setLabelPlacementDescription(ILabelPlacementDescription ppLabelPlacementDescription) LabelPlacementDescription.
void	setMaximumScale(double pMaximumScale) Maximum scale at which the symbol will display.
void	setMinimumScale(double pMinimumScale) Minimum scale at which the symbol will display.
void	setSymbol(ITextSymbol ppSymbol) The text symbol used to draw the label.
void	setUseCodedValue(boolean useCodedValue) Indicates whether Coded Value Should be used when displaying label expression.
void	setWhereClause(java.lang.String whereClause) The SQL WhereClause for the label.
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

LabelClassDescription

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

Constructs a LabelClassDescription using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

LabelClassDescription

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

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

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

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

Specified by:

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

getLabelPlacementDescription

public ILabelPlacementDescription getLabelPlacementDescription()
                                                        throws java.io.IOException,
                                                               AutomationException

LabelPlacementDescription.

Specified by:

getLabelPlacementDescription in interface ILabelClassDescription

Specified by:

getLabelPlacementDescription in interface ILabelClassDescription2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLabelPlacementDescription

public void setLabelPlacementDescription(ILabelPlacementDescription ppLabelPlacementDescription)
                                  throws java.io.IOException,
                                         AutomationException

LabelPlacementDescription.

Specified by:

setLabelPlacementDescription in interface ILabelClassDescription

Specified by:

setLabelPlacementDescription in interface ILabelClassDescription2

Parameters:

ppLabelPlacementDescription - A reference to a com.esri.arcgis.carto.ILabelPlacementDescription (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLabelExpression

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

The Label Expression.

Specified by:

getLabelExpression in interface ILabelClassDescription

Specified by:

getLabelExpression in interface ILabelClassDescription2

Returns:

The labelExpression

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLabelExpression

public void setLabelExpression(java.lang.String labelExpression)
                        throws java.io.IOException,
                               AutomationException

The Label Expression.

Specified by:

setLabelExpression in interface ILabelClassDescription

Specified by:

setLabelExpression in interface ILabelClassDescription2

Parameters:

labelExpression - The labelExpression (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseCodedValue

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

Indicates whether Coded Value Should be used when displaying label expression.

Specified by:

isUseCodedValue in interface ILabelClassDescription

Specified by:

isUseCodedValue in interface ILabelClassDescription2

Returns:

The useCodedValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseCodedValue

public void setUseCodedValue(boolean useCodedValue)
                      throws java.io.IOException,
                             AutomationException

Indicates whether Coded Value Should be used when displaying label expression.

Specified by:

setUseCodedValue in interface ILabelClassDescription

Specified by:

setUseCodedValue in interface ILabelClassDescription2

Parameters:

useCodedValue - The useCodedValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSymbol

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

The text symbol used to draw the label.

Specified by:

getSymbol in interface ILabelClassDescription

Specified by:

getSymbol in interface ILabelClassDescription2

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.

setSymbol

public void setSymbol(ITextSymbol ppSymbol)
               throws java.io.IOException,
                      AutomationException

The text symbol used to draw the label.

Specified by:

setSymbol in interface ILabelClassDescription

Specified by:

setSymbol in interface ILabelClassDescription2

Parameters:

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

getMaximumScale

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

Maximum scale at which the symbol will display.

Specified by:

getMaximumScale in interface ILabelClassDescription

Specified by:

getMaximumScale in interface ILabelClassDescription2

Returns:

The pMaximumScale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaximumScale

public void setMaximumScale(double pMaximumScale)
                     throws java.io.IOException,
                            AutomationException

Maximum scale at which the symbol will display.

Specified by:

setMaximumScale in interface ILabelClassDescription

Specified by:

setMaximumScale in interface ILabelClassDescription2

Parameters:

pMaximumScale - The pMaximumScale (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinimumScale

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

Minimum scale at which the symbol will display.

Specified by:

getMinimumScale in interface ILabelClassDescription

Specified by:

getMinimumScale in interface ILabelClassDescription2

Returns:

The pMinimumScale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMinimumScale

public void setMinimumScale(double pMinimumScale)
                     throws java.io.IOException,
                            AutomationException

Minimum scale at which the symbol will display.

Specified by:

setMinimumScale in interface ILabelClassDescription

Specified by:

setMinimumScale in interface ILabelClassDescription2

Parameters:

pMinimumScale - The pMinimumScale (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExpressionType

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

ExpressionType.

Specified by:

getExpressionType in interface ILabelClassDescription2

Returns:

A com.esri.arcgis.carto.esriLabelExpressionType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExpressionType

public void setExpressionType(int expressionType)
                       throws java.io.IOException,
                              AutomationException

ExpressionType.

Specified by:

setExpressionType in interface ILabelClassDescription2

Parameters:

expressionType - A com.esri.arcgis.carto.esriLabelExpressionType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWhereClause

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

The SQL WhereClause for the label.

Specified by:

getWhereClause in interface ILabelClassDescription2

Returns:

The whereClause

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setWhereClause

public void setWhereClause(java.lang.String whereClause)
                    throws java.io.IOException,
                           AutomationException

The SQL WhereClause for the label.

Specified by:

setWhereClause in interface ILabelClassDescription2

Parameters:

whereClause - The whereClause (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.

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.

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.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws java.io.IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:

isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

The supported

Throws:

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

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public java.lang.Object convertToSupportedObject(int docVersion)
                                          throws java.io.IOException,
                                                 AutomationException

Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:

convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

A Variant

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