com.esri.arcgis.carto
Interface IOverposterOptions

All Superinterfaces:

Serializable

All Known Implementing Classes:

BasicOverposterProperties, MaplexOverposterProperties

public interface IOverposterOptions
extends Serializable

Provides access to overposter options.

Product Availability

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

Method Summary

double	getInvertedLabelTolerance() The angle at which the label orientation is switched.
IColor	getUnplacedLabelColor() The color with which unplaced labels are drawn.
boolean	isEnableDrawUnplaced() Indicates whether the unplaced labels are drawn.
boolean	isEnableLabelCache() Indicates whether labels are returned from cache or placement run.
boolean	isRotateLabelWithDataFrame() Indicates if labels are rotated if the data frame is rotated.
void	setEnableDrawUnplaced(boolean flag) Indicates whether the unplaced labels are drawn.
void	setEnableLabelCache(boolean flag) Indicates whether labels are returned from cache or placement run.
void	setInvertedLabelTolerance(double angle) The angle at which the label orientation is switched.
void	setRotateLabelWithDataFrame(boolean flag) Indicates if labels are rotated if the data frame is rotated.
void	setUnplacedLabelColorByRef(IColor color) The color with which unplaced labels are drawn.
void	stackLabel(ILabelEngineLayerProperties layerprops, boolean forceStack, String labelIn, boolean[] stacked, String[] labelOut) Provides the option to stack a label based on the current overposter properties.
void	translateLabel(ILabelEngineLayerProperties layerprops, String labelIn, boolean[] translated, String[] labelOut) Provides the option to translate a label based on the current overposter properties.

Method Detail

translateLabel

void translateLabel(ILabelEngineLayerProperties layerprops,
                    String labelIn,
                    boolean[] translated,
                    String[] labelOut)
                    throws IOException,
                           AutomationException

Provides the option to translate a label based on the current overposter properties.

Product Availability

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

Parameters:

layerprops - A reference to a com.esri.arcgis.carto.ILabelEngineLayerProperties (in)

labelIn - The labelIn (in)

translated - The translated (out: use single element array)

labelOut - The labelOut (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stackLabel

void stackLabel(ILabelEngineLayerProperties layerprops,
                boolean forceStack,
                String labelIn,
                boolean[] stacked,
                String[] labelOut)
                throws IOException,
                       AutomationException

Provides the option to stack a label based on the current overposter properties.

Product Availability

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

Parameters:

layerprops - A reference to a com.esri.arcgis.carto.ILabelEngineLayerProperties (in)

forceStack - The forceStack (in)

labelIn - The labelIn (in)

stacked - The stacked (out: use single element array)

labelOut - The labelOut (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnableLabelCache

boolean isEnableLabelCache()
                           throws IOException,
                                  AutomationException

Indicates whether labels are returned from cache or placement run.

Product Availability

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

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnableLabelCache

void setEnableLabelCache(boolean flag)
                         throws IOException,
                                AutomationException

Indicates whether labels are returned from cache or placement run.

Product Availability

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

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnableDrawUnplaced

boolean isEnableDrawUnplaced()
                             throws IOException,
                                    AutomationException

Indicates whether the unplaced labels are drawn.

Product Availability

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

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnableDrawUnplaced

void setEnableDrawUnplaced(boolean flag)
                           throws IOException,
                                  AutomationException

Indicates whether the unplaced labels are drawn.

Product Availability

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

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUnplacedLabelColorByRef

void setUnplacedLabelColorByRef(IColor color)
                                throws IOException,
                                       AutomationException

The color with which unplaced labels are drawn.

Product Availability

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

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUnplacedLabelColor

IColor getUnplacedLabelColor()
                             throws IOException,
                                    AutomationException

The color with which unplaced labels are drawn.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInvertedLabelTolerance

void setInvertedLabelTolerance(double angle)
                               throws IOException,
                                      AutomationException

The angle at which the label orientation is switched.

Product Availability

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

Parameters:

angle - The angle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInvertedLabelTolerance

double getInvertedLabelTolerance()
                                 throws IOException,
                                        AutomationException

The angle at which the label orientation is switched.

Product Availability

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

Returns:

The angle

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRotateLabelWithDataFrame

void setRotateLabelWithDataFrame(boolean flag)
                                 throws IOException,
                                        AutomationException

Indicates if labels are rotated if the data frame is rotated.

Product Availability

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

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRotateLabelWithDataFrame

boolean isRotateLabelWithDataFrame()
                                   throws IOException,
                                          AutomationException

Indicates if labels are rotated if the data frame is rotated.

Product Availability

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

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.