com.esri.arcgis.maplex
Class MaplexPlacedLabel

java.lang.Object
  extended by com.esri.arcgis.maplex.MaplexPlacedLabel
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, IMaplexPlacedLabel, Serializable

public class MaplexPlacedLabel
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IMaplexPlacedLabel

A label created by the Maplex Overposter.

Description

The label produced by the Maplex engine - these may be placed or even "unplaced" (which simply means that a satisfactory position could not be found).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Maplex Extension.

Supported Platforms

Windows

See Also:
com.esri.arcgis.maplex.MaplexExtension, MaplexOverposter, Serialized Form

Constructor Summary
MaplexPlacedLabel(Object obj)
          Construct a MaplexPlacedLabel using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 IPoint getAnchorPoint()
          The anchor point used for text backgrounds with a callout.
 IPolygon getBounds()
          The bounds of the placed label.
 double getCharacterSpacing()
          The character spacing of the placed label.
 double getCharacterWidth()
          The character width of the placed label.
 int getClassIndex()
          Class index associated with the label.
 int getFeatureID()
          FeatureID associated with the placed label.
 int getHorizontalAlignment()
          The horizontal alignment for the placed label.
 String getLabel()
          Text string that represents the label.
 double getLeading()
          The leading value for stacked labels.
 int getObjectType()
          Type of the placed object.
 int getPlacementCode()
          Code that indicates success/failure of placement.
 double getSize()
          Text size of the placed label.
 IGeometry getTextPath()
          Text path geometry for positioning the text.
 int getTextPathType()
          Type of text path.
 double getWordSpacing()
          The word spacing of the placed label.
 int hashCode()
          the hashcode for this object
 boolean isCJKCharactersRotation()
          Indicates if CJK charcters are rotated.
 void setAnchorPoint(IPoint anchorPoint)
          The anchor point used for text backgrounds with a callout.
 void setBounds(IPolygon bounds)
          The bounds of the placed label.
 void setCharacterSpacing(double spacing)
          The character spacing of the placed label.
 void setCharacterWidth(double width)
          The character width of the placed label.
 void setCJKCharactersRotation(boolean rotation)
          Indicates if CJK charcters are rotated.
 void setClassIndex(int index)
          Class index associated with the label.
 void setFeatureID(int featureID)
          FeatureID associated with the placed label.
 void setHorizontalAlignment(int alignment)
          The horizontal alignment for the placed label.
 void setLabel(String label)
          Text string that represents the label.
 void setLeading(double leading)
          The leading value for stacked labels.
 void setObjectType(int type)
          Type of the placed object.
 void setPlacementCode(int placementCode)
          Code that indicates success/failure of placement.
 void setSize(double size)
          Text size of the placed label.
 void setTextPath(IGeometry shape)
          Text path geometry for positioning the text.
 void setTextPathType(int textPathType)
          Type of text path.
 void setWordSpacing(double spacing)
          The word spacing of the placed label.
 
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

MaplexPlacedLabel

public MaplexPlacedLabel(Object obj)
                  throws IOException
Construct a MaplexPlacedLabel using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to MaplexPlacedLabel.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
MaplexPlacedLabel o = (MaplexPlacedLabel)obj; // will not work

MaplexPlacedLabel o = new MaplexPlacedLabel(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:
IOException - if there are interop problems MaplexPlacedLabel theMaplexPlacedLabel = (MaplexPlacedLabel) obj;
Method Detail

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

getObjectType

public int getObjectType()
                  throws IOException,
                         AutomationException
Type of the placed object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Maplex Extension.

Supported Platforms

Windows

Specified by:
getObjectType in interface IMaplexPlacedLabel
Returns:
A com.esri.arcgis.carto.esriPlacedObjectType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setObjectType

public void setObjectType(int type)
                   throws IOException,
                          AutomationException
Type of the placed object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Maplex Extension.

Specified by:
setObjectType in interface IMaplexPlacedLabel
Parameters:
type - A com.esri.arcgis.carto.esriPlacedObjectType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabel

public String getLabel()
                throws IOException,
                       AutomationException
Text string that represents the label.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Maplex Extension.

Supported Platforms

Windows

Specified by:
getLabel in interface IMaplexPlacedLabel
Returns:
The label
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabel

public void setLabel(String label)
              throws IOException,
                     AutomationException
Text string that represents the label.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Maplex Extension.

Specified by:
setLabel in interface IMaplexPlacedLabel
Parameters:
label - The label (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTextPath

public IGeometry getTextPath()
                      throws IOException,
                             AutomationException
Text path geometry for positioning the text.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Maplex Extension.

Specified by:
getTextPath in interface IMaplexPlacedLabel
Returns:
A reference to a com.esri.arcgis.geometry.IGeometry
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTextPath

public void setTextPath(IGeometry shape)
                 throws IOException,
                        AutomationException
Text path geometry for positioning the text.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Maplex Extension.

Specified by:
setTextPath in interface IMaplexPlacedLabel
Parameters:
shape - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTextPathType

public int getTextPathType()
                    throws IOException,
                           AutomationException
Type of text path.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Maplex Extension.

Specified by:
getTextPathType in interface IMaplexPlacedLabel
Returns:
A com.esri.arcgis.maplex.esriMaplexTextPathType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTextPathType

public void setTextPathType(int textPathType)
                     throws IOException,
                            AutomationException
Type of text path.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Maplex Extension.

Specified by:
setTextPathType in interface IMaplexPlacedLabel
Parameters:
textPathType - A com.esri.arcgis.maplex.esriMaplexTextPathType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFeatureID

public int getFeatureID()
                 throws IOException,
                        AutomationException
FeatureID associated with the placed label.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Maplex Extension.

Supported Platforms

Windows

Specified by:
getFeatureID in interface IMaplexPlacedLabel
Returns:
The featureID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFeatureID

public void setFeatureID(int featureID)
                  throws IOException,
                         AutomationException
FeatureID associated with the placed label.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Maplex Extension.

Specified by:
setFeatureID in interface IMaplexPlacedLabel
Parameters:
featureID - The featureID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPlacementCode

public int getPlacementCode()
                     throws IOException,
                            AutomationException
Code that indicates success/failure of placement.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Maplex Extension.

Supported Platforms

Windows

Specified by:
getPlacementCode in interface IMaplexPlacedLabel
Returns:
A com.esri.arcgis.carto.esriPlacementCode constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPlacementCode

public void setPlacementCode(int placementCode)
                      throws IOException,
                             AutomationException
Code that indicates success/failure of placement.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Maplex Extension.

Specified by:
setPlacementCode in interface IMaplexPlacedLabel
Parameters:
placementCode - A com.esri.arcgis.carto.esriPlacementCode constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassIndex

public int getClassIndex()
                  throws IOException,
                         AutomationException
Class index associated with the label.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Maplex Extension.

Specified by:
getClassIndex in interface IMaplexPlacedLabel
Returns:
The index
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setClassIndex

public void setClassIndex(int index)
                   throws IOException,
                          AutomationException
Class index associated with the label.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Maplex Extension.

Specified by:
setClassIndex in interface IMaplexPlacedLabel
Parameters:
index - The index (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSize

public double getSize()
               throws IOException,
                      AutomationException
Text size of the placed label.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Maplex Extension.

Supported Platforms

Windows

Specified by:
getSize in interface IMaplexPlacedLabel
Returns:
The size
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSize

public void setSize(double size)
             throws IOException,
                    AutomationException
Text size of the placed label.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Maplex Extension.

Specified by:
setSize in interface IMaplexPlacedLabel
Parameters:
size - The size (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCharacterWidth

public double getCharacterWidth()
                         throws IOException,
                                AutomationException
The character width of the placed label.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Maplex Extension.

Supported Platforms

Windows

Specified by:
getCharacterWidth in interface IMaplexPlacedLabel
Returns:
The width
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCharacterWidth

public void setCharacterWidth(double width)
                       throws IOException,
                              AutomationException
The character width of the placed label.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Maplex Extension.

Specified by:
setCharacterWidth in interface IMaplexPlacedLabel
Parameters:
width - The width (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWordSpacing

public double getWordSpacing()
                      throws IOException,
                             AutomationException
The word spacing of the placed label.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Maplex Extension.

Supported Platforms

Windows

Specified by:
getWordSpacing in interface IMaplexPlacedLabel
Returns:
The spacing
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setWordSpacing

public void setWordSpacing(double spacing)
                    throws IOException,
                           AutomationException
The word spacing of the placed label.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Maplex Extension.

Specified by:
setWordSpacing in interface IMaplexPlacedLabel
Parameters:
spacing - The spacing (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCharacterSpacing

public double getCharacterSpacing()
                           throws IOException,
                                  AutomationException
The character spacing of the placed label.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Maplex Extension.

Supported Platforms

Windows

Specified by:
getCharacterSpacing in interface IMaplexPlacedLabel
Returns:
The spacing
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCharacterSpacing

public void setCharacterSpacing(double spacing)
                         throws IOException,
                                AutomationException
The character spacing of the placed label.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Maplex Extension.

Specified by:
setCharacterSpacing in interface IMaplexPlacedLabel
Parameters:
spacing - The spacing (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLeading

public double getLeading()
                  throws IOException,
                         AutomationException
The leading value for stacked labels.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Maplex Extension.

Supported Platforms

Windows

Specified by:
getLeading in interface IMaplexPlacedLabel
Returns:
The leading
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLeading

public void setLeading(double leading)
                throws IOException,
                       AutomationException
The leading value for stacked labels.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Maplex Extension.

Specified by:
setLeading in interface IMaplexPlacedLabel
Parameters:
leading - The leading (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHorizontalAlignment

public int getHorizontalAlignment()
                           throws IOException,
                                  AutomationException
The horizontal alignment for the placed label.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Maplex Extension.

Supported Platforms

Windows

Specified by:
getHorizontalAlignment in interface IMaplexPlacedLabel
Returns:
A com.esri.arcgis.display.esriTextHorizontalAlignment constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHorizontalAlignment

public void setHorizontalAlignment(int alignment)
                            throws IOException,
                                   AutomationException
The horizontal alignment for the placed label.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Maplex Extension.

Specified by:
setHorizontalAlignment in interface IMaplexPlacedLabel
Parameters:
alignment - A com.esri.arcgis.display.esriTextHorizontalAlignment constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAnchorPoint

public IPoint getAnchorPoint()
                      throws IOException,
                             AutomationException
The anchor point used for text backgrounds with a callout.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Maplex Extension.

Specified by:
getAnchorPoint in interface IMaplexPlacedLabel
Returns:
A reference to a com.esri.arcgis.geometry.IPoint
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAnchorPoint

public void setAnchorPoint(IPoint anchorPoint)
                    throws IOException,
                           AutomationException
The anchor point used for text backgrounds with a callout.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Maplex Extension.

Specified by:
setAnchorPoint in interface IMaplexPlacedLabel
Parameters:
anchorPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBounds

public IPolygon getBounds()
                   throws IOException,
                          AutomationException
The bounds of the placed label.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Maplex Extension.

Specified by:
getBounds in interface IMaplexPlacedLabel
Returns:
A reference to a com.esri.arcgis.geometry.IPolygon
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBounds

public void setBounds(IPolygon bounds)
               throws IOException,
                      AutomationException
The bounds of the placed label.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Maplex Extension.

Specified by:
setBounds in interface IMaplexPlacedLabel
Parameters:
bounds - A reference to a com.esri.arcgis.geometry.IPolygon (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCJKCharactersRotation

public void setCJKCharactersRotation(boolean rotation)
                              throws IOException,
                                     AutomationException
Indicates if CJK charcters are rotated.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Maplex Extension.

Specified by:
setCJKCharactersRotation in interface IMaplexPlacedLabel
Parameters:
rotation - The rotation (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCJKCharactersRotation

public boolean isCJKCharactersRotation()
                                throws IOException,
                                       AutomationException
Indicates if CJK charcters are rotated.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Maplex Extension.

Specified by:
isCJKCharactersRotation in interface IMaplexPlacedLabel
Returns:
The rotation
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.