com.esri.arcgis.carto
Class LabelEnvironment

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

All Implemented Interfaces:

ILabelEnvironment, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class LabelEnvironment
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ILabelEnvironment

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

Description 'An object that works with the labeling environment.' 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.ILabelEnvironment

IID, IID76765b93_ce78_11d2_9f36_00c04f6bc6a5, xxDummy

Constructor Summary

LabelEnvironment()
Constructs a LabelEnvironment using ArcGIS Engine.

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

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
ILabelStyle	getLabelStyle() Label style.
int	getLabelStyleMethod() The label style method.
int	getPlacement() The label placement method.
int	hashCode() the hashcode for this object
void	release() Release a LabelEnvironment.
void	setLabelStyleByRef(ILabelStyle labelStyle) Label style.
void	setLabelStyleMethod(int method) The label style method.
void	setPlacement(int placement) The label placement method.

Methods inherited from class java.lang.Object

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

Constructor Detail

LabelEnvironment

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

Constructs a LabelEnvironment using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

LabelEnvironment

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

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

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

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

Specified by:

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

setLabelStyleMethod

public void setLabelStyleMethod(int method)
                         throws java.io.IOException,
                                AutomationException

The label style method. This indicates whether the label style comes from the feature layer or the label environment.

Specified by:

setLabelStyleMethod in interface ILabelEnvironment

Parameters:

method - A com.esri.arcgis.carto.esriLabelEnvLabelStyleMethod constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLabelStyleMethod

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

The label style method. This indicates whether the label style comes from the feature layer or the label environment.

Specified by:

getLabelStyleMethod in interface ILabelEnvironment

Returns:

A com.esri.arcgis.carto.esriLabelEnvLabelStyleMethod constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPlacement

public void setPlacement(int placement)
                  throws java.io.IOException,
                         AutomationException

The label placement method.

Specified by:

setPlacement in interface ILabelEnvironment

Parameters:

placement - A com.esri.arcgis.carto.esriLabelEnvPlacement constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPlacement

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

The label placement method.

Specified by:

getPlacement in interface ILabelEnvironment

Returns:

A com.esri.arcgis.carto.esriLabelEnvPlacement constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLabelStyleByRef

public void setLabelStyleByRef(ILabelStyle labelStyle)
                        throws java.io.IOException,
                               AutomationException

Label style.

Specified by:

setLabelStyleByRef in interface ILabelEnvironment

Parameters:

labelStyle - A reference to a com.esri.arcgis.carto.ILabelStyle (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLabelStyle

public ILabelStyle getLabelStyle()
                          throws java.io.IOException,
                                 AutomationException

Label style.

Specified by:

getLabelStyle in interface ILabelEnvironment

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.