com.esri.arcgis.carto
Class ACSimpleLabelRenderer

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

All Implemented Interfaces:

IACAxl, IACLabelRenderer, IACRenderer, IACSimpleLabelRenderer, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class ACSimpleLabelRenderer
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IACAxl, IACRenderer, IACSimpleLabelRenderer, IACLabelRenderer, IPersist, IPersistStream, IClone, java.io.Externalizable

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

Description 'ArcIMS Simple Label 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.IACAxl

IID, IID10d4e467_fb51_49e1_bfcf_0faf531f2d52, xxDummy

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

IID, IIDe0969da1_00f8_4237_ae9a_d7229642b380, xxDummy

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

IID, IID2dd61b65_518c_4a94_a72a_1994074fa490, xxDummy

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

IID, IIDd71e6435_e35b_4ece_9d3f_e8d4bd66ca21, 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.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

Constructor Summary

ACSimpleLabelRenderer()
Constructs a ACSimpleLabelRenderer using ArcGIS Engine.

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

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
java.lang.Object	getElement() The element that represents the XML.
int	getFeatureWeight() The feature weight to prioritize the importance of features.
int	getHowManyLabels() Determines how often a feature will be labeled.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
double	getLabelBufferRatio() The buffer range around the label where no other labels will overlap.
java.lang.String	getLabelField() The name of the Field.
java.lang.String	getLabelProperties() The label properties.
IACSymbol	getLabelSymbol() Text symbol used to draw the labels.
int	getLabelWeight() The label weight to prioritize the importance of labels.
int	getLineLabelPosition() Determines where on the line to place the label.
java.lang.String	getRotationalAngles() The rotation angle of this label.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release a ACSimpleLabelRenderer.
void	save(IStream pstm, int fClearDirty) save
void	setElementByRef(java.lang.Object element) The element that represents the XML.
void	setFeatureWeight(int weight) The feature weight to prioritize the importance of features.
void	setHowManyLabels(int numLabels) Determines how often a feature will be labeled.
void	setLabelBufferRatio(double ratio) The buffer range around the label where no other labels will overlap.
void	setLabelField(java.lang.String name) The name of the Field.
void	setLabelProperties(java.lang.String props) The label properties.
void	setLabelSymbol(IACSymbol symbol) Text symbol used to draw the labels.
void	setLabelWeight(int weight) The label weight to prioritize the importance of labels.
void	setLineLabelPosition(int lineLabelPosition) Determines where on the line to place the label.
void	setRotationalAngles(java.lang.String angles) The rotation angle of this 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

ACSimpleLabelRenderer

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

Constructs a ACSimpleLabelRenderer using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ACSimpleLabelRenderer

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

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

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

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

Specified by:

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

getElement

public java.lang.Object getElement()
                            throws java.io.IOException,
                                   AutomationException

The element that represents the XML.

Specified by:

getElement in interface IACAxl

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setElementByRef

public void setElementByRef(java.lang.Object element)
                     throws java.io.IOException,
                            AutomationException

The element that represents the XML.

Specified by:

setElementByRef in interface IACAxl

Parameters:

element - A reference to another Object (IUnknown) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLabelSymbol

public IACSymbol getLabelSymbol()
                         throws java.io.IOException,
                                AutomationException

Text symbol used to draw the labels.

Specified by:

getLabelSymbol in interface IACLabelRenderer

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLabelSymbol

public void setLabelSymbol(IACSymbol symbol)
                    throws java.io.IOException,
                           AutomationException

Text symbol used to draw the labels.

Specified by:

setLabelSymbol in interface IACLabelRenderer

Parameters:

symbol - A reference to a com.esri.arcgis.carto.IACSymbol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLabelField

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

The name of the Field.

Specified by:

getLabelField in interface IACLabelRenderer

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLabelField

public void setLabelField(java.lang.String name)
                   throws java.io.IOException,
                          AutomationException

The name of the Field.

Specified by:

setLabelField in interface IACLabelRenderer

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFeatureWeight

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

The feature weight to prioritize the importance of features.

Specified by:

getFeatureWeight in interface IACLabelRenderer

Returns:

A com.esri.arcgis.carto.acLabelWeight constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFeatureWeight

public void setFeatureWeight(int weight)
                      throws java.io.IOException,
                             AutomationException

The feature weight to prioritize the importance of features.

Specified by:

setFeatureWeight in interface IACLabelRenderer

Parameters:

weight - A com.esri.arcgis.carto.acLabelWeight constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLabelWeight

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

The label weight to prioritize the importance of labels.

Specified by:

getLabelWeight in interface IACLabelRenderer

Returns:

A com.esri.arcgis.carto.acLabelWeight constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLabelWeight

public void setLabelWeight(int weight)
                    throws java.io.IOException,
                           AutomationException

The label weight to prioritize the importance of labels.

Specified by:

setLabelWeight in interface IACLabelRenderer

Parameters:

weight - A com.esri.arcgis.carto.acLabelWeight constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLabelBufferRatio

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

The buffer range around the label where no other labels will overlap.

Specified by:

getLabelBufferRatio in interface IACLabelRenderer

Returns:

The ratio

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLabelBufferRatio

public void setLabelBufferRatio(double ratio)
                         throws java.io.IOException,
                                AutomationException

The buffer range around the label where no other labels will overlap.

Specified by:

setLabelBufferRatio in interface IACLabelRenderer

Parameters:

ratio - The ratio (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLabelProperties

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

The label properties.

Specified by:

getLabelProperties in interface IACLabelRenderer

Returns:

The props

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLabelProperties

public void setLabelProperties(java.lang.String props)
                        throws java.io.IOException,
                               AutomationException

The label properties.

Specified by:

setLabelProperties in interface IACLabelRenderer

Parameters:

props - The props (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRotationalAngles

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

The rotation angle of this label.

Specified by:

getRotationalAngles in interface IACLabelRenderer

Returns:

The angles

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRotationalAngles

public void setRotationalAngles(java.lang.String angles)
                         throws java.io.IOException,
                                AutomationException

The rotation angle of this label.

Specified by:

setRotationalAngles in interface IACLabelRenderer

Parameters:

angles - The angles (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHowManyLabels

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

Determines how often a feature will be labeled.

Specified by:

getHowManyLabels in interface IACLabelRenderer

Returns:

A com.esri.arcgis.carto.acNumLabels constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHowManyLabels

public void setHowManyLabels(int numLabels)
                      throws java.io.IOException,
                             AutomationException

Determines how often a feature will be labeled.

Specified by:

setHowManyLabels in interface IACLabelRenderer

Parameters:

numLabels - A com.esri.arcgis.carto.acNumLabels constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLineLabelPosition

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

Determines where on the line to place the label.

Specified by:

getLineLabelPosition in interface IACLabelRenderer

Returns:

A com.esri.arcgis.carto.acLineLabelPosition constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLineLabelPosition

public void setLineLabelPosition(int lineLabelPosition)
                          throws java.io.IOException,
                                 AutomationException

Determines where on the line to place the label.

Specified by:

setLineLabelPosition in interface IACLabelRenderer

Parameters:

lineLabelPosition - A com.esri.arcgis.carto.acLineLabelPosition constant (in)

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.

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.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

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

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

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