com.esri.arcgis.maplex
Interface IMaplexPlacedLabel

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IMaplexPlacedLabelProxy, MaplexPlacedLabel

public interface IMaplexPlacedLabel
extends java.io.Serializable

COM Interface 'IMaplexPlacedLabel'. Generated 3/19/2015 1:21:01 PM from 'C:\ArcGIS\COM\esriMaplex.olb'

Description: 'Provides access to members that define a placed label created by Maplex Overposter.' 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 =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID20664808_b1b4_ad3d_90dd_08a009ec732a
static int	xxDummy Deprecated. Internal use only

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.
java.lang.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(java.lang.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.

Field Detail

IID20664808_b1b4_ad3d_90dd_08a009ec732a

static final int IID20664808_b1b4_ad3d_90dd_08a009ec732a

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getObjectType

int getObjectType()
                  throws java.io.IOException,
                         AutomationException

Type of the placed object.

Returns:

A com.esri.arcgis.carto.esriPlacedObjectType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setObjectType

void setObjectType(int type)
                   throws java.io.IOException,
                          AutomationException

Type of the placed object.

Parameters:

type - A com.esri.arcgis.carto.esriPlacedObjectType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLabel

java.lang.String getLabel()
                          throws java.io.IOException,
                                 AutomationException

Text string that represents the label.

Returns:

The label

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLabel

void setLabel(java.lang.String label)
              throws java.io.IOException,
                     AutomationException

Text string that represents the label.

Parameters:

label - The label (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTextPath

IGeometry getTextPath()
                      throws java.io.IOException,
                             AutomationException

Text path geometry for positioning the text.

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTextPath

void setTextPath(IGeometry shape)
                 throws java.io.IOException,
                        AutomationException

Text path geometry for positioning the text.

Parameters:

shape - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTextPathType

int getTextPathType()
                    throws java.io.IOException,
                           AutomationException

Type of text path.

Returns:

A com.esri.arcgis.maplex.esriMaplexTextPathType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTextPathType

void setTextPathType(int textPathType)
                     throws java.io.IOException,
                            AutomationException

Type of text path.

Parameters:

textPathType - A com.esri.arcgis.maplex.esriMaplexTextPathType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFeatureID

int getFeatureID()
                 throws java.io.IOException,
                        AutomationException

FeatureID associated with the placed label.

Returns:

The featureID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFeatureID

void setFeatureID(int featureID)
                  throws java.io.IOException,
                         AutomationException

FeatureID associated with the placed label.

Parameters:

featureID - The featureID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPlacementCode

int getPlacementCode()
                     throws java.io.IOException,
                            AutomationException

Code that indicates success/failure of placement.

Returns:

A com.esri.arcgis.carto.esriPlacementCode constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPlacementCode

void setPlacementCode(int placementCode)
                      throws java.io.IOException,
                             AutomationException

Code that indicates success/failure of placement.

Parameters:

placementCode - A com.esri.arcgis.carto.esriPlacementCode constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassIndex

int getClassIndex()
                  throws java.io.IOException,
                         AutomationException

Class index associated with the label.

Returns:

The index

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setClassIndex

void setClassIndex(int index)
                   throws java.io.IOException,
                          AutomationException

Class index associated with the label.

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSize

double getSize()
               throws java.io.IOException,
                      AutomationException

Text size of the placed label.

Returns:

The size

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSize

void setSize(double size)
             throws java.io.IOException,
                    AutomationException

Text size of the placed label.

Parameters:

size - The size (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCharacterWidth

double getCharacterWidth()
                         throws java.io.IOException,
                                AutomationException

The character width of the placed label.

Returns:

The width

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCharacterWidth

void setCharacterWidth(double width)
                       throws java.io.IOException,
                              AutomationException

The character width of the placed label.

Parameters:

width - The width (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWordSpacing

double getWordSpacing()
                      throws java.io.IOException,
                             AutomationException

The word spacing of the placed label.

Returns:

The spacing

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setWordSpacing

void setWordSpacing(double spacing)
                    throws java.io.IOException,
                           AutomationException

The word spacing of the placed label.

Parameters:

spacing - The spacing (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCharacterSpacing

double getCharacterSpacing()
                           throws java.io.IOException,
                                  AutomationException

The character spacing of the placed label.

Returns:

The spacing

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCharacterSpacing

void setCharacterSpacing(double spacing)
                         throws java.io.IOException,
                                AutomationException

The character spacing of the placed label.

Parameters:

spacing - The spacing (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLeading

double getLeading()
                  throws java.io.IOException,
                         AutomationException

The leading value for stacked labels.

Returns:

The leading

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLeading

void setLeading(double leading)
                throws java.io.IOException,
                       AutomationException

The leading value for stacked labels.

Parameters:

leading - The leading (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHorizontalAlignment

int getHorizontalAlignment()
                           throws java.io.IOException,
                                  AutomationException

The horizontal alignment for the placed label.

Returns:

A com.esri.arcgis.display.esriTextHorizontalAlignment constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHorizontalAlignment

void setHorizontalAlignment(int alignment)
                            throws java.io.IOException,
                                   AutomationException

The horizontal alignment for the placed label.

Parameters:

alignment - A com.esri.arcgis.display.esriTextHorizontalAlignment constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAnchorPoint

IPoint getAnchorPoint()
                      throws java.io.IOException,
                             AutomationException

The anchor point used for text backgrounds with a callout.

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAnchorPoint

void setAnchorPoint(IPoint anchorPoint)
                    throws java.io.IOException,
                           AutomationException

The anchor point used for text backgrounds with a callout.

Parameters:

anchorPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBounds

IPolygon getBounds()
                   throws java.io.IOException,
                          AutomationException

The bounds of the placed label.

Returns:

A reference to a com.esri.arcgis.geometry.IPolygon

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBounds

void setBounds(IPolygon bounds)
               throws java.io.IOException,
                      AutomationException

The bounds of the placed label.

Parameters:

bounds - A reference to a com.esri.arcgis.geometry.IPolygon (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCJKCharactersRotation

void setCJKCharactersRotation(boolean rotation)
                              throws java.io.IOException,
                                     AutomationException

Indicates if CJK charcters are rotated.

Parameters:

rotation - The rotation (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCJKCharactersRotation

boolean isCJKCharactersRotation()
                                throws java.io.IOException,
                                       AutomationException

Indicates if CJK charcters are rotated.

Returns:

The rotation

Throws:

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

AutomationException - If the ArcObject component throws an exception.