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, Externalizable, Serializable

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

ArcIMS Simple Label Renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

ACSimpleLabelRenderer()
Constructs a ACSimpleLabelRenderer using ArcGIS Engine.

ACSimpleLabelRenderer(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(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 String	getClsid() getClsid.
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.
double	getLabelBufferRatio() The buffer range around the label where no other labels will overlap.
String	getLabelField() The name of the Field.
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.
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(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	setElementByRef(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(String name) The name of the Field.
void	setLabelProperties(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(String angles) The rotation angle of this label.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

ACSimpleLabelRenderer

public ACSimpleLabelRenderer()
                      throws IOException,
                             UnknownHostException

Constructs a ACSimpleLabelRenderer using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ACSimpleLabelRenderer

public ACSimpleLabelRenderer(Object obj)
                      throws 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:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getElement

public Object getElement()
                  throws IOException,
                         AutomationException

The element that represents the XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getElement in interface IACAxl

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setElementByRef

public void setElementByRef(Object element)
                     throws IOException,
                            AutomationException

The element that represents the XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setElementByRef in interface IACAxl

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabelSymbol

public IACSymbol getLabelSymbol()
                         throws IOException,
                                AutomationException

Text symbol used to draw the labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLabelSymbol in interface IACLabelRenderer

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelSymbol

public void setLabelSymbol(IACSymbol symbol)
                    throws IOException,
                           AutomationException

Text symbol used to draw the labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLabelSymbol in interface IACLabelRenderer

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabelField

public String getLabelField()
                     throws IOException,
                            AutomationException

The name of the Field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLabelField in interface IACLabelRenderer

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelField

public void setLabelField(String name)
                   throws IOException,
                          AutomationException

The name of the Field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLabelField in interface IACLabelRenderer

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFeatureWeight

public int getFeatureWeight()
                     throws IOException,
                            AutomationException

The feature weight to prioritize the importance of features.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFeatureWeight in interface IACLabelRenderer

Returns:

A com.esri.arcgis.carto.acLabelWeight constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFeatureWeight

public void setFeatureWeight(int weight)
                      throws IOException,
                             AutomationException

The feature weight to prioritize the importance of features.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFeatureWeight in interface IACLabelRenderer

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabelWeight

public int getLabelWeight()
                   throws IOException,
                          AutomationException

The label weight to prioritize the importance of labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLabelWeight in interface IACLabelRenderer

Returns:

A com.esri.arcgis.carto.acLabelWeight constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelWeight

public void setLabelWeight(int weight)
                    throws IOException,
                           AutomationException

The label weight to prioritize the importance of labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLabelWeight in interface IACLabelRenderer

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabelBufferRatio

public double getLabelBufferRatio()
                           throws IOException,
                                  AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLabelBufferRatio in interface IACLabelRenderer

Returns:

The ratio

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelBufferRatio

public void setLabelBufferRatio(double ratio)
                         throws IOException,
                                AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLabelBufferRatio in interface IACLabelRenderer

Parameters:

ratio - The ratio (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabelProperties

public String getLabelProperties()
                          throws IOException,
                                 AutomationException

The label properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLabelProperties in interface IACLabelRenderer

Returns:

The props

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelProperties

public void setLabelProperties(String props)
                        throws IOException,
                               AutomationException

The label properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLabelProperties in interface IACLabelRenderer

Parameters:

props - The props (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRotationalAngles

public String getRotationalAngles()
                           throws IOException,
                                  AutomationException

The rotation angle of this label.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getRotationalAngles in interface IACLabelRenderer

Returns:

The angles

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRotationalAngles

public void setRotationalAngles(String angles)
                         throws IOException,
                                AutomationException

The rotation angle of this label.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRotationalAngles in interface IACLabelRenderer

Parameters:

angles - The angles (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHowManyLabels

public int getHowManyLabels()
                     throws IOException,
                            AutomationException

Determines how often a feature will be labeled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getHowManyLabels in interface IACLabelRenderer

Returns:

A com.esri.arcgis.carto.acNumLabels constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHowManyLabels

public void setHowManyLabels(int numLabels)
                      throws IOException,
                             AutomationException

Determines how often a feature will be labeled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setHowManyLabels in interface IACLabelRenderer

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLineLabelPosition

public int getLineLabelPosition()
                         throws IOException,
                                AutomationException

Determines where on the line to place the label.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLineLabelPosition in interface IACLabelRenderer

Returns:

A com.esri.arcgis.carto.acLineLabelPosition constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLineLabelPosition

public void setLineLabelPosition(int lineLabelPosition)
                          throws IOException,
                                 AutomationException

Determines where on the line to place the label.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLineLabelPosition in interface IACLabelRenderer

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

assign in interface IClone

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEqual in interface IClone

Parameters:

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

Returns:

The equal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIdentical in interface IClone

Parameters:

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

Returns:

The identical

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException