com.esri.arcgis.carto
Interface IBasicOverposterLayerProperties2

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

BasicOverposterLayerProperties, IBasicOverposterLayerProperties2Proxy

public interface IBasicOverposterLayerProperties2
extends java.io.Serializable

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

Description: 'Provides access to members that control the maximum distance labels/symbols are placed away from their respective features.' 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	IID6cc4facb_5f13_418a_bf24_d2c61d56fe66
static int	xxDummy Deprecated. Internal use only

Method Summary

double	getBufferRatio() Label buffer ratio.
int	getFeatureType() Feature type.
int	getFeatureWeight() Barrier weighting for features in the layer.
int	getLabelWeight() Barrier weighting for labels in the layer.
ILineLabelPlacementPriorities	getLineLabelPlacementPriorities() Line label placement position priority options.
ILineLabelPosition	getLineLabelPosition() Line label placement position options.
double	getLineOffset() Offset in map units at which labels will be placed away from line features.
double	getMaxDistanceFromTarget() Maximum distance in map units the label is allowed to be away from the feature.
int	getNumLabelsOption() Feature labeling option for the layer.
java.lang.Object	getPointPlacementAngles() Point label placement angle(s).
int	getPointPlacementMethod() Point label placement method.
IPointPlacementPriorities	getPointPlacementPriorities() Point label placement position priority options.
boolean	isGenerateUnplacedLabels() Indicates if unplaced labels are generated.
boolean	isPointPlacementOnTop() Indicates if point labels are placed on top of features.
void	setBufferRatio(double bufferRatio) Label buffer ratio.
void	setFeatureType(int type) Feature type.
void	setFeatureWeight(int weight) Barrier weighting for features in the layer.
void	setGenerateUnplacedLabels(boolean flag) Indicates if unplaced labels are generated.
void	setLabelWeight(int weight) Barrier weighting for labels in the layer.
void	setLineLabelPlacementPriorities(ILineLabelPlacementPriorities linePlacementPriorities) Line label placement position priority options.
void	setLineLabelPosition(ILineLabelPosition position) Line label placement position options.
void	setLineOffset(double lineOffset) Offset in map units at which labels will be placed away from line features.
void	setMaxDistanceFromTarget(double distance) Maximum distance in map units the label is allowed to be away from the feature.
void	setNumLabelsOption(int option) Feature labeling option for the layer.
void	setPointPlacementAngles(java.lang.Object angles) Point label placement angle(s).
void	setPointPlacementMethod(int method) Point label placement method.
void	setPointPlacementOnTop(boolean onTop) Indicates if point labels are placed on top of features.
void	setPointPlacementPriorities(IPointPlacementPriorities pointPlacementPriorities) Point label placement position priority options.

Field Detail

IID6cc4facb_5f13_418a_bf24_d2c61d56fe66

static final int IID6cc4facb_5f13_418a_bf24_d2c61d56fe66

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

getFeatureType

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

Feature type.

Returns:

A com.esri.arcgis.carto.esriBasicOverposterFeatureType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFeatureType

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

Feature type.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFeatureWeight

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

Barrier weighting for features in the layer.

Returns:

A com.esri.arcgis.carto.esriBasicOverposterWeight constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFeatureWeight

void setFeatureWeight(int weight)
                      throws java.io.IOException,
                             AutomationException

Barrier weighting for features in the layer.

Parameters:

weight - A com.esri.arcgis.carto.esriBasicOverposterWeight constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLabelWeight

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

Barrier weighting for labels in the layer.

Returns:

A com.esri.arcgis.carto.esriBasicOverposterWeight constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLabelWeight

void setLabelWeight(int weight)
                    throws java.io.IOException,
                           AutomationException

Barrier weighting for labels in the layer.

Parameters:

weight - A com.esri.arcgis.carto.esriBasicOverposterWeight constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNumLabelsOption

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

Feature labeling option for the layer.

Returns:

A com.esri.arcgis.carto.esriBasicNumLabelsOption constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNumLabelsOption

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

Feature labeling option for the layer.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLineLabelPosition

ILineLabelPosition getLineLabelPosition()
                                        throws java.io.IOException,
                                               AutomationException

Line label placement position options.

Returns:

A reference to a com.esri.arcgis.carto.ILineLabelPosition

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLineLabelPosition

void setLineLabelPosition(ILineLabelPosition position)
                          throws java.io.IOException,
                                 AutomationException

Line label placement position options.

Parameters:

position - A reference to a com.esri.arcgis.carto.ILineLabelPosition (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLineLabelPlacementPriorities

ILineLabelPlacementPriorities getLineLabelPlacementPriorities()
                                                              throws java.io.IOException,
                                                                     AutomationException

Line label placement position priority options.

Returns:

A reference to a com.esri.arcgis.carto.ILineLabelPlacementPriorities

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLineLabelPlacementPriorities

void setLineLabelPlacementPriorities(ILineLabelPlacementPriorities linePlacementPriorities)
                                     throws java.io.IOException,
                                            AutomationException

Line label placement position priority options.

Parameters:

linePlacementPriorities - A reference to a com.esri.arcgis.carto.ILineLabelPlacementPriorities (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isGenerateUnplacedLabels

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

Indicates if unplaced labels are generated.

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGenerateUnplacedLabels

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

Indicates if unplaced labels are generated.

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPointPlacementMethod

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

Point label placement method.

Returns:

A com.esri.arcgis.carto.esriOverposterPointPlacementMethod constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPointPlacementMethod

void setPointPlacementMethod(int method)
                             throws java.io.IOException,
                                    AutomationException

Point label placement method.

Parameters:

method - A com.esri.arcgis.carto.esriOverposterPointPlacementMethod constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isPointPlacementOnTop

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

Indicates if point labels are placed on top of features.

Returns:

The onTop

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPointPlacementOnTop

void setPointPlacementOnTop(boolean onTop)
                            throws java.io.IOException,
                                   AutomationException

Indicates if point labels are placed on top of features.

Parameters:

onTop - The onTop (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPointPlacementPriorities

IPointPlacementPriorities getPointPlacementPriorities()
                                                      throws java.io.IOException,
                                                             AutomationException

Point label placement position priority options.

Returns:

A reference to a com.esri.arcgis.carto.IPointPlacementPriorities

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPointPlacementPriorities

void setPointPlacementPriorities(IPointPlacementPriorities pointPlacementPriorities)
                                 throws java.io.IOException,
                                        AutomationException

Point label placement position priority options.

Parameters:

pointPlacementPriorities - A reference to a com.esri.arcgis.carto.IPointPlacementPriorities (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPointPlacementAngles

java.lang.Object getPointPlacementAngles()
                                         throws java.io.IOException,
                                                AutomationException

Point label placement angle(s).

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPointPlacementAngles

void setPointPlacementAngles(java.lang.Object angles)
                             throws java.io.IOException,
                                    AutomationException

Point label placement angle(s).

Parameters:

angles - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBufferRatio

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

Label buffer ratio. A value of 1 means a buffer the size of the label height.

Returns:

The bufferRatio

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBufferRatio

void setBufferRatio(double bufferRatio)
                    throws java.io.IOException,
                           AutomationException

Label buffer ratio. A value of 1 means a buffer the size of the label height.

Parameters:

bufferRatio - The bufferRatio (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLineOffset

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

Offset in map units at which labels will be placed away from line features.

Returns:

The lineOffset

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLineOffset

void setLineOffset(double lineOffset)
                   throws java.io.IOException,
                          AutomationException

Offset in map units at which labels will be placed away from line features.

Parameters:

lineOffset - The lineOffset (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaxDistanceFromTarget

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

Maximum distance in map units the label is allowed to be away from the feature.

Returns:

The distance

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaxDistanceFromTarget

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

Maximum distance in map units the label is allowed to be away from the feature.

Parameters:

distance - The distance (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.