Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.carto
Interface IOverposterOptions

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
BasicOverposterProperties, IOverposterOptionsProxy, MaplexOverposterProperties
public interface IOverposterOptions
extends java.io.Serializable

COM Interface 'IOverposterOptions'. Generated 3/19/2015 1:20:52 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to overposter options.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IID8112f1a9_0ecd_4e5e_977c_80b358a574b9
           
static int xxDummy
          Deprecated. Internal use only
 
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, java.lang.String labelIn, boolean[] stacked, java.lang.String[] labelOut)
          Provides the option to stack a label based on the current overposter properties.
 void translateLabel(ILabelEngineLayerProperties layerProps, java.lang.String labelIn, boolean[] translated, java.lang.String[] labelOut)
          Provides the option to translate a label based on the current overposter properties.
 

Field Detail

IID8112f1a9_0ecd_4e5e_977c_80b358a574b9

static final int IID8112f1a9_0ecd_4e5e_977c_80b358a574b9
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

translateLabel

void translateLabel(ILabelEngineLayerProperties layerProps,
                    java.lang.String labelIn,
                    boolean[] translated,
                    java.lang.String[] labelOut)
                    throws java.io.IOException,
                           AutomationException
Provides the option to translate a label based on the current overposter properties.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

stackLabel

void stackLabel(ILabelEngineLayerProperties layerProps,
                boolean forceStack,
                java.lang.String labelIn,
                boolean[] stacked,
                java.lang.String[] labelOut)
                throws java.io.IOException,
                       AutomationException
Provides the option to stack a label based on the current overposter properties.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEnableLabelCache

boolean isEnableLabelCache()
                           throws java.io.IOException,
                                  AutomationException
Indicates whether labels are returned from cache or placement run.

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

setEnableLabelCache

void setEnableLabelCache(boolean flag)
                         throws java.io.IOException,
                                AutomationException
Indicates whether labels are returned from cache or placement run.

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

isEnableDrawUnplaced

boolean isEnableDrawUnplaced()
                             throws java.io.IOException,
                                    AutomationException
Indicates whether the unplaced labels are drawn.

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

setEnableDrawUnplaced

void setEnableDrawUnplaced(boolean flag)
                           throws java.io.IOException,
                                  AutomationException
Indicates whether the unplaced labels are drawn.

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

setUnplacedLabelColorByRef

void setUnplacedLabelColorByRef(IColor color)
                                throws java.io.IOException,
                                       AutomationException
The color with which unplaced labels are drawn.

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

getUnplacedLabelColor

IColor getUnplacedLabelColor()
                             throws java.io.IOException,
                                    AutomationException
The color with which unplaced labels are drawn.

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

setInvertedLabelTolerance

void setInvertedLabelTolerance(double angle)
                               throws java.io.IOException,
                                      AutomationException
The angle at which the label orientation is switched.

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

getInvertedLabelTolerance

double getInvertedLabelTolerance()
                                 throws java.io.IOException,
                                        AutomationException
The angle at which the label orientation is switched.

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

setRotateLabelWithDataFrame

void setRotateLabelWithDataFrame(boolean flag)
                                 throws java.io.IOException,
                                        AutomationException
Indicates if labels are rotated if the data frame is rotated.

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

isRotateLabelWithDataFrame

boolean isRotateLabelWithDataFrame()
                                   throws java.io.IOException,
                                          AutomationException
Indicates if labels are rotated if the data frame is rotated.

Returns:
The flag
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD