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 IOverposter2

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
BasicOverposter, IOverposter2Proxy
public interface IOverposter2
extends java.io.Serializable

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

Description: 'Provides access to members that place labels for features using conflict detection.' 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 IIDffec8117_ec4f_4329_bb7d_420453d29edd
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void addBarriers(int weight, IGeometryCollection barriers)
          Adds a barrier object that placed objects must avoid.
 int addClass(IOverposterLayerProperties props)
          Adds a class to the overposter and specifies its properties.
 void addCurvedLabel(int classIndex, java.lang.String label, java.lang.Object widths, java.lang.Object ascents, java.lang.Object descents, double fontHeight, double fontDescent, IGeometry controlShape, int featureId, ISymbol symbol)
          Adds a curved label object to be placed.
 void addLabel(int classIndex, java.lang.String label, double width, double height, IGeometry controlShape, int featureId, ISymbol symbol)
          Adds a label object to be placed.
 void addLabel2(int classIndex, java.lang.String label, double width, double height, IGeometry controlShape, int featureId, ISymbol symbol, double angle)
          Adds a label object to be placed.
 void addSymbol(int classIndex, ISymbol symbol, IGeometry geometry, int featureId)
          Adds a symbol to be placed.
 int getCapabilities(ILayer layer)
          Overposter capabilities for the specified layer.
 int getNumberOfPlacedLabels()
          The number of unplaced labels.
 int getNumberOfUnplacedLabels()
          The number of unplaced labels.
 int getNumClasses()
          The number of classes.
 void initialize(IEnvelope extent, IDisplay display)
          Initializes the overposter for drawing into the specified area of the map display.
 void insertClass(int index, IOverposterLayerProperties props)
          Inserts a class at a specific index, and specifies its peoperties.
 void nextPlaced(IPlacedObject[] object, ITrackCancel trackCancel, IStepProgressor stepProgressor)
          The next object that was successfully placed.
 void nextUnplaced(IPlacedObject[] object)
          The next object that was not successfully placed.
 void nextUnused(IPlacedObject[] object)
          The next object that was not used.
 void placeObjects()
          Places objects using the overposter.
 void releaseResources()
          Releases current objects from memory.
 void removeClass(int classIndex)
          Removes the class at the specified index from the overposter.
 void resetClasses()
          Removes all classes from the overposter.
 

Field Detail

IIDffec8117_ec4f_4329_bb7d_420453d29edd

static final int IIDffec8117_ec4f_4329_bb7d_420453d29edd
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

getNumClasses

int getNumClasses()
                  throws java.io.IOException,
                         AutomationException
The number of classes.

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

getCapabilities

int getCapabilities(ILayer layer)
                    throws java.io.IOException,
                           AutomationException
Overposter capabilities for the specified layer.

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

addClass

int addClass(IOverposterLayerProperties props)
             throws java.io.IOException,
                    AutomationException
Adds a class to the overposter and specifies its properties.

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

insertClass

void insertClass(int index,
                 IOverposterLayerProperties props)
                 throws java.io.IOException,
                        AutomationException
Inserts a class at a specific index, and specifies its peoperties.

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

removeClass

void removeClass(int classIndex)
                 throws java.io.IOException,
                        AutomationException
Removes the class at the specified index from the overposter.

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

resetClasses

void resetClasses()
                  throws java.io.IOException,
                         AutomationException
Removes all classes from the overposter.

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

initialize

void initialize(IEnvelope extent,
                IDisplay display)
                throws java.io.IOException,
                       AutomationException
Initializes the overposter for drawing into the specified area of the map display.

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

addBarriers

void addBarriers(int weight,
                 IGeometryCollection barriers)
                 throws java.io.IOException,
                        AutomationException
Adds a barrier object that placed objects must avoid.

Parameters:
weight - A com.esri.arcgis.carto.esriBasicOverposterWeight constant (in)
barriers - A reference to a com.esri.arcgis.geometry.IGeometryCollection (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addLabel

void addLabel(int classIndex,
              java.lang.String label,
              double width,
              double height,
              IGeometry controlShape,
              int featureId,
              ISymbol symbol)
              throws java.io.IOException,
                     AutomationException
Adds a label object to be placed.

Parameters:
classIndex - The classIndex (in)
label - The label (in)
width - The width (in)
height - The height (in)
controlShape - A reference to a com.esri.arcgis.geometry.IGeometry (in)
featureId - The featureId (in)
symbol - A reference to a com.esri.arcgis.display.ISymbol (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addCurvedLabel

void addCurvedLabel(int classIndex,
                    java.lang.String label,
                    java.lang.Object widths,
                    java.lang.Object ascents,
                    java.lang.Object descents,
                    double fontHeight,
                    double fontDescent,
                    IGeometry controlShape,
                    int featureId,
                    ISymbol symbol)
                    throws java.io.IOException,
                           AutomationException
Adds a curved label object to be placed.

Parameters:
classIndex - The classIndex (in)
label - The label (in)
widths - A Variant (in)
ascents - A Variant (in)
descents - A Variant (in)
fontHeight - The fontHeight (in)
fontDescent - The fontDescent (in)
controlShape - A reference to a com.esri.arcgis.geometry.IGeometry (in)
featureId - The featureId (in)
symbol - A reference to a com.esri.arcgis.display.ISymbol (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addSymbol

void addSymbol(int classIndex,
               ISymbol symbol,
               IGeometry geometry,
               int featureId)
               throws java.io.IOException,
                      AutomationException
Adds a symbol to be placed.

Parameters:
classIndex - The classIndex (in)
symbol - A reference to a com.esri.arcgis.display.ISymbol (in)
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
featureId - The featureId (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

placeObjects

void placeObjects()
                  throws java.io.IOException,
                         AutomationException
Places objects using the overposter.

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

nextPlaced

void nextPlaced(IPlacedObject[] object,
                ITrackCancel trackCancel,
                IStepProgressor stepProgressor)
                throws java.io.IOException,
                       AutomationException
The next object that was successfully placed.

Parameters:
object - A reference to a com.esri.arcgis.carto.IPlacedObject (in/out: use single element array)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
stepProgressor - A reference to a com.esri.arcgis.system.IStepProgressor (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

nextUnplaced

void nextUnplaced(IPlacedObject[] object)
                  throws java.io.IOException,
                         AutomationException
The next object that was not successfully placed.

Parameters:
object - A reference to a com.esri.arcgis.carto.IPlacedObject (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

nextUnused

void nextUnused(IPlacedObject[] object)
                throws java.io.IOException,
                       AutomationException
The next object that was not used.

Parameters:
object - A reference to a com.esri.arcgis.carto.IPlacedObject (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

releaseResources

void releaseResources()
                      throws java.io.IOException,
                             AutomationException
Releases current objects from memory.

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

getNumberOfUnplacedLabels

int getNumberOfUnplacedLabels()
                              throws java.io.IOException,
                                     AutomationException
The number of unplaced labels. Only valid after calling PlaceObjects.

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

getNumberOfPlacedLabels

int getNumberOfPlacedLabels()
                            throws java.io.IOException,
                                   AutomationException
The number of unplaced labels. Only valid after calling PlaceObjects.

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

addLabel2

void addLabel2(int classIndex,
               java.lang.String label,
               double width,
               double height,
               IGeometry controlShape,
               int featureId,
               ISymbol symbol,
               double angle)
               throws java.io.IOException,
                      AutomationException
Adds a label object to be placed.

Parameters:
classIndex - The classIndex (in)
label - The label (in)
width - The width (in)
height - The height (in)
controlShape - A reference to a com.esri.arcgis.geometry.IGeometry (in)
featureId - The featureId (in)
symbol - A reference to a com.esri.arcgis.display.ISymbol (in)
angle - The angle (in)
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