com.esri.arcgis.carto
Interface IMaplexOffsetAlongLineProperties

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IMaplexOffsetAlongLinePropertiesProxy, MaplexOffsetAlongLineProperties

public interface IMaplexOffsetAlongLineProperties
extends java.io.Serializable

COM Interface 'IMaplexOffsetAlongLineProperties'. Generated 3/19/2015 1:20:52 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to members that control the placement of labels along a line feature.' 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_1a42_1fa1_fcd1_0b532f3c8ffa
static int	xxDummy Deprecated. Internal use only

Method Summary

double	getDistance() Distance along the line.
int	getDistanceUnit() The distance and tolerance are interpreted to be in this unit.
int	getLabelAnchorPoint() Anchor point on label where distance is measured to.
int	getPlacementMethod() Method of placing label along the line.
double	getTolerance() Tolerance either side of the specified position.
boolean	isUseLineDirection() Indicates whether to preserve the direction of line.
void	setDistance(double distance) Distance along the line.
void	setDistanceUnit(int unit) The distance and tolerance are interpreted to be in this unit.
void	setLabelAnchorPoint(int option) Anchor point on label where distance is measured to.
void	setPlacementMethod(int option) Method of placing label along the line.
void	setTolerance(double distance) Tolerance either side of the specified position.
void	setUseLineDirection(boolean flag) Indicates whether to preserve the direction of line.

Field Detail

IID20664808_1a42_1fa1_fcd1_0b532f3c8ffa

static final int IID20664808_1a42_1fa1_fcd1_0b532f3c8ffa

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

getPlacementMethod

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

Method of placing label along the line.

Returns:

A com.esri.arcgis.carto.esriMaplexOffsetAlongLineMethod constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPlacementMethod

void setPlacementMethod(int option)
                        throws java.io.IOException,
                               AutomationException

Method of placing label along the line.

Parameters:

option - A com.esri.arcgis.carto.esriMaplexOffsetAlongLineMethod constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLabelAnchorPoint

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

Anchor point on label where distance is measured to.

Returns:

A com.esri.arcgis.carto.esriMaplexLabelAnchorPoint constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLabelAnchorPoint

void setLabelAnchorPoint(int option)
                         throws java.io.IOException,
                                AutomationException

Anchor point on label where distance is measured to.

Parameters:

option - A com.esri.arcgis.carto.esriMaplexLabelAnchorPoint constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDistance

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

Distance along the line.

Returns:

The distance

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDistance

void setDistance(double distance)
                 throws java.io.IOException,
                        AutomationException

Distance along the line.

Parameters:

distance - The distance (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTolerance

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

Tolerance either side of the specified position.

Returns:

The distance

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTolerance

void setTolerance(double distance)
                  throws java.io.IOException,
                         AutomationException

Tolerance either side of the specified position.

Parameters:

distance - The distance (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDistanceUnit

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

The distance and tolerance are interpreted to be in this unit.

Returns:

A com.esri.arcgis.carto.esriMaplexUnit constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDistanceUnit

void setDistanceUnit(int unit)
                     throws java.io.IOException,
                            AutomationException

The distance and tolerance are interpreted to be in this unit.

Parameters:

unit - A com.esri.arcgis.carto.esriMaplexUnit constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseLineDirection

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

Indicates whether to preserve the direction of line.

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseLineDirection

void setUseLineDirection(boolean flag)
                         throws java.io.IOException,
                                AutomationException

Indicates whether to preserve the direction of line.

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.