com.esri.arcgis.carto
Interface IMaplexRotationProperties

All Superinterfaces:

Serializable

All Known Implementing Classes:

MaplexRotationProperties

public interface IMaplexRotationProperties
extends Serializable

Provides access to members that control the placement of rotated labels.

Product Availability

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

Method Summary

String	getRotationField() The attribute field that contains the label angle.
int	getRotationType() Defines the format the rotation field in.
boolean	isAlignLabelToAngle() Indicates whether to draw the label aligned to the angle (no flip).
boolean	isEnable() Indicates whether to rotate a label by attribute.
boolean	isPerpendicularToAngle() Indicates whether to draw the label perpendicular to the angle.
void	setAlignLabelToAngle(boolean flag) Indicates whether to draw the label aligned to the angle (no flip).
void	setEnable(boolean flag) Indicates whether to rotate a label by attribute.
void	setPerpendicularToAngle(boolean flag) Indicates whether to draw the label perpendicular to the angle.
void	setRotationField(String field) The attribute field that contains the label angle.
void	setRotationType(int type) Defines the format the rotation field in.

Method Detail

isEnable

boolean isEnable()
                 throws IOException,
                        AutomationException

Indicates whether to rotate a label by attribute.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnable

void setEnable(boolean flag)
               throws IOException,
                      AutomationException

Indicates whether to rotate a label by attribute.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRotationType

int getRotationType()
                    throws IOException,
                           AutomationException

Defines the format the rotation field in.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.carto.esriLabelRotationType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRotationType

void setRotationType(int type)
                     throws IOException,
                            AutomationException

Defines the format the rotation field in.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRotationField

String getRotationField()
                        throws IOException,
                               AutomationException

The attribute field that contains the label angle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The field

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRotationField

void setRotationField(String field)
                      throws IOException,
                             AutomationException

The attribute field that contains the label angle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

field - The field (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPerpendicularToAngle

boolean isPerpendicularToAngle()
                               throws IOException,
                                      AutomationException

Indicates whether to draw the label perpendicular to the angle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPerpendicularToAngle

void setPerpendicularToAngle(boolean flag)
                             throws IOException,
                                    AutomationException

Indicates whether to draw the label perpendicular to the angle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAlignLabelToAngle

boolean isAlignLabelToAngle()
                            throws IOException,
                                   AutomationException

Indicates whether to draw the label aligned to the angle (no flip).

Product Availability

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

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAlignLabelToAngle

void setAlignLabelToAngle(boolean flag)
                          throws IOException,
                                 AutomationException

Indicates whether to draw the label aligned to the angle (no flip).

Product Availability

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

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.