com.esri.arcgis.carto
Interface IMaplexOverposterLayerProperties2

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IMaplexOverposterLayerProperties2Proxy, MaplexOverposterLayerProperties

public interface IMaplexOverposterLayerProperties2
extends java.io.Serializable

COM Interface 'IMaplexOverposterLayerProperties2'. 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 for a layer.' 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	IID45baffd2_fde5_2846_dea4_256deffbb2aa
static int	xxDummy Deprecated. Internal use only

Method Summary

int	getContourAlignmentType() Indicates the options for the contour label alignment.
int	getContourLadderType() Indicates the options for the contour labed ladder types.
int	getContourMaximumAngle() The maximum angle at which a contour label may be placed.
int	getGraticuleAlignmentType() Indicates the options for the graticule alignment type.
int	getLineFeatureType() Indicates the options for the line feature type.
int	getMaximumLabelOverrunUnit() The maximum label overrun is interpreted to be in this unit.
int	getMinimumFeatureSizeUnit() The minimum feature size is interpreted to be in this unit.
int	getPolygonAnchorPointType() Indicates the options for the anchor point type.
int	getPolygonExternalZones(int zone) Indicates the placement priority associated with a zone external to the polygon.
int	getPolygonFeatureType() Indicates the options for the polygon feature type.
int	getPolygonInternalZones(int zone) Indicates the placement priority associated with a zone internal to the polygon.
int	getRepetitionIntervalUnit() The label repetition interval is interpreted to be in this unit.
double	getSecondaryOffsetMaximum() The maximum offset associated with a secondary label position.
double	getSecondaryOffsetMinimum() The minimum offset associated with a secondary label position.
int	getStrategyPriority(int strategy) Indicates the priority of a placement strategy when placing text.
int	getThinningDistanceUnit() The thinning distance is interpreted to be in this unit.
boolean	isCanFlipStackedStreetLabel() Indicates whether a stacked label may be flipped over to obtain a better position.
boolean	isCanPlaceLabelOnTopOfFeature() Indicates whether the label can be placed on top of the street feature.
boolean	isCanReduceLeading() Indicates whether the leading can be reduced for a stacked label.
boolean	isEnablePolygonFixedPosition() Indicates whether a label is to be placed at a fixed position in the polygon.
boolean	isEnableSecondaryOffset() Indicates whether to place a label at a secondary offset from the line feature.
boolean	isLabelBufferHardConstraint() Indicates whether the label buffer is a hard constraint and must be honored.
boolean	isMinimumSizeBasedOnArea() Indicates whether the minimum feature size for labeling is based on area.
boolean	isOffsetFromFeatureGeometry() Indicates whether to measure the label offset from the feature geometry.
void	setCanFlipStackedStreetLabel(boolean flag) Indicates whether a stacked label may be flipped over to obtain a better position.
void	setCanPlaceLabelOnTopOfFeature(boolean flag) Indicates whether the label can be placed on top of the street feature.
void	setCanReduceLeading(boolean flag) Indicates whether the leading can be reduced for a stacked label.
void	setContourAlignmentType(int option) Indicates the options for the contour label alignment.
void	setContourLadderType(int option) Indicates the options for the contour labed ladder types.
void	setContourMaximumAngle(int angle) The maximum angle at which a contour label may be placed.
void	setEnablePolygonFixedPosition(boolean flag) Indicates whether a label is to be placed at a fixed position in the polygon.
void	setEnableSecondaryOffset(boolean flag) Indicates whether to place a label at a secondary offset from the line feature.
void	setGraticuleAlignmentType(int option) Indicates the options for the graticule alignment type.
void	setIsLabelBufferHardConstraint(boolean flag) Indicates whether the label buffer is a hard constraint and must be honored.
void	setIsMinimumSizeBasedOnArea(boolean flag) Indicates whether the minimum feature size for labeling is based on area.
void	setIsOffsetFromFeatureGeometry(boolean flag) Indicates whether to measure the label offset from the feature geometry.
void	setLineFeatureType(int option) Indicates the options for the line feature type.
void	setMaximumLabelOverrunUnit(int unit) The maximum label overrun is interpreted to be in this unit.
void	setMinimumFeatureSizeUnit(int unit) The minimum feature size is interpreted to be in this unit.
void	setPolygonAnchorPointType(int option) Indicates the options for the anchor point type.
void	setPolygonExternalZones(int zone, int priority) Indicates the placement priority associated with a zone external to the polygon.
void	setPolygonFeatureType(int option) Indicates the options for the polygon feature type.
void	setPolygonInternalZones(int zone, int priority) Indicates the placement priority associated with a zone internal to the polygon.
void	setRepetitionIntervalUnit(int unit) The label repetition interval is interpreted to be in this unit.
void	setSecondaryOffsetMaximum(double offset) The maximum offset associated with a secondary label position.
void	setSecondaryOffsetMinimum(double offset) The minimum offset associated with a secondary label position.
void	setStrategyPriority(int strategy, int priority) Indicates the priority of a placement strategy when placing text.
void	setThinningDistanceUnit(int unit) The thinning distance is interpreted to be in this unit.

Field Detail

IID45baffd2_fde5_2846_dea4_256deffbb2aa

static final int IID45baffd2_fde5_2846_dea4_256deffbb2aa

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

getPolygonInternalZones

int getPolygonInternalZones(int zone)
                            throws java.io.IOException,
                                   AutomationException

Indicates the placement priority associated with a zone internal to the polygon.

Parameters:

zone - A com.esri.arcgis.carto.esriMaplexZoneIdentifier constant (in)

Returns:

The priority

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPolygonInternalZones

void setPolygonInternalZones(int zone,
                             int priority)
                             throws java.io.IOException,
                                    AutomationException

Indicates the placement priority associated with a zone internal to the polygon.

Parameters:

zone - A com.esri.arcgis.carto.esriMaplexZoneIdentifier constant (in)

priority - The priority (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPolygonExternalZones

int getPolygonExternalZones(int zone)
                            throws java.io.IOException,
                                   AutomationException

Indicates the placement priority associated with a zone external to the polygon.

Parameters:

zone - A com.esri.arcgis.carto.esriMaplexZoneIdentifier constant (in)

Returns:

The priority

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPolygonExternalZones

void setPolygonExternalZones(int zone,
                             int priority)
                             throws java.io.IOException,
                                    AutomationException

Indicates the placement priority associated with a zone external to the polygon.

Parameters:

zone - A com.esri.arcgis.carto.esriMaplexZoneIdentifier constant (in)

priority - The priority (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStrategyPriority

int getStrategyPriority(int strategy)
                        throws java.io.IOException,
                               AutomationException

Indicates the priority of a placement strategy when placing text.

Parameters:

strategy - A com.esri.arcgis.carto.esriMaplexStrategyIdentifier constant (in)

Returns:

The priority

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStrategyPriority

void setStrategyPriority(int strategy,
                         int priority)
                         throws java.io.IOException,
                                AutomationException

Indicates the priority of a placement strategy when placing text.

Parameters:

strategy - A com.esri.arcgis.carto.esriMaplexStrategyIdentifier constant (in)

priority - The priority (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGraticuleAlignmentType

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

Indicates the options for the graticule alignment type.

Returns:

A com.esri.arcgis.carto.esriMaplexGraticuleAlignmentType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGraticuleAlignmentType

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

Indicates the options for the graticule alignment type.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLineFeatureType

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

Indicates the options for the line feature type.

Returns:

A com.esri.arcgis.carto.esriMaplexLineFeatureType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLineFeatureType

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

Indicates the options for the line feature type.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPolygonFeatureType

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

Indicates the options for the polygon feature type.

Returns:

A com.esri.arcgis.carto.esriMaplexPolygonFeatureType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPolygonFeatureType

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

Indicates the options for the polygon feature type.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPolygonAnchorPointType

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

Indicates the options for the anchor point type.

Returns:

A com.esri.arcgis.carto.esriMaplexAnchorPointType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPolygonAnchorPointType

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

Indicates the options for the anchor point type.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getContourAlignmentType

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

Indicates the options for the contour label alignment.

Returns:

A com.esri.arcgis.carto.esriMaplexContourAlignmentType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setContourAlignmentType

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

Indicates the options for the contour label alignment.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getContourMaximumAngle

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

The maximum angle at which a contour label may be placed.

Returns:

The angle

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setContourMaximumAngle

void setContourMaximumAngle(int angle)
                            throws java.io.IOException,
                                   AutomationException

The maximum angle at which a contour label may be placed.

Parameters:

angle - The angle (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getContourLadderType

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

Indicates the options for the contour labed ladder types.

Returns:

A com.esri.arcgis.carto.esriMaplexContourLadderType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setContourLadderType

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

Indicates the options for the contour labed ladder types.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsOffsetFromFeatureGeometry

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

Indicates whether to measure the label offset from the feature geometry.

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isOffsetFromFeatureGeometry

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

Indicates whether to measure the label offset from the feature geometry.

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEnableSecondaryOffset

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

Indicates whether to place a label at a secondary offset from the line feature.

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEnableSecondaryOffset

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

Indicates whether to place a label at a secondary offset from the line feature.

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSecondaryOffsetMinimum

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

The minimum offset associated with a secondary label position.

Returns:

The offset

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSecondaryOffsetMinimum

void setSecondaryOffsetMinimum(double offset)
                               throws java.io.IOException,
                                      AutomationException

The minimum offset associated with a secondary label position.

Parameters:

offset - The offset (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSecondaryOffsetMaximum

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

The maximum offset associated with a secondary label position.

Returns:

The offset

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSecondaryOffsetMaximum

void setSecondaryOffsetMaximum(double offset)
                               throws java.io.IOException,
                                      AutomationException

The maximum offset associated with a secondary label position.

Parameters:

offset - The offset (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isLabelBufferHardConstraint

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

Indicates whether the label buffer is a hard constraint and must be honored.

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsLabelBufferHardConstraint

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

Indicates whether the label buffer is a hard constraint and must be honored.

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isMinimumSizeBasedOnArea

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

Indicates whether the minimum feature size for labeling is based on area.

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsMinimumSizeBasedOnArea

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

Indicates whether the minimum feature size for labeling is based on area.

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCanPlaceLabelOnTopOfFeature

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

Indicates whether the label can be placed on top of the street feature.

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCanPlaceLabelOnTopOfFeature

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

Indicates whether the label can be placed on top of the street feature.

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCanReduceLeading

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

Indicates whether the leading can be reduced for a stacked label.

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCanReduceLeading

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

Indicates whether the leading can be reduced for a stacked label.

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCanFlipStackedStreetLabel

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

Indicates whether a stacked label may be flipped over to obtain a better position.

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCanFlipStackedStreetLabel

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

Indicates whether a stacked label may be flipped over to obtain a better position.

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEnablePolygonFixedPosition

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

Indicates whether a label is to be placed at a fixed position in the polygon.

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEnablePolygonFixedPosition

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

Indicates whether a label is to be placed at a fixed position in the polygon.

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getThinningDistanceUnit

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

The thinning distance is 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.

setThinningDistanceUnit

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

The thinning distance is 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.

getRepetitionIntervalUnit

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

The label repetition interval is 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.

setRepetitionIntervalUnit

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

The label repetition interval is 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.

getMinimumFeatureSizeUnit

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

The minimum feature size is 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.

setMinimumFeatureSizeUnit

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

The minimum feature size is 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.

getMaximumLabelOverrunUnit

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

The maximum label overrun is 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.

setMaximumLabelOverrunUnit

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

The maximum label overrun is 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.