com.esri.arcgis.carto
Class MaplexOverposterLayerProperties

java.lang.Object
  extended by com.esri.arcgis.carto.MaplexOverposterLayerProperties
All Implemented Interfaces:
IMaplexOverposterLayerProperties, IMaplexOverposterLayerProperties2, IOverposterLayerProperties, IOverposterLayerProperties2, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, Externalizable, Serializable

public class MaplexOverposterLayerProperties
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IMaplexOverposterLayerProperties, IMaplexOverposterLayerProperties2, IOverposterLayerProperties, IOverposterLayerProperties2, IPersistStream, IClone, Externalizable

Properties that specify the label placement rules per layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
MaplexOverposterLayerProperties()
          Constructs a MaplexOverposterLayerProperties using ArcGIS Engine.
MaplexOverposterLayerProperties(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MaplexOverposterLayerProperties theMaplexOverposterLayerProperties = (MaplexOverposterLayerProperties) obj;
 
Method Summary
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 boolean equals(Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 int getConstrainOffset()
          Label constraint options.
 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.
 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.
 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 getGraticuleAlignmentType()
          Indicates the options for the graticule alignment type.
 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 getLineFeatureType()
          Indicates the options for the line feature type.
 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.
 int getMaximumLabelOverrunUnit()
          The maximum label overrun is interpreted to be in this unit.
 double getMaximumWordSpacing()
          The word spacing may be increased upto this limit.
 double getMinimumEndOfStreetClearance()
          Minimum clearance between street label and street end.
 int getMinimumFeatureSizeUnit()
          The minimum feature size is interpreted to be in this unit.
 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 getPolygonAnchorPointType()
          Indicates the options for the anchor point type.
 int getPolygonBoundaryWeight()
          Feature Weight for the boundary of the polygon.
 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 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.
 int getRepetitionIntervalUnit()
          The label repetition interval is interpreted to be in this unit.
 IMaplexRotationProperties getRotationProperties()
          The label rotation properties for a layer.
 double getSecondaryOffset()
          Primary offset between label and symbol.
 double getSecondaryOffsetMaximum()
          The maximum offset associated with a secondary label position.
 double getSecondaryOffsetMinimum()
          The minimum offset associated with a secondary label position.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int getStrategyPriority(int strategy)
          Indicates the priority of a placement strategy when placing text.
 double getThinningDistance()
          Distance used to control the thinning of duplicate labels.
 int getThinningDistanceUnit()
          The thinning distance is interpreted to be in this unit.
 int hashCode()
          the hashcode for this object
 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 isBarrier()
          Indicates if features are treated as barriers to label/symbol placement.
 boolean isCanAbbreviateLabel()
          Indicates whether to abbreviate the label using an abbreviation dictionary.
 boolean isCanFlipStackedStreetLabel()
          Indicates whether a stacked label may be flipped over to obtain a better position.
 boolean isCanOverrunFeature()
          Indicates whether to place the label over end of line or over polygon boundary.
 boolean isCanPlaceLabelOnTopOfFeature()
          Indicates whether the label can be placed on top of the street feature.
 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 isCanReduceLeading()
          Indicates whether the leading can be reduced for a stacked label.
 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.
 void isDirty()
          isDirty
 boolean isEnablePointPlacementPriorities()
          Indicates whether to use user-defined point placement priorities.
 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 isEqual(IClone other)
          Returns TRUE when the receiver and other have the same properties.
 boolean isGraticuleAlignment()
          Indicates whether to enable graticule alignment.
 boolean isHasFeatureWeight()
          Indicates if the layer has a feature weight.
 boolean isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 boolean isLabelBufferHardConstraint()
          Indicates whether the label buffer is a hard constraint and must be honored.
 boolean isLandParcelPlacement()
          Indicates whether to place the label within land parcel polygon avoiding building footprint.
 boolean isMinimumSizeBasedOnArea()
          Indicates whether the minimum feature size for labeling is based on area.
 boolean isNeverRemoveLabel()
          Indicates whether to not remove the label if no position is found.
 boolean isOffsetFromFeatureGeometry()
          Indicates whether to measure the label offset from the feature geometry.
 boolean isPlaceLabels()
          Indicates if labels are placed for the layer.
 boolean isPlaceSymbols()
          Indicates if symbols are placed for the layer.
 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 isTagUnplaced()
          Indicates if overflow labels are put into a graphics container tagged placed or unplaced.
 boolean isThinDuplicateLabels()
          Indicates whether to remove duplicate labels that lie within a specified distance of each other.
 void load(IStream pstm)
          load
 void readExternal(ObjectInput in)
           
 void save(IStream pstm, int fClearDirty)
          save
 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 setCanFlipStackedStreetLabel(boolean flag)
          Indicates whether a stacked label may be flipped over to obtain a better position.
 void setCanOverrunFeature(boolean flag)
          Indicates whether to place the label over end of line or over polygon boundary.
 void setCanPlaceLabelOnTopOfFeature(boolean flag)
          Indicates whether the label can be placed on top of the street feature.
 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 setCanReduceLeading(boolean flag)
          Indicates whether the leading can be reduced for a stacked label.
 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 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 setDictionaryName(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 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 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.
 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 setGraticuleAlignmentType(int option)
          Indicates the options for the graticule alignment type.
 void setIsBarrier(boolean isBarrier)
          Indicates if features are treated as barriers to label/symbol placement.
 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 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 setLineFeatureType(int option)
          Indicates the options for the line feature type.
 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 setMaximumLabelOverrunUnit(int unit)
          The maximum label overrun is interpreted to be in this unit.
 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 setMinimumFeatureSizeUnit(int unit)
          The minimum feature size is interpreted to be in this unit.
 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 setPlaceLabels(boolean place)
          Indicates if labels are placed for the layer.
 void setPlaceSymbols(boolean place)
          Indicates if symbols are placed for the layer.
 void setPointPlacementMethod(int method)
          Point placement options.
 void setPointPlacementPriorities(IPointPlacementPriorities priorities)
          Controls placement of label around point fetaure.
 void setPolygonAnchorPointType(int option)
          Indicates the options for the anchor point type.
 void setPolygonBoundaryWeight(int weight)
          Feature Weight for the boundary of the polygon.
 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 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 setRepetitionIntervalUnit(int unit)
          The label repetition interval is interpreted to be in this unit.
 void setRotationProperties(IMaplexRotationProperties props)
          The label rotation properties for a layer.
 void setSecondaryOffset(double offset)
          Primary offset between label and symbol.
 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 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 setStrategyPriority(int strategy, int priority)
          Indicates the priority of a placement strategy when placing text.
 void setTagUnplaced(boolean value)
          Indicates if overflow labels are put into a graphics container tagged placed or unplaced.
 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.
 void setThinningDistanceUnit(int unit)
          The thinning distance is interpreted to be in this unit.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

MaplexOverposterLayerProperties

public MaplexOverposterLayerProperties()
                                throws IOException,
                                       UnknownHostException
Constructs a MaplexOverposterLayerProperties using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

MaplexOverposterLayerProperties

public MaplexOverposterLayerProperties(Object obj)
                                throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MaplexOverposterLayerProperties theMaplexOverposterLayerProperties = (MaplexOverposterLayerProperties) obj;

Construct a MaplexOverposterLayerProperties using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to MaplexOverposterLayerProperties.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getFeatureType

public int getFeatureType()
                   throws IOException,
                          AutomationException
The feature type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFeatureType in interface IMaplexOverposterLayerProperties
Returns:
A com.esri.arcgis.carto.esriBasicOverposterFeatureType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFeatureType

public void setFeatureType(int type)
                    throws IOException,
                           AutomationException
The feature type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setFeatureType in interface IMaplexOverposterLayerProperties
Parameters:
type - A com.esri.arcgis.carto.esriBasicOverposterFeatureType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPointPlacementMethod

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getPointPlacementMethod in interface IMaplexOverposterLayerProperties
Returns:
A com.esri.arcgis.carto.esriMaplexPointPlacementMethod constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPointPlacementMethod

public void setPointPlacementMethod(int method)
                             throws IOException,
                                    AutomationException
Point placement options.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

getLinePlacementMethod

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLinePlacementMethod in interface IMaplexOverposterLayerProperties
Returns:
A com.esri.arcgis.carto.esriMaplexLinePlacementMethod constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLinePlacementMethod

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setLinePlacementMethod in interface IMaplexOverposterLayerProperties
Parameters:
method - A com.esri.arcgis.carto.esriMaplexLinePlacementMethod constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPolygonPlacementMethod

public int getPolygonPlacementMethod()
                              throws IOException,
                                     AutomationException
Polygon placement options.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getPolygonPlacementMethod in interface IMaplexOverposterLayerProperties
Returns:
A com.esri.arcgis.carto.esriMaplexPolygonPlacementMethod constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPolygonPlacementMethod

public void setPolygonPlacementMethod(int method)
                               throws IOException,
                                      AutomationException
Polygon placement options.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

isCanPlaceLabelOutsidePolygon

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isCanPlaceLabelOutsidePolygon in interface IMaplexOverposterLayerProperties
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCanPlaceLabelOutsidePolygon

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCanPlaceLabelOutsidePolygon in interface IMaplexOverposterLayerProperties
Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isPreferHorizontalPlacement

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isPreferHorizontalPlacement in interface IMaplexOverposterLayerProperties
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPreferHorizontalPlacement

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setPreferHorizontalPlacement in interface IMaplexOverposterLayerProperties
Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isLandParcelPlacement

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isLandParcelPlacement in interface IMaplexOverposterLayerProperties
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLandParcelPlacement

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setLandParcelPlacement in interface IMaplexOverposterLayerProperties
Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPrimaryOffset

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getPrimaryOffset in interface IMaplexOverposterLayerProperties
Returns:
The offset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPrimaryOffset

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setPrimaryOffset in interface IMaplexOverposterLayerProperties
Parameters:
offset - The offset (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPrimaryOffsetUnit

public int getPrimaryOffsetUnit()
                         throws IOException,
                                AutomationException
The primary offset is interpreted to be in this unit.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getPrimaryOffsetUnit in interface IMaplexOverposterLayerProperties
Returns:
A com.esri.arcgis.carto.esriMaplexUnit constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPrimaryOffsetUnit

public void setPrimaryOffsetUnit(int unit)
                          throws IOException,
                                 AutomationException
The primary offset is interpreted to be in this unit.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setPrimaryOffsetUnit in interface IMaplexOverposterLayerProperties
Parameters:
unit - A com.esri.arcgis.carto.esriMaplexUnit constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSecondaryOffset

public double getSecondaryOffset()
                          throws IOException,
                                 AutomationException
Primary offset between label and symbol.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSecondaryOffset in interface IMaplexOverposterLayerProperties
Returns:
The offset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSecondaryOffset

public void setSecondaryOffset(double offset)
                        throws IOException,
                               AutomationException
Primary offset between label and symbol.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSecondaryOffset in interface IMaplexOverposterLayerProperties
Parameters:
offset - The offset (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getConstrainOffset

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getConstrainOffset in interface IMaplexOverposterLayerProperties
Returns:
A com.esri.arcgis.carto.esriMaplexConstrainOffset constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setConstrainOffset

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

isEnablePointPlacementPriorities

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isEnablePointPlacementPriorities in interface IMaplexOverposterLayerProperties
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEnablePointPlacementPriorities

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setEnablePointPlacementPriorities in interface IMaplexOverposterLayerProperties
Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPointPlacementPriorities

public IPointPlacementPriorities getPointPlacementPriorities()
                                                      throws IOException,
                                                             AutomationException
Controls placement of label around point fetaure.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getPointPlacementPriorities in interface IMaplexOverposterLayerProperties
Returns:
A reference to a com.esri.arcgis.carto.IPointPlacementPriorities
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPointPlacementPriorities

public void setPointPlacementPriorities(IPointPlacementPriorities priorities)
                                 throws IOException,
                                        AutomationException
Controls placement of label around point fetaure.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setPointPlacementPriorities in interface IMaplexOverposterLayerProperties
Parameters:
priorities - A reference to a com.esri.arcgis.carto.IPointPlacementPriorities (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanShiftPointLabel

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isCanShiftPointLabel in interface IMaplexOverposterLayerProperties
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCanShiftPointLabel

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCanShiftPointLabel in interface IMaplexOverposterLayerProperties
Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isStreetPlacement

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isStreetPlacement in interface IMaplexOverposterLayerProperties
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsStreetPlacement

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setIsStreetPlacement in interface IMaplexOverposterLayerProperties
Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRepeatLabel

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isRepeatLabel in interface IMaplexOverposterLayerProperties
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRepeatLabel

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setRepeatLabel in interface IMaplexOverposterLayerProperties
Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinimumRepetitionInterval

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMinimumRepetitionInterval in interface IMaplexOverposterLayerProperties
Returns:
The interval
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMinimumRepetitionInterval

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMinimumRepetitionInterval in interface IMaplexOverposterLayerProperties
Parameters:
interval - The interval (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSpreadCharacters

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isSpreadCharacters in interface IMaplexOverposterLayerProperties
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSpreadCharacters

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSpreadCharacters in interface IMaplexOverposterLayerProperties
Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaximumCharacterSpacing

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMaximumCharacterSpacing in interface IMaplexOverposterLayerProperties
Returns:
The spacing
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaximumCharacterSpacing

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMaximumCharacterSpacing in interface IMaplexOverposterLayerProperties
Parameters:
spacing - The spacing (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSpreadWords

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isSpreadWords in interface IMaplexOverposterLayerProperties
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSpreadWords

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSpreadWords in interface IMaplexOverposterLayerProperties
Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaximumWordSpacing

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMaximumWordSpacing in interface IMaplexOverposterLayerProperties
Returns:
The spacing
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaximumWordSpacing

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMaximumWordSpacing in interface IMaplexOverposterLayerProperties
Parameters:
spacing - The spacing (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPreferredEndOfStreetClearance

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getPreferredEndOfStreetClearance in interface IMaplexOverposterLayerProperties
Returns:
The clearance
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPreferredEndOfStreetClearance

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setPreferredEndOfStreetClearance in interface IMaplexOverposterLayerProperties
Parameters:
clearance - The clearance (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinimumEndOfStreetClearance

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMinimumEndOfStreetClearance in interface IMaplexOverposterLayerProperties
Returns:
The clearance
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMinimumEndOfStreetClearance

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMinimumEndOfStreetClearance in interface IMaplexOverposterLayerProperties
Parameters:
clearance - The clearance (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanStackLabel

public boolean isCanStackLabel()
                        throws IOException,
                               AutomationException
Indicates whether to stack the label to obtain a better position.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isCanStackLabel in interface IMaplexOverposterLayerProperties
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCanStackLabel

public void setCanStackLabel(boolean flag)
                      throws IOException,
                             AutomationException
Indicates whether to stack the label to obtain a better position.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCanStackLabel in interface IMaplexOverposterLayerProperties
Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabelStackingProperties

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLabelStackingProperties in interface IMaplexOverposterLayerProperties
Returns:
A reference to a com.esri.arcgis.carto.IMaplexLabelStackingProperties
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabelStackingProperties

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

isCanOverrunFeature

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isCanOverrunFeature in interface IMaplexOverposterLayerProperties
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCanOverrunFeature

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCanOverrunFeature in interface IMaplexOverposterLayerProperties
Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaximumLabelOverrun

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMaximumLabelOverrun in interface IMaplexOverposterLayerProperties
Returns:
The distance
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaximumLabelOverrun

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMaximumLabelOverrun in interface IMaplexOverposterLayerProperties
Parameters:
distance - The distance (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAllowAsymmetricOverrun

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isAllowAsymmetricOverrun in interface IMaplexOverposterLayerProperties
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAllowAsymmetricOverrun

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setAllowAsymmetricOverrun in interface IMaplexOverposterLayerProperties
Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanAbbreviateLabel

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isCanAbbreviateLabel in interface IMaplexOverposterLayerProperties
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCanAbbreviateLabel

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCanAbbreviateLabel in interface IMaplexOverposterLayerProperties
Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanTruncateLabel

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isCanTruncateLabel in interface IMaplexOverposterLayerProperties
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCanTruncateLabel

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCanTruncateLabel in interface IMaplexOverposterLayerProperties
Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanReduceFontSize

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isCanReduceFontSize in interface IMaplexOverposterLayerProperties
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCanReduceFontSize

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCanReduceFontSize in interface IMaplexOverposterLayerProperties
Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFontHeightReductionLimit

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setFontHeightReductionLimit in interface IMaplexOverposterLayerProperties
Parameters:
limit - The limit (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFontHeightReductionLimit

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFontHeightReductionLimit in interface IMaplexOverposterLayerProperties
Returns:
The limit
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFontHeightReductionStep

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setFontHeightReductionStep in interface IMaplexOverposterLayerProperties
Parameters:
step - The step (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFontHeightReductionStep

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFontHeightReductionStep in interface IMaplexOverposterLayerProperties
Returns:
The step
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFontWidthReductionLimit

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setFontWidthReductionLimit in interface IMaplexOverposterLayerProperties
Parameters:
limit - The limit (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFontWidthReductionLimit

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFontWidthReductionLimit in interface IMaplexOverposterLayerProperties
Returns:
The limit
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFontWidthReductionStep

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setFontWidthReductionStep in interface IMaplexOverposterLayerProperties
Parameters:
step - The step (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFontWidthReductionStep

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFontWidthReductionStep in interface IMaplexOverposterLayerProperties
Returns:
The step
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isNeverRemoveLabel

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isNeverRemoveLabel in interface IMaplexOverposterLayerProperties
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNeverRemoveLabel

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setNeverRemoveLabel in interface IMaplexOverposterLayerProperties
Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabelPriority

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLabelPriority in interface IMaplexOverposterLayerProperties
Returns:
The priority
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabelPriority

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setLabelPriority in interface IMaplexOverposterLayerProperties
Parameters:
priority - The priority (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFeatureWeight

public int getFeatureWeight()
                     throws IOException,
                            AutomationException
Feature weight controls which features may be overlapped and to what extent.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFeatureWeight in interface IMaplexOverposterLayerProperties
Returns:
The weight
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFeatureWeight

public void setFeatureWeight(int weight)
                      throws IOException,
                             AutomationException
Feature weight controls which features may be overlapped and to what extent.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setFeatureWeight in interface IMaplexOverposterLayerProperties
Parameters:
weight - The weight (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPolygonBoundaryWeight

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setPolygonBoundaryWeight in interface IMaplexOverposterLayerProperties
Parameters:
weight - The weight (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPolygonBoundaryWeight

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getPolygonBoundaryWeight in interface IMaplexOverposterLayerProperties
Returns:
The weight
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanRemoveOverlappingLabel

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isCanRemoveOverlappingLabel in interface IMaplexOverposterLayerProperties
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCanRemoveOverlappingLabel

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCanRemoveOverlappingLabel in interface IMaplexOverposterLayerProperties
Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isThinDuplicateLabels

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isThinDuplicateLabels in interface IMaplexOverposterLayerProperties
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setThinDuplicateLabels

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setThinDuplicateLabels in interface IMaplexOverposterLayerProperties
Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getThinningDistance

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getThinningDistance in interface IMaplexOverposterLayerProperties
Returns:
The distance
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setThinningDistance

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setThinningDistance in interface IMaplexOverposterLayerProperties
Parameters:
distance - The distance (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isGraticuleAlignment

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isGraticuleAlignment in interface IMaplexOverposterLayerProperties
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGraticuleAlignment

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setGraticuleAlignment in interface IMaplexOverposterLayerProperties
Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOffsetAlongLineProperties

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getOffsetAlongLineProperties in interface IMaplexOverposterLayerProperties
Returns:
A reference to a com.esri.arcgis.carto.IMaplexOffsetAlongLineProperties
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOffsetAlongLineProperties

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

getRotationProperties

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getRotationProperties in interface IMaplexOverposterLayerProperties
Returns:
A reference to a com.esri.arcgis.carto.IMaplexRotationProperties
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRotationProperties

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

getDictionaryName

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDictionaryName in interface IMaplexOverposterLayerProperties
Returns:
The text
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDictionaryName

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDictionaryName in interface IMaplexOverposterLayerProperties
Parameters:
text - The text (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAlignLabelToLineDirection

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isAlignLabelToLineDirection in interface IMaplexOverposterLayerProperties
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAlignLabelToLineDirection

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setAlignLabelToLineDirection in interface IMaplexOverposterLayerProperties
Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isBackgroundLabel

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isBackgroundLabel in interface IMaplexOverposterLayerProperties
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBackgroundLabel

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setBackgroundLabel in interface IMaplexOverposterLayerProperties
Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinimumSizeForLabeling

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMinimumSizeForLabeling in interface IMaplexOverposterLayerProperties
Returns:
The size
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMinimumSizeForLabeling

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMinimumSizeForLabeling in interface IMaplexOverposterLayerProperties
Parameters:
size - The size (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabelBuffer

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getLabelBuffer in interface IMaplexOverposterLayerProperties
Returns:
The buffer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabelBuffer

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setLabelBuffer in interface IMaplexOverposterLayerProperties
Parameters:
buffer - The buffer (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFeatureBuffer

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getFeatureBuffer in interface IMaplexOverposterLayerProperties
Returns:
The buffer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFeatureBuffer

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setFeatureBuffer in interface IMaplexOverposterLayerProperties
Parameters:
buffer - The buffer (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPolygonInternalZones

public int getPolygonInternalZones(int zone)
                            throws IOException,
                                   AutomationException
Indicates the placement priority associated with a zone internal to the polygon.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getPolygonInternalZones in interface IMaplexOverposterLayerProperties2
Parameters:
zone - A com.esri.arcgis.carto.esriMaplexZoneIdentifier constant (in)
Returns:
The priority
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPolygonInternalZones

public void setPolygonInternalZones(int zone,
                                    int priority)
                             throws IOException,
                                    AutomationException
Indicates the placement priority associated with a zone internal to the polygon.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setPolygonInternalZones in interface IMaplexOverposterLayerProperties2
Parameters:
zone - A com.esri.arcgis.carto.esriMaplexZoneIdentifier constant (in)
priority - The priority (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPolygonExternalZones

public int getPolygonExternalZones(int zone)
                            throws IOException,
                                   AutomationException
Indicates the placement priority associated with a zone external to the polygon.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getPolygonExternalZones in interface IMaplexOverposterLayerProperties2
Parameters:
zone - A com.esri.arcgis.carto.esriMaplexZoneIdentifier constant (in)
Returns:
The priority
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPolygonExternalZones

public void setPolygonExternalZones(int zone,
                                    int priority)
                             throws IOException,
                                    AutomationException
Indicates the placement priority associated with a zone external to the polygon.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setPolygonExternalZones in interface IMaplexOverposterLayerProperties2
Parameters:
zone - A com.esri.arcgis.carto.esriMaplexZoneIdentifier constant (in)
priority - The priority (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStrategyPriority

public int getStrategyPriority(int strategy)
                        throws IOException,
                               AutomationException
Indicates the priority of a placement strategy when placing text.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getStrategyPriority in interface IMaplexOverposterLayerProperties2
Parameters:
strategy - A com.esri.arcgis.carto.esriMaplexStrategyIdentifier constant (in)
Returns:
The priority
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStrategyPriority

public void setStrategyPriority(int strategy,
                                int priority)
                         throws IOException,
                                AutomationException
Indicates the priority of a placement strategy when placing text.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setStrategyPriority in interface IMaplexOverposterLayerProperties2
Parameters:
strategy - A com.esri.arcgis.carto.esriMaplexStrategyIdentifier constant (in)
priority - The priority (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGraticuleAlignmentType

public int getGraticuleAlignmentType()
                              throws IOException,
                                     AutomationException
Indicates the options for the graticule alignment type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getGraticuleAlignmentType in interface IMaplexOverposterLayerProperties2
Returns:
A com.esri.arcgis.carto.esriMaplexGraticuleAlignmentType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGraticuleAlignmentType

public void setGraticuleAlignmentType(int option)
                               throws IOException,
                                      AutomationException
Indicates the options for the graticule alignment type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setGraticuleAlignmentType in interface IMaplexOverposterLayerProperties2
Parameters:
option - A com.esri.arcgis.carto.esriMaplexGraticuleAlignmentType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLineFeatureType

public int getLineFeatureType()
                       throws IOException,
                              AutomationException
Indicates the options for the line feature type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getLineFeatureType in interface IMaplexOverposterLayerProperties2
Returns:
A com.esri.arcgis.carto.esriMaplexLineFeatureType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLineFeatureType

public void setLineFeatureType(int option)
                        throws IOException,
                               AutomationException
Indicates the options for the line feature type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setLineFeatureType in interface IMaplexOverposterLayerProperties2
Parameters:
option - A com.esri.arcgis.carto.esriMaplexLineFeatureType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPolygonFeatureType

public int getPolygonFeatureType()
                          throws IOException,
                                 AutomationException
Indicates the options for the polygon feature type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getPolygonFeatureType in interface IMaplexOverposterLayerProperties2
Returns:
A com.esri.arcgis.carto.esriMaplexPolygonFeatureType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPolygonFeatureType

public void setPolygonFeatureType(int option)
                           throws IOException,
                                  AutomationException
Indicates the options for the polygon feature type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setPolygonFeatureType in interface IMaplexOverposterLayerProperties2
Parameters:
option - A com.esri.arcgis.carto.esriMaplexPolygonFeatureType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPolygonAnchorPointType

public int getPolygonAnchorPointType()
                              throws IOException,
                                     AutomationException
Indicates the options for the anchor point type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getPolygonAnchorPointType in interface IMaplexOverposterLayerProperties2
Returns:
A com.esri.arcgis.carto.esriMaplexAnchorPointType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPolygonAnchorPointType

public void setPolygonAnchorPointType(int option)
                               throws IOException,
                                      AutomationException
Indicates the options for the anchor point type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setPolygonAnchorPointType in interface IMaplexOverposterLayerProperties2
Parameters:
option - A com.esri.arcgis.carto.esriMaplexAnchorPointType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getContourAlignmentType

public int getContourAlignmentType()
                            throws IOException,
                                   AutomationException
Indicates the options for the contour label alignment.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getContourAlignmentType in interface IMaplexOverposterLayerProperties2
Returns:
A com.esri.arcgis.carto.esriMaplexContourAlignmentType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setContourAlignmentType

public void setContourAlignmentType(int option)
                             throws IOException,
                                    AutomationException
Indicates the options for the contour label alignment.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setContourAlignmentType in interface IMaplexOverposterLayerProperties2
Parameters:
option - A com.esri.arcgis.carto.esriMaplexContourAlignmentType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getContourMaximumAngle

public int getContourMaximumAngle()
                           throws IOException,
                                  AutomationException
The maximum angle at which a contour label may be placed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getContourMaximumAngle in interface IMaplexOverposterLayerProperties2
Returns:
The angle
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setContourMaximumAngle

public void setContourMaximumAngle(int angle)
                            throws IOException,
                                   AutomationException
The maximum angle at which a contour label may be placed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setContourMaximumAngle in interface IMaplexOverposterLayerProperties2
Parameters:
angle - The angle (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getContourLadderType

public int getContourLadderType()
                         throws IOException,
                                AutomationException
Indicates the options for the contour labed ladder types.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getContourLadderType in interface IMaplexOverposterLayerProperties2
Returns:
A com.esri.arcgis.carto.esriMaplexContourLadderType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setContourLadderType

public void setContourLadderType(int option)
                          throws IOException,
                                 AutomationException
Indicates the options for the contour labed ladder types.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setContourLadderType in interface IMaplexOverposterLayerProperties2
Parameters:
option - A com.esri.arcgis.carto.esriMaplexContourLadderType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsOffsetFromFeatureGeometry

public void setIsOffsetFromFeatureGeometry(boolean flag)
                                    throws IOException,
                                           AutomationException
Indicates whether to measure the label offset from the feature geometry.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setIsOffsetFromFeatureGeometry in interface IMaplexOverposterLayerProperties2
Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isOffsetFromFeatureGeometry

public boolean isOffsetFromFeatureGeometry()
                                    throws IOException,
                                           AutomationException
Indicates whether to measure the label offset from the feature geometry.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
isOffsetFromFeatureGeometry in interface IMaplexOverposterLayerProperties2
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEnableSecondaryOffset

public boolean isEnableSecondaryOffset()
                                throws IOException,
                                       AutomationException
Indicates whether to place a label at a secondary offset from the line feature.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
isEnableSecondaryOffset in interface IMaplexOverposterLayerProperties2
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEnableSecondaryOffset

public void setEnableSecondaryOffset(boolean flag)
                              throws IOException,
                                     AutomationException
Indicates whether to place a label at a secondary offset from the line feature.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setEnableSecondaryOffset in interface IMaplexOverposterLayerProperties2
Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSecondaryOffsetMinimum

public double getSecondaryOffsetMinimum()
                                 throws IOException,
                                        AutomationException
The minimum offset associated with a secondary label position.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getSecondaryOffsetMinimum in interface IMaplexOverposterLayerProperties2
Returns:
The offset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSecondaryOffsetMinimum

public void setSecondaryOffsetMinimum(double offset)
                               throws IOException,
                                      AutomationException
The minimum offset associated with a secondary label position.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setSecondaryOffsetMinimum in interface IMaplexOverposterLayerProperties2
Parameters:
offset - The offset (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSecondaryOffsetMaximum

public double getSecondaryOffsetMaximum()
                                 throws IOException,
                                        AutomationException
The maximum offset associated with a secondary label position.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getSecondaryOffsetMaximum in interface IMaplexOverposterLayerProperties2
Returns:
The offset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSecondaryOffsetMaximum

public void setSecondaryOffsetMaximum(double offset)
                               throws IOException,
                                      AutomationException
The maximum offset associated with a secondary label position.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setSecondaryOffsetMaximum in interface IMaplexOverposterLayerProperties2
Parameters:
offset - The offset (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isLabelBufferHardConstraint

public boolean isLabelBufferHardConstraint()
                                    throws IOException,
                                           AutomationException
Indicates whether the label buffer is a hard constraint and must be honored.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
isLabelBufferHardConstraint in interface IMaplexOverposterLayerProperties2
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsLabelBufferHardConstraint

public void setIsLabelBufferHardConstraint(boolean flag)
                                    throws IOException,
                                           AutomationException
Indicates whether the label buffer is a hard constraint and must be honored.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setIsLabelBufferHardConstraint in interface IMaplexOverposterLayerProperties2
Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isMinimumSizeBasedOnArea

public boolean isMinimumSizeBasedOnArea()
                                 throws IOException,
                                        AutomationException
Indicates whether the minimum feature size for labeling is based on area.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
isMinimumSizeBasedOnArea in interface IMaplexOverposterLayerProperties2
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsMinimumSizeBasedOnArea

public void setIsMinimumSizeBasedOnArea(boolean flag)
                                 throws IOException,
                                        AutomationException
Indicates whether the minimum feature size for labeling is based on area.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setIsMinimumSizeBasedOnArea in interface IMaplexOverposterLayerProperties2
Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanPlaceLabelOnTopOfFeature

public boolean isCanPlaceLabelOnTopOfFeature()
                                      throws IOException,
                                             AutomationException
Indicates whether the label can be placed on top of the street feature.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
isCanPlaceLabelOnTopOfFeature in interface IMaplexOverposterLayerProperties2
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCanPlaceLabelOnTopOfFeature

public void setCanPlaceLabelOnTopOfFeature(boolean flag)
                                    throws IOException,
                                           AutomationException
Indicates whether the label can be placed on top of the street feature.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setCanPlaceLabelOnTopOfFeature in interface IMaplexOverposterLayerProperties2
Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanReduceLeading

public boolean isCanReduceLeading()
                           throws IOException,
                                  AutomationException
Indicates whether the leading can be reduced for a stacked label.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
isCanReduceLeading in interface IMaplexOverposterLayerProperties2
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCanReduceLeading

public void setCanReduceLeading(boolean flag)
                         throws IOException,
                                AutomationException
Indicates whether the leading can be reduced for a stacked label.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setCanReduceLeading in interface IMaplexOverposterLayerProperties2
Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanFlipStackedStreetLabel

public boolean isCanFlipStackedStreetLabel()
                                    throws IOException,
                                           AutomationException
Indicates whether a stacked label may be flipped over to obtain a better position.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
isCanFlipStackedStreetLabel in interface IMaplexOverposterLayerProperties2
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCanFlipStackedStreetLabel

public void setCanFlipStackedStreetLabel(boolean flag)
                                  throws IOException,
                                         AutomationException
Indicates whether a stacked label may be flipped over to obtain a better position.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setCanFlipStackedStreetLabel in interface IMaplexOverposterLayerProperties2
Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEnablePolygonFixedPosition

public boolean isEnablePolygonFixedPosition()
                                     throws IOException,
                                            AutomationException
Indicates whether a label is to be placed at a fixed position in the polygon.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
isEnablePolygonFixedPosition in interface IMaplexOverposterLayerProperties2
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEnablePolygonFixedPosition

public void setEnablePolygonFixedPosition(boolean flag)
                                   throws IOException,
                                          AutomationException
Indicates whether a label is to be placed at a fixed position in the polygon.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setEnablePolygonFixedPosition in interface IMaplexOverposterLayerProperties2
Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getThinningDistanceUnit

public int getThinningDistanceUnit()
                            throws IOException,
                                   AutomationException
The thinning distance is interpreted to be in this unit.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getThinningDistanceUnit in interface IMaplexOverposterLayerProperties2
Returns:
A com.esri.arcgis.carto.esriMaplexUnit constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setThinningDistanceUnit

public void setThinningDistanceUnit(int unit)
                             throws IOException,
                                    AutomationException
The thinning distance is interpreted to be in this unit.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setThinningDistanceUnit in interface IMaplexOverposterLayerProperties2
Parameters:
unit - A com.esri.arcgis.carto.esriMaplexUnit constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRepetitionIntervalUnit

public int getRepetitionIntervalUnit()
                              throws IOException,
                                     AutomationException
The label repetition interval is interpreted to be in this unit.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getRepetitionIntervalUnit in interface IMaplexOverposterLayerProperties2
Returns:
A com.esri.arcgis.carto.esriMaplexUnit constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRepetitionIntervalUnit

public void setRepetitionIntervalUnit(int unit)
                               throws IOException,
                                      AutomationException
The label repetition interval is interpreted to be in this unit.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setRepetitionIntervalUnit in interface IMaplexOverposterLayerProperties2
Parameters:
unit - A com.esri.arcgis.carto.esriMaplexUnit constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinimumFeatureSizeUnit

public int getMinimumFeatureSizeUnit()
                              throws IOException,
                                     AutomationException
The minimum feature size is interpreted to be in this unit.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getMinimumFeatureSizeUnit in interface IMaplexOverposterLayerProperties2
Returns:
A com.esri.arcgis.carto.esriMaplexUnit constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMinimumFeatureSizeUnit

public void setMinimumFeatureSizeUnit(int unit)
                               throws IOException,
                                      AutomationException
The minimum feature size is interpreted to be in this unit.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setMinimumFeatureSizeUnit in interface IMaplexOverposterLayerProperties2
Parameters:
unit - A com.esri.arcgis.carto.esriMaplexUnit constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaximumLabelOverrunUnit

public int getMaximumLabelOverrunUnit()
                               throws IOException,
                                      AutomationException
The maximum label overrun is interpreted to be in this unit.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getMaximumLabelOverrunUnit in interface IMaplexOverposterLayerProperties2
Returns:
A com.esri.arcgis.carto.esriMaplexUnit constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaximumLabelOverrunUnit

public void setMaximumLabelOverrunUnit(int unit)
                                throws IOException,
                                       AutomationException
The maximum label overrun is interpreted to be in this unit.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setMaximumLabelOverrunUnit in interface IMaplexOverposterLayerProperties2
Parameters:
unit - A com.esri.arcgis.carto.esriMaplexUnit constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPlaceLabels

public void setPlaceLabels(boolean place)
                    throws IOException,
                           AutomationException
Indicates if labels are placed for the layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setPlaceLabels in interface IOverposterLayerProperties
Specified by:
setPlaceLabels in interface IOverposterLayerProperties2
Parameters:
place - The place (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isPlaceLabels

public boolean isPlaceLabels()
                      throws IOException,
                             AutomationException
Indicates if labels are placed for the layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isPlaceLabels in interface IOverposterLayerProperties
Specified by:
isPlaceLabels in interface IOverposterLayerProperties2
Returns:
The place
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPlaceSymbols

public void setPlaceSymbols(boolean place)
                     throws IOException,
                            AutomationException
Indicates if symbols are placed for the layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setPlaceSymbols in interface IOverposterLayerProperties
Specified by:
setPlaceSymbols in interface IOverposterLayerProperties2
Parameters:
place - The place (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isPlaceSymbols

public boolean isPlaceSymbols()
                       throws IOException,
                              AutomationException
Indicates if symbols are placed for the layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isPlaceSymbols in interface IOverposterLayerProperties
Specified by:
isPlaceSymbols in interface IOverposterLayerProperties2
Returns:
The place
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsBarrier

public void setIsBarrier(boolean isBarrier)
                  throws IOException,
                         AutomationException
Indicates if features are treated as barriers to label/symbol placement.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setIsBarrier in interface IOverposterLayerProperties
Specified by:
setIsBarrier in interface IOverposterLayerProperties2
Parameters:
isBarrier - The isBarrier (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isBarrier

public boolean isBarrier()
                  throws IOException,
                         AutomationException
Indicates if features are treated as barriers to label/symbol placement.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isBarrier in interface IOverposterLayerProperties
Specified by:
isBarrier in interface IOverposterLayerProperties2
Returns:
The isBarrier
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isTagUnplaced

public boolean isTagUnplaced()
                      throws IOException,
                             AutomationException
Indicates if overflow labels are put into a graphics container tagged placed or unplaced.

Remarks

This property specifies whether or not unplaced labels are drawn for this label class. Setting TagUnplaced to True specifies that unplaced labels will not be drawn. Setting it to False specifies that they will be drawn.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isTagUnplaced in interface IOverposterLayerProperties2
Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTagUnplaced

public void setTagUnplaced(boolean value)
                    throws IOException,
                           AutomationException
Indicates if overflow labels are put into a graphics container tagged placed or unplaced.

Remarks

This property specifies whether or not unplaced labels are drawn for this label class. Setting TagUnplaced to True specifies that unplaced labels will not be drawn. Setting it to False specifies that they will be drawn.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setTagUnplaced in interface IOverposterLayerProperties2
Parameters:
value - The value (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isHasFeatureWeight

public boolean isHasFeatureWeight()
                           throws IOException,
                                  AutomationException
Indicates if the layer has a feature weight.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
isHasFeatureWeight in interface IOverposterLayerProperties2
Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException
isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDirty in interface IPersistStream
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException
load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException
save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException
getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException
getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException
Clones the receiver and assigns the result to *clone.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
esri_clone in interface IClone
Returns:
A reference to a com.esri.arcgis.system.IClone
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException
Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
assign in interface IClone
Parameters:
src - A reference to a com.esri.arcgis.system.IClone (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException
Returns TRUE when the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isEqual in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The equal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException
Returns TRUE when the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isIdentical in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The identical
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Throws:
IOException
ClassNotFoundException