com.esri.arcgis.maplex
Interface IMaplexPlacedLabel

All Superinterfaces:

Serializable

All Known Implementing Classes:

IMaplexPlacedLabelProxy, MaplexPlacedLabel

public interface IMaplexPlacedLabel
extends Serializable

Provides access to members that define a placed label created by Maplex Overposter.

Description

A MaplexPlacedLabel represents a single placed, or unplaced, label produced by the label placement process.

Remarks

Note that if the label was unplaced, it shares the same characteristics as a placed label, except its status is ‘unplaced’ and its position is set at the best found, which usually contains some overlap with other labels or a contorted label baseline.

Product Availability

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

Method Summary

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

Method Detail

getObjectType

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

Returns:

A com.esri.arcgis.carto.esriPlacedObjectType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setObjectType

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.

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

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

Returns:

The label

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabel

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.

Parameters:

label - The label (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextPath

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.

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

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.

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

int getTextPathType()
                    throws IOException,
                           AutomationException

Type of text path.

Product Availability

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

Returns:

A com.esri.arcgis.maplex.esriMaplexTextPathType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextPathType

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.

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

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

Returns:

The featureID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFeatureID

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.

Parameters:

featureID - The featureID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPlacementCode

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

Returns:

A com.esri.arcgis.carto.esriPlacementCode constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPlacementCode

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.

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

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.

Returns:

The index

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClassIndex

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.

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSize

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

Returns:

The size

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSize

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.

Parameters:

size - The size (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCharacterWidth

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

Returns:

The width

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCharacterWidth

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.

Parameters:

width - The width (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWordSpacing

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

Returns:

The spacing

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWordSpacing

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.

Parameters:

spacing - The spacing (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCharacterSpacing

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

Returns:

The spacing

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCharacterSpacing

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.

Parameters:

spacing - The spacing (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLeading

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

Returns:

The leading

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLeading

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.

Parameters:

leading - The leading (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHorizontalAlignment

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

Returns:

A com.esri.arcgis.display.esriTextHorizontalAlignment constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHorizontalAlignment

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.

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

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.

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

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.

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

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.

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

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.

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

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.

Parameters:

rotation - The rotation (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCJKCharactersRotation

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.

Returns:

The rotation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.