com.esri.arcgis.carto
Class ACSimpleLabelRenderer

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

All Implemented Interfaces:

IACAxl, IACLabelRenderer, IACRenderer, IACSimpleLabelRenderer, IClone, IPersist, IPersistStream, java.io.Serializable

public class ACSimpleLabelRenderer

extends java.lang.Object

implements IACAxl, IACRenderer, IACSimpleLabelRenderer, IACLabelRenderer, IPersist, IPersistStream, IClone

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(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

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.
IACAxl	getAsIACAxl() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IACLabelRenderer	getAsIACLabelRenderer() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IACRenderer	getAsIACRenderer() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IACSimpleLabelRenderer	getAsIACSimpleLabelRenderer() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IClone	getAsIClone() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersist	getAsIPersist() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersistStream	getAsIPersistStream() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
void	getClassID(GUID[] pClassID) Supported Platforms
static java.lang.String	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.
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) Supported Platforms
int	hashCode() the hashcode for this object
void	isDirty() Supported Platforms
boolean	isEqual(IClone other) Returns TRUE when the receiver and other have the same properties.
boolean	isIdentical(IClone other) Returns TRUE when the receiver and other are the same object.
void	load(IStream pstm) Supported Platforms
void	save(IStream pstm, int fClearDirty) Supported Platforms
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.

Methods inherited from class java.lang.Object

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

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.

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.
ACSimpleLabelRenderer theACSimpleLabelRenderer = (ACSimpleLabelRenderer) obj;

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()

getAsIACAxl

public IACAxl getAsIACAxl()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIACRenderer

public IACRenderer getAsIACRenderer()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIACSimpleLabelRenderer

public IACSimpleLabelRenderer getAsIACSimpleLabelRenderer()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIACLabelRenderer

public IACLabelRenderer getAsIACLabelRenderer()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersist

public IPersist getAsIPersist()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersistStream

public IPersistStream getAsIPersistStream()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIClone

public IClone getAsIClone()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

getElement

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

Description copied from interface: IACAxl

The element that represents the XML.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IACAxl

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

Description copied from interface: IACLabelRenderer

Text symbol used to draw the labels.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLabelSymbol in interface IACLabelRenderer

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setLabelSymbol

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

Description copied from interface: IACLabelRenderer

Text symbol used to draw the labels.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IACLabelRenderer

The name of the Field.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IACLabelRenderer

The name of the Field.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IACLabelRenderer

The feature weight to prioritize the importance of features.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFeatureWeight in interface IACLabelRenderer

Returns:

A com.esri.arcgis.carto.acLabelWeight constant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setFeatureWeight

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

Description copied from interface: IACLabelRenderer

The feature weight to prioritize the importance of features.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IACLabelRenderer

The label weight to prioritize the importance of labels.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLabelWeight in interface IACLabelRenderer

Returns:

A com.esri.arcgis.carto.acLabelWeight constant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setLabelWeight

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

Description copied from interface: IACLabelRenderer

The label weight to prioritize the importance of labels.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IACLabelRenderer

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLabelBufferRatio in interface IACLabelRenderer

Returns:

The ratio

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setLabelBufferRatio

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

Description copied from interface: IACLabelRenderer

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

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IACLabelRenderer

The label properties.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IACLabelRenderer

The label properties.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLabelProperties in interface IACLabelRenderer

Parameters:

props - The props (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getRotationalAngles

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

Description copied from interface: IACLabelRenderer

The rotation angle of this label.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IACLabelRenderer

The rotation angle of this label.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IACLabelRenderer

Determines how often a feature will be labeled.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getHowManyLabels in interface IACLabelRenderer

Returns:

A com.esri.arcgis.carto.acNumLabels constant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setHowManyLabels

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

Description copied from interface: IACLabelRenderer

Determines how often a feature will be labeled.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setHowManyLabels in interface IACLabelRenderer

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getLineLabelPosition

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

Description copied from interface: IACLabelRenderer

Determines where on the line to place the label.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLineLabelPosition in interface IACLabelRenderer

Returns:

A com.esri.arcgis.carto.acLineLabelPosition constant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setLineLabelPosition

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

Description copied from interface: IACLabelRenderer

Determines where on the line to place the label.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLineLabelPosition in interface IACLabelRenderer

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getClassID

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

Description copied from interface: IPersist

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

save

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

esri_clone

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

Description copied from interface: IClone

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

Description copied from interface: IClone

Assigns the properties of src to the receiver.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:

assign in interface IClone

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isEqual

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

Description copied from interface: IClone

Returns TRUE when 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:

AutomationException - If the ArcObject component throws an exception.

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

isIdentical

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

Description copied from interface: IClone

Returns TRUE when 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:

AutomationException - If the ArcObject component throws an exception.

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