com.esri.arcgis.carto
Interface IMaplexOverposterLayerProperties

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
IMaplexOverposterLayerPropertiesProxy, MaplexOverposterLayerProperties

public interface IMaplexOverposterLayerProperties
extends java.io.Serializable

COM Interface 'IMaplexOverposterLayerProperties'. 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 IID20664808_3fe2_1ed1_8109_085679ec732a
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 int getConstrainOffset()
          Label constraint options.
 java.lang.String getDictionaryName()
          Name of the abbreviations dictionary referenced by this layer.
 int getFeatureBuffer()
          Increase buffer around a point feature to stop labels from being placed too close to the feature.
 int getFeatureType()
          The feature type for labeling.
 int getFeatureWeight()
          Feature weight controls which features may be overlapped and to what extent.
 double getFontHeightReductionLimit()
          The font may be reduced in height until this limit is reached.
 double getFontHeightReductionStep()
          This is the step interval for font height reduction.
 double getFontWidthReductionLimit()
          The font may be reduced in width until this limit is reached.
 double getFontWidthReductionStep()
          This is the step interval for font width reduction.
 int getLabelBuffer()
          Increase buffer to stop labels from being placed too close to each other.
 int getLabelPriority()
          Label prority controls approximate placement order.
 IMaplexLabelStackingProperties getLabelStackingProperties()
          The label stacking properties for a layer.
 int getLinePlacementMethod()
          Line placement options.
 double getMaximumCharacterSpacing()
          The character spacing may be increased upto this limit.
 double getMaximumLabelOverrun()
          Maximum distance that a label is allowed to overrun the end of its feature.
 double getMaximumWordSpacing()
          The word spacing may be increased upto this limit.
 double getMinimumEndOfStreetClearance()
          Minimum clearance between street label and street end.
 double getMinimumRepetitionInterval()
          Interval that must elapse before label is repeated.
 double getMinimumSizeForLabeling()
          Specifies a minimum size of a line or area feature for it to be labeled.
 IMaplexOffsetAlongLineProperties getOffsetAlongLineProperties()
          The offset along line properties for a layer.
 int getPointPlacementMethod()
          Point placement options.
 IPointPlacementPriorities getPointPlacementPriorities()
          Controls placement of label around point fetaure.
 int getPolygonBoundaryWeight()
          Feature Weight for the boundary of the polygon.
 int getPolygonPlacementMethod()
          Polygon placement options.
 double getPreferredEndOfStreetClearance()
          Preferred clearance between street label and street end.
 double getPrimaryOffset()
          Primary offset between label and symbol.
 int getPrimaryOffsetUnit()
          The primary offset is interpreted to be in this unit.
 IMaplexRotationProperties getRotationProperties()
          The label rotation properties for a layer.
 double getSecondaryOffset()
          Secondary offset between label and symbol.
 double getThinningDistance()
          Distance used to control the thinning of duplicate labels.
 boolean isAlignLabelToLineDirection()
          Indicates whether to align the label with the label direction so the label may appear upside down.
 boolean isAllowAsymmetricOverrun()
          Indicates whether a label may overrun one side of a polygon feature.
 boolean isBackgroundLabel()
          Indicates whether to place the label first and allow other labels to be placed over it.
 boolean isCanAbbreviateLabel()
          Indicates whether to abbreviate the label using an abbreviation dictionary.
 boolean isCanOverrunFeature()
          Indicates whether to place the label over end of line or over polygon boundary.
 boolean isCanPlaceLabelOutsidePolygon()
          Indicates whether to place a label outside the polygon if it does not fit inside.
 boolean isCanReduceFontSize()
          Indicates whether to reduce the size of the font.
 boolean isCanRemoveOverlappingLabel()
          Indicates whether to remove the label if it overlaps with other labels.
 boolean isCanShiftPointLabel()
          Indicates whether to allow the point label to be shifted upon a fixed position.
 boolean isCanStackLabel()
          Indicates whether to stack the label to obtain a better position.
 boolean isCanTruncateLabel()
          Indicates whether to truncate the label using an algorithm.
 boolean isEnablePointPlacementPriorities()
          Indicates whether to use user-defined point placement priorities.
 boolean isGraticuleAlignment()
          Indicates whether to enable graticule alignment.
 boolean isLandParcelPlacement()
          Indicates whether to place the label within land parcel polygon avoiding building footprint.
 boolean isNeverRemoveLabel()
          Indicates whether to not remove the label if no position is found.
 boolean isPreferHorizontalPlacement()
          Indicates if there is a preference to place the label horizontally.
 boolean isRepeatLabel()
          Indicates whether to enable the repetition of label along line feature.
 boolean isSpreadCharacters()
          Indicates whether to spread label characters along line feature.
 boolean isSpreadWords()
          Indicates whether to spread words along line feature.
 boolean isStreetPlacement()
          Indicates whether to enable street placement techniques.
 boolean isThinDuplicateLabels()
          Indicates whether to remove duplicate labels that lie within a specified distance of each other.
 void setAlignLabelToLineDirection(boolean flag)
          Indicates whether to align the label with the label direction so the label may appear upside down.
 void setAllowAsymmetricOverrun(boolean flag)
          Indicates whether a label may overrun one side of a polygon feature.
 void setBackgroundLabel(boolean flag)
          Indicates whether to place the label first and allow other labels to be placed over it.
 void setCanAbbreviateLabel(boolean flag)
          Indicates whether to abbreviate the label using an abbreviation dictionary.
 void setCanOverrunFeature(boolean flag)
          Indicates whether to place the label over end of line or over polygon boundary.
 void setCanPlaceLabelOutsidePolygon(boolean flag)
          Indicates whether to place a label outside the polygon if it does not fit inside.
 void setCanReduceFontSize(boolean flag)
          Indicates whether to reduce the size of the font.
 void setCanRemoveOverlappingLabel(boolean flag)
          Indicates whether to remove the label if it overlaps with other labels.
 void setCanShiftPointLabel(boolean flag)
          Indicates whether to allow the point label to be shifted upon a fixed position.
 void setCanStackLabel(boolean flag)
          Indicates whether to stack the label to obtain a better position.
 void setCanTruncateLabel(boolean flag)
          Indicates whether to truncate the label using an algorithm.
 void setConstrainOffset(int option)
          Label constraint options.
 void setDictionaryName(java.lang.String text)
          Name of the abbreviations dictionary referenced by this layer.
 void setEnablePointPlacementPriorities(boolean flag)
          Indicates whether to use user-defined point placement priorities.
 void setFeatureBuffer(int buffer)
          Increase buffer around a point feature to stop labels from being placed too close to the feature.
 void setFeatureType(int type)
          The feature type for labeling.
 void setFeatureWeight(int weight)
          Feature weight controls which features may be overlapped and to what extent.
 void setFontHeightReductionLimit(double limit)
          The font may be reduced in height until this limit is reached.
 void setFontHeightReductionStep(double step)
          This is the step interval for font height reduction.
 void setFontWidthReductionLimit(double limit)
          The font may be reduced in width until this limit is reached.
 void setFontWidthReductionStep(double step)
          This is the step interval for font width reduction.
 void setGraticuleAlignment(boolean flag)
          Indicates whether to enable graticule alignment.
 void setIsStreetPlacement(boolean flag)
          Indicates whether to enable street placement techniques.
 void setLabelBuffer(int buffer)
          Increase buffer to stop labels from being placed too close to each other.
 void setLabelPriority(int priority)
          Label prority controls approximate placement order.
 void setLabelStackingProperties(IMaplexLabelStackingProperties props)
          The label stacking properties for a layer.
 void setLandParcelPlacement(boolean flag)
          Indicates whether to place the label within land parcel polygon avoiding building footprint.
 void setLinePlacementMethod(int method)
          Line placement options.
 void setMaximumCharacterSpacing(double spacing)
          The character spacing may be increased upto this limit.
 void setMaximumLabelOverrun(double distance)
          Maximum distance that a label is allowed to overrun the end of its feature.
 void setMaximumWordSpacing(double spacing)
          The word spacing may be increased upto this limit.
 void setMinimumEndOfStreetClearance(double clearance)
          Minimum clearance between street label and street end.
 void setMinimumRepetitionInterval(double interval)
          Interval that must elapse before label is repeated.
 void setMinimumSizeForLabeling(double size)
          Specifies a minimum size of a line or area feature for it to be labeled.
 void setNeverRemoveLabel(boolean flag)
          Indicates whether to not remove the label if no position is found.
 void setOffsetAlongLineProperties(IMaplexOffsetAlongLineProperties props)
          The offset along line properties for a layer.
 void setPointPlacementMethod(int method)
          Point placement options.
 void setPointPlacementPriorities(IPointPlacementPriorities priorities)
          Controls placement of label around point fetaure.
 void setPolygonBoundaryWeight(int weight)
          Feature Weight for the boundary of the polygon.
 void setPolygonPlacementMethod(int method)
          Polygon placement options.
 void setPreferHorizontalPlacement(boolean flag)
          Indicates if there is a preference to place the label horizontally.
 void setPreferredEndOfStreetClearance(double clearance)
          Preferred clearance between street label and street end.
 void setPrimaryOffset(double offset)
          Primary offset between label and symbol.
 void setPrimaryOffsetUnit(int unit)
          The primary offset is interpreted to be in this unit.
 void setRepeatLabel(boolean flag)
          Indicates whether to enable the repetition of label along line feature.
 void setRotationProperties(IMaplexRotationProperties props)
          The label rotation properties for a layer.
 void setSecondaryOffset(double offset)
          Secondary offset between label and symbol.
 void setSpreadCharacters(boolean flag)
          Indicates whether to spread label characters along line feature.
 void setSpreadWords(boolean flag)
          Indicates whether to spread words along line feature.
 void setThinDuplicateLabels(boolean flag)
          Indicates whether to remove duplicate labels that lie within a specified distance of each other.
 void setThinningDistance(double distance)
          Distance used to control the thinning of duplicate labels.
 

Field Detail

IID20664808_3fe2_1ed1_8109_085679ec732a

static final int IID20664808_3fe2_1ed1_8109_085679ec732a
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
The feature type for labeling.

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
The feature type for labeling.

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.

getPointPlacementMethod

int getPointPlacementMethod()
                            throws java.io.IOException,
                                   AutomationException
Point placement options.

Returns:
A com.esri.arcgis.carto.esriMaplexPointPlacementMethod 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 placement options.

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

getLinePlacementMethod

int getLinePlacementMethod()
                           throws java.io.IOException,
                                  AutomationException
Line placement options.

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

setLinePlacementMethod

void setLinePlacementMethod(int method)
                            throws java.io.IOException,
                                   AutomationException
Line placement options.

Parameters:
method - A com.esri.arcgis.carto.esriMaplexLinePlacementMethod constant (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 placement options.

Returns:
A com.esri.arcgis.carto.esriMaplexPolygonPlacementMethod 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 placement options.

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

isCanPlaceLabelOutsidePolygon

boolean isCanPlaceLabelOutsidePolygon()
                                      throws java.io.IOException,
                                             AutomationException
Indicates whether to place a label outside the polygon if it does not fit inside.

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

setCanPlaceLabelOutsidePolygon

void setCanPlaceLabelOutsidePolygon(boolean flag)
                                    throws java.io.IOException,
                                           AutomationException
Indicates whether to place a label outside the polygon if it does not fit inside.

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

isPreferHorizontalPlacement

boolean isPreferHorizontalPlacement()
                                    throws java.io.IOException,
                                           AutomationException
Indicates if there is a preference to place the label horizontally.

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

setPreferHorizontalPlacement

void setPreferHorizontalPlacement(boolean flag)
                                  throws java.io.IOException,
                                         AutomationException
Indicates if there is a preference to place the label horizontally.

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

isLandParcelPlacement

boolean isLandParcelPlacement()
                              throws java.io.IOException,
                                     AutomationException
Indicates whether to place the label within land parcel polygon avoiding building footprint.

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

setLandParcelPlacement

void setLandParcelPlacement(boolean flag)
                            throws java.io.IOException,
                                   AutomationException
Indicates whether to place the label within land parcel polygon avoiding building footprint.

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

getPrimaryOffset

double getPrimaryOffset()
                        throws java.io.IOException,
                               AutomationException
Primary offset between label and symbol.

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

setPrimaryOffset

void setPrimaryOffset(double offset)
                      throws java.io.IOException,
                             AutomationException
Primary offset between label and symbol.

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

getPrimaryOffsetUnit

int getPrimaryOffsetUnit()
                         throws java.io.IOException,
                                AutomationException
The primary offset 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.

setPrimaryOffsetUnit

void setPrimaryOffsetUnit(int unit)
                          throws java.io.IOException,
                                 AutomationException
The primary offset 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.

getSecondaryOffset

double getSecondaryOffset()
                          throws java.io.IOException,
                                 AutomationException
Secondary offset between label and symbol.

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

setSecondaryOffset

void setSecondaryOffset(double offset)
                        throws java.io.IOException,
                               AutomationException
Secondary offset between label and symbol.

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

getConstrainOffset

int getConstrainOffset()
                       throws java.io.IOException,
                              AutomationException
Label constraint options.

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

setConstrainOffset

void setConstrainOffset(int option)
                        throws java.io.IOException,
                               AutomationException
Label constraint options.

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

isEnablePointPlacementPriorities

boolean isEnablePointPlacementPriorities()
                                         throws java.io.IOException,
                                                AutomationException
Indicates whether to use user-defined point placement priorities.

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

setEnablePointPlacementPriorities

void setEnablePointPlacementPriorities(boolean flag)
                                       throws java.io.IOException,
                                              AutomationException
Indicates whether to use user-defined point placement priorities.

Parameters:
flag - The flag (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
Controls placement of label around point fetaure.

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 priorities)
                                 throws java.io.IOException,
                                        AutomationException
Controls placement of label around point fetaure.

Parameters:
priorities - 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.

isCanShiftPointLabel

boolean isCanShiftPointLabel()
                             throws java.io.IOException,
                                    AutomationException
Indicates whether to allow the point label to be shifted upon a fixed position.

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

setCanShiftPointLabel

void setCanShiftPointLabel(boolean flag)
                           throws java.io.IOException,
                                  AutomationException
Indicates whether to allow the point label to be shifted upon a fixed position.

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

isStreetPlacement

boolean isStreetPlacement()
                          throws java.io.IOException,
                                 AutomationException
Indicates whether to enable street placement techniques.

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

setIsStreetPlacement

void setIsStreetPlacement(boolean flag)
                          throws java.io.IOException,
                                 AutomationException
Indicates whether to enable street placement techniques.

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

isRepeatLabel

boolean isRepeatLabel()
                      throws java.io.IOException,
                             AutomationException
Indicates whether to enable the repetition of label along line feature.

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

setRepeatLabel

void setRepeatLabel(boolean flag)
                    throws java.io.IOException,
                           AutomationException
Indicates whether to enable the repetition of label along line feature.

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

getMinimumRepetitionInterval

double getMinimumRepetitionInterval()
                                    throws java.io.IOException,
                                           AutomationException
Interval that must elapse before label is repeated.

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

setMinimumRepetitionInterval

void setMinimumRepetitionInterval(double interval)
                                  throws java.io.IOException,
                                         AutomationException
Interval that must elapse before label is repeated.

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

isSpreadCharacters

boolean isSpreadCharacters()
                           throws java.io.IOException,
                                  AutomationException
Indicates whether to spread label characters along line feature.

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

setSpreadCharacters

void setSpreadCharacters(boolean flag)
                         throws java.io.IOException,
                                AutomationException
Indicates whether to spread label characters along line feature.

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

getMaximumCharacterSpacing

double getMaximumCharacterSpacing()
                                  throws java.io.IOException,
                                         AutomationException
The character spacing may be increased upto this limit.

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

setMaximumCharacterSpacing

void setMaximumCharacterSpacing(double spacing)
                                throws java.io.IOException,
                                       AutomationException
The character spacing may be increased upto this limit.

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

isSpreadWords

boolean isSpreadWords()
                      throws java.io.IOException,
                             AutomationException
Indicates whether to spread words along line feature.

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

setSpreadWords

void setSpreadWords(boolean flag)
                    throws java.io.IOException,
                           AutomationException
Indicates whether to spread words along line feature.

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

getMaximumWordSpacing

double getMaximumWordSpacing()
                             throws java.io.IOException,
                                    AutomationException
The word spacing may be increased upto this limit.

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

setMaximumWordSpacing

void setMaximumWordSpacing(double spacing)
                           throws java.io.IOException,
                                  AutomationException
The word spacing may be increased upto this limit.

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

getPreferredEndOfStreetClearance

double getPreferredEndOfStreetClearance()
                                        throws java.io.IOException,
                                               AutomationException
Preferred clearance between street label and street end.

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

setPreferredEndOfStreetClearance

void setPreferredEndOfStreetClearance(double clearance)
                                      throws java.io.IOException,
                                             AutomationException
Preferred clearance between street label and street end.

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

getMinimumEndOfStreetClearance

double getMinimumEndOfStreetClearance()
                                      throws java.io.IOException,
                                             AutomationException
Minimum clearance between street label and street end.

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

setMinimumEndOfStreetClearance

void setMinimumEndOfStreetClearance(double clearance)
                                    throws java.io.IOException,
                                           AutomationException
Minimum clearance between street label and street end.

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

isCanStackLabel

boolean isCanStackLabel()
                        throws java.io.IOException,
                               AutomationException
Indicates whether to stack the label 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.

setCanStackLabel

void setCanStackLabel(boolean flag)
                      throws java.io.IOException,
                             AutomationException
Indicates whether to stack the label 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.

getLabelStackingProperties

IMaplexLabelStackingProperties getLabelStackingProperties()
                                                          throws java.io.IOException,
                                                                 AutomationException
The label stacking properties for a layer.

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

setLabelStackingProperties

void setLabelStackingProperties(IMaplexLabelStackingProperties props)
                                throws java.io.IOException,
                                       AutomationException
The label stacking properties for a layer.

Parameters:
props - A reference to a com.esri.arcgis.carto.IMaplexLabelStackingProperties (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanOverrunFeature

boolean isCanOverrunFeature()
                            throws java.io.IOException,
                                   AutomationException
Indicates whether to place the label over end of line or over polygon boundary.

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

setCanOverrunFeature

void setCanOverrunFeature(boolean flag)
                          throws java.io.IOException,
                                 AutomationException
Indicates whether to place the label over end of line or over polygon boundary.

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

getMaximumLabelOverrun

double getMaximumLabelOverrun()
                              throws java.io.IOException,
                                     AutomationException
Maximum distance that a label is allowed to overrun the end of its feature.

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

setMaximumLabelOverrun

void setMaximumLabelOverrun(double distance)
                            throws java.io.IOException,
                                   AutomationException
Maximum distance that a label is allowed to overrun the end of its feature.

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

isAllowAsymmetricOverrun

boolean isAllowAsymmetricOverrun()
                                 throws java.io.IOException,
                                        AutomationException
Indicates whether a label may overrun one side of a polygon feature.

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

setAllowAsymmetricOverrun

void setAllowAsymmetricOverrun(boolean flag)
                               throws java.io.IOException,
                                      AutomationException
Indicates whether a label may overrun one side of a polygon feature.

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

isCanAbbreviateLabel

boolean isCanAbbreviateLabel()
                             throws java.io.IOException,
                                    AutomationException
Indicates whether to abbreviate the label using an abbreviation dictionary.

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

setCanAbbreviateLabel

void setCanAbbreviateLabel(boolean flag)
                           throws java.io.IOException,
                                  AutomationException
Indicates whether to abbreviate the label using an abbreviation dictionary.

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

isCanTruncateLabel

boolean isCanTruncateLabel()
                           throws java.io.IOException,
                                  AutomationException
Indicates whether to truncate the label using an algorithm.

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

setCanTruncateLabel

void setCanTruncateLabel(boolean flag)
                         throws java.io.IOException,
                                AutomationException
Indicates whether to truncate the label using an algorithm.

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

isCanReduceFontSize

boolean isCanReduceFontSize()
                            throws java.io.IOException,
                                   AutomationException
Indicates whether to reduce the size of the font.

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

setCanReduceFontSize

void setCanReduceFontSize(boolean flag)
                          throws java.io.IOException,
                                 AutomationException
Indicates whether to reduce the size of the font.

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

setFontHeightReductionLimit

void setFontHeightReductionLimit(double limit)
                                 throws java.io.IOException,
                                        AutomationException
The font may be reduced in height until this limit is reached.

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

getFontHeightReductionLimit

double getFontHeightReductionLimit()
                                   throws java.io.IOException,
                                          AutomationException
The font may be reduced in height until this limit is reached.

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

setFontHeightReductionStep

void setFontHeightReductionStep(double step)
                                throws java.io.IOException,
                                       AutomationException
This is the step interval for font height reduction.

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

getFontHeightReductionStep

double getFontHeightReductionStep()
                                  throws java.io.IOException,
                                         AutomationException
This is the step interval for font height reduction.

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

setFontWidthReductionLimit

void setFontWidthReductionLimit(double limit)
                                throws java.io.IOException,
                                       AutomationException
The font may be reduced in width until this limit is reached.

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

getFontWidthReductionLimit

double getFontWidthReductionLimit()
                                  throws java.io.IOException,
                                         AutomationException
The font may be reduced in width until this limit is reached.

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

setFontWidthReductionStep

void setFontWidthReductionStep(double step)
                               throws java.io.IOException,
                                      AutomationException
This is the step interval for font width reduction.

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

getFontWidthReductionStep

double getFontWidthReductionStep()
                                 throws java.io.IOException,
                                        AutomationException
This is the step interval for font width reduction.

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

isNeverRemoveLabel

boolean isNeverRemoveLabel()
                           throws java.io.IOException,
                                  AutomationException
Indicates whether to not remove the label if no position is found.

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

setNeverRemoveLabel

void setNeverRemoveLabel(boolean flag)
                         throws java.io.IOException,
                                AutomationException
Indicates whether to not remove the label if no position is found.

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

getLabelPriority

int getLabelPriority()
                     throws java.io.IOException,
                            AutomationException
Label prority controls approximate placement order.

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

setLabelPriority

void setLabelPriority(int priority)
                      throws java.io.IOException,
                             AutomationException
Label prority controls approximate placement order.

Parameters:
priority - The priority (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
Feature weight controls which features may be overlapped and to what extent.

Returns:
The weight
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
Feature weight controls which features may be overlapped and to what extent.

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

setPolygonBoundaryWeight

void setPolygonBoundaryWeight(int weight)
                              throws java.io.IOException,
                                     AutomationException
Feature Weight for the boundary of the polygon.

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

getPolygonBoundaryWeight

int getPolygonBoundaryWeight()
                             throws java.io.IOException,
                                    AutomationException
Feature Weight for the boundary of the polygon.

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

isCanRemoveOverlappingLabel

boolean isCanRemoveOverlappingLabel()
                                    throws java.io.IOException,
                                           AutomationException
Indicates whether to remove the label if it overlaps with other labels.

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

setCanRemoveOverlappingLabel

void setCanRemoveOverlappingLabel(boolean flag)
                                  throws java.io.IOException,
                                         AutomationException
Indicates whether to remove the label if it overlaps with other labels.

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

isThinDuplicateLabels

boolean isThinDuplicateLabels()
                              throws java.io.IOException,
                                     AutomationException
Indicates whether to remove duplicate labels that lie within a specified distance of each other.

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

setThinDuplicateLabels

void setThinDuplicateLabels(boolean flag)
                            throws java.io.IOException,
                                   AutomationException
Indicates whether to remove duplicate labels that lie within a specified distance of each other.

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

getThinningDistance

double getThinningDistance()
                           throws java.io.IOException,
                                  AutomationException
Distance used to control the thinning of duplicate labels.

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

setThinningDistance

void setThinningDistance(double distance)
                         throws java.io.IOException,
                                AutomationException
Distance used to control the thinning of duplicate labels.

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

isGraticuleAlignment

boolean isGraticuleAlignment()
                             throws java.io.IOException,
                                    AutomationException
Indicates whether to enable graticule alignment.

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

setGraticuleAlignment

void setGraticuleAlignment(boolean flag)
                           throws java.io.IOException,
                                  AutomationException
Indicates whether to enable graticule alignment.

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

getOffsetAlongLineProperties

IMaplexOffsetAlongLineProperties getOffsetAlongLineProperties()
                                                              throws java.io.IOException,
                                                                     AutomationException
The offset along line properties for a layer.

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

setOffsetAlongLineProperties

void setOffsetAlongLineProperties(IMaplexOffsetAlongLineProperties props)
                                  throws java.io.IOException,
                                         AutomationException
The offset along line properties for a layer.

Parameters:
props - A reference to a com.esri.arcgis.carto.IMaplexOffsetAlongLineProperties (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRotationProperties

IMaplexRotationProperties getRotationProperties()
                                                throws java.io.IOException,
                                                       AutomationException
The label rotation properties for a layer.

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

setRotationProperties

void setRotationProperties(IMaplexRotationProperties props)
                           throws java.io.IOException,
                                  AutomationException
The label rotation properties for a layer.

Parameters:
props - A reference to a com.esri.arcgis.carto.IMaplexRotationProperties (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDictionaryName

java.lang.String getDictionaryName()
                                   throws java.io.IOException,
                                          AutomationException
Name of the abbreviations dictionary referenced by this layer.

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

setDictionaryName

void setDictionaryName(java.lang.String text)
                       throws java.io.IOException,
                              AutomationException
Name of the abbreviations dictionary referenced by this layer.

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

isAlignLabelToLineDirection

boolean isAlignLabelToLineDirection()
                                    throws java.io.IOException,
                                           AutomationException
Indicates whether to align the label with the label direction so the label may appear upside down.

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

setAlignLabelToLineDirection

void setAlignLabelToLineDirection(boolean flag)
                                  throws java.io.IOException,
                                         AutomationException
Indicates whether to align the label with the label direction so the label may appear upside down.

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

isBackgroundLabel

boolean isBackgroundLabel()
                          throws java.io.IOException,
                                 AutomationException
Indicates whether to place the label first and allow other labels to be placed over it.

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

setBackgroundLabel

void setBackgroundLabel(boolean flag)
                        throws java.io.IOException,
                               AutomationException
Indicates whether to place the label first and allow other labels to be placed over it.

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

getMinimumSizeForLabeling

double getMinimumSizeForLabeling()
                                 throws java.io.IOException,
                                        AutomationException
Specifies a minimum size of a line or area feature for it to be labeled.

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

setMinimumSizeForLabeling

void setMinimumSizeForLabeling(double size)
                               throws java.io.IOException,
                                      AutomationException
Specifies a minimum size of a line or area feature for it to be labeled.

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

getLabelBuffer

int getLabelBuffer()
                   throws java.io.IOException,
                          AutomationException
Increase buffer to stop labels from being placed too close to each other.

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

setLabelBuffer

void setLabelBuffer(int buffer)
                    throws java.io.IOException,
                           AutomationException
Increase buffer to stop labels from being placed too close to each other.

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

getFeatureBuffer

int getFeatureBuffer()
                     throws java.io.IOException,
                            AutomationException
Increase buffer around a point feature to stop labels from being placed too close to the feature.

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

setFeatureBuffer

void setFeatureBuffer(int buffer)
                      throws java.io.IOException,
                             AutomationException
Increase buffer around a point feature to stop labels from being placed too close to the feature.

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