com.esri.arcgis.carto
Interface IBasicOverposterLayerProperties4

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
BasicOverposterLayerProperties, IBasicOverposterLayerProperties4Proxy

public interface IBasicOverposterLayerProperties4
extends java.io.Serializable

COM Interface 'IBasicOverposterLayerProperties4'. 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 relative to features using conflict detection.' 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 IIDf64b3a44_c14c_4b12_994f_ae72196eec56
           
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.
 int getPolygonPlacementMethod()
          Polygon label placement method.
 java.lang.String getRotationField()
          The attribute field that contains the label angle.
 int getRotationType()
          Defines the format is the rotation field in.
 boolean isGenerateUnplacedLabels()
          Indicates if unplaced labels are generated.
 boolean isPerpendicularToAngle()
          Indicates whether the label should be drawn perpendicular to the angle.
 boolean isPlaceOnlyInsidePolygon()
          Indicates whether label is to be placed only within the polygon.
 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 setPerpendicularToAngle(boolean flag)
          Indicates whether the label should be drawn perpendicular to the angle.
 void setPlaceOnlyInsidePolygon(boolean flag)
          Indicates whether label is to be placed only within the polygon.
 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.
 void setPolygonPlacementMethod(int method)
          Polygon label placement method.
 void setRotationField(java.lang.String field)
          The attribute field that contains the label angle.
 void setRotationType(int type)
          Defines the format is the rotation field in.
 

Field Detail

IIDf64b3a44_c14c_4b12_994f_ae72196eec56

static final int IIDf64b3a44_c14c_4b12_994f_ae72196eec56
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.

getRotationType

int getRotationType()
                    throws java.io.IOException,
                           AutomationException
Defines the format is the rotation field in.

Returns:
A com.esri.arcgis.carto.esriLabelRotationType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRotationType

void setRotationType(int type)
                     throws java.io.IOException,
                            AutomationException
Defines the format is the rotation field in.

Parameters:
type - A com.esri.arcgis.carto.esriLabelRotationType constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRotationField

java.lang.String getRotationField()
                                  throws java.io.IOException,
                                         AutomationException
The attribute field that contains the label angle.

Returns:
The field
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRotationField

void setRotationField(java.lang.String field)
                      throws java.io.IOException,
                             AutomationException
The attribute field that contains the label angle.

Parameters:
field - The field (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isPerpendicularToAngle

boolean isPerpendicularToAngle()
                               throws java.io.IOException,
                                      AutomationException
Indicates whether the label should be drawn perpendicular to the angle.

Returns:
The flag
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPerpendicularToAngle

void setPerpendicularToAngle(boolean flag)
                             throws java.io.IOException,
                                    AutomationException
Indicates whether the label should be drawn perpendicular to the angle.

Parameters:
flag - The flag (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPolygonPlacementMethod

int getPolygonPlacementMethod()
                              throws java.io.IOException,
                                     AutomationException
Polygon label placement method.

Returns:
A com.esri.arcgis.carto.esriOverposterPolygonPlacementMethod constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPolygonPlacementMethod

void setPolygonPlacementMethod(int method)
                               throws java.io.IOException,
                                      AutomationException
Polygon label placement method.

Parameters:
method - A com.esri.arcgis.carto.esriOverposterPolygonPlacementMethod constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isPlaceOnlyInsidePolygon

boolean isPlaceOnlyInsidePolygon()
                                 throws java.io.IOException,
                                        AutomationException
Indicates whether label is to be placed only within the polygon.

Returns:
The flag
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPlaceOnlyInsidePolygon

void setPlaceOnlyInsidePolygon(boolean flag)
                               throws java.io.IOException,
                                      AutomationException
Indicates whether label is to be placed only within the polygon.

Parameters:
flag - The flag (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.