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 ILabelCache

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
ILabelCacheProxy, LabelCache
public interface ILabelCache
extends java.io.Serializable

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

Description: 'Provides access to members that control a label cache.' 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 IIDed758af4_ff98_4c14_bba4_e7580433afd6
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void addClass(int classID, ILabelEngineLayerProperties pLayerProps)
          Add a class to the label cache.
 void addLabel(IPlacedObject3 placedObject, IPoint anchorPoint, IEnvelope pEnvelope)
          Add a label to the label cache.
 void empty()
          Empty label cache.
 int getClassCount()
          Number of classes in the cache.
 void getDisplaySettings(double[] scale, double[] dataframeRotation)
          Settings of the display transformation when cache was created.
 void getPlacedLabel(int index, int[] classID, java.lang.String[] label, IGeometry[] geom, double[] angle, IPoint[] anchorPoint, IEnvelope[] mbr)
          Retrieve a placed label from the label cache.
 int getPlacedLabelCount()
          Number of placed labels stored the cache.
 void getUnplacedLabel(int index, int[] classID, java.lang.String[] label, IGeometry[] geom, double[] angle, IPoint[] anchorPoint, IEnvelope[] mbr)
          Retrieve an unplaced label from the label cache.
 int getUnplacedLabelCount()
          Number of unplaced labels stored the cache.
 void init(IMap map)
          Initialize label cache.
 void putDisplaySettings(double scale, double dataframeRotation)
          Settings of the display transformation when cache was created.
 void queryClass(int index, int[] classID, java.lang.String[] className, IFeatureLayer[] featureLayer, ITextSymbol[] textSymbol)
          Retrieve a class from the label cache.
 

Field Detail

IIDed758af4_ff98_4c14_bba4_e7580433afd6

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

init

void init(IMap map)
          throws java.io.IOException,
                 AutomationException
Initialize label cache.

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

empty

void empty()
           throws java.io.IOException,
                  AutomationException
Empty label cache.

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

addClass

void addClass(int classID,
              ILabelEngineLayerProperties pLayerProps)
              throws java.io.IOException,
                     AutomationException
Add a class to the label cache.

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

getClassCount

int getClassCount()
                  throws java.io.IOException,
                         AutomationException
Number of classes in the cache.

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

queryClass

void queryClass(int index,
                int[] classID,
                java.lang.String[] className,
                IFeatureLayer[] featureLayer,
                ITextSymbol[] textSymbol)
                throws java.io.IOException,
                       AutomationException
Retrieve a class from the label cache.

Parameters:
index - The index (in)
classID - The classID (out: use single element array)
className - The className (out: use single element array)
featureLayer - A reference to a com.esri.arcgis.carto.IFeatureLayer (out: use single element array)
textSymbol - A reference to a com.esri.arcgis.display.ITextSymbol (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addLabel

void addLabel(IPlacedObject3 placedObject,
              IPoint anchorPoint,
              IEnvelope pEnvelope)
              throws java.io.IOException,
                     AutomationException
Add a label to the label cache.

Parameters:
placedObject - A reference to a com.esri.arcgis.carto.IPlacedObject3 (in)
anchorPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)
pEnvelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPlacedLabelCount

int getPlacedLabelCount()
                        throws java.io.IOException,
                               AutomationException
Number of placed labels stored the cache.

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

getPlacedLabel

void getPlacedLabel(int index,
                    int[] classID,
                    java.lang.String[] label,
                    IGeometry[] geom,
                    double[] angle,
                    IPoint[] anchorPoint,
                    IEnvelope[] mbr)
                    throws java.io.IOException,
                           AutomationException
Retrieve a placed label from the label cache.

Parameters:
index - The index (in)
classID - The classID (out: use single element array)
label - The label (out: use single element array)
geom - A reference to a com.esri.arcgis.geometry.IGeometry (out: use single element array)
angle - The angle (out: use single element array)
anchorPoint - A reference to a com.esri.arcgis.geometry.IPoint (out: use single element array)
mbr - A reference to a com.esri.arcgis.geometry.IEnvelope (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUnplacedLabelCount

int getUnplacedLabelCount()
                          throws java.io.IOException,
                                 AutomationException
Number of unplaced labels stored the cache.

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

getUnplacedLabel

void getUnplacedLabel(int index,
                      int[] classID,
                      java.lang.String[] label,
                      IGeometry[] geom,
                      double[] angle,
                      IPoint[] anchorPoint,
                      IEnvelope[] mbr)
                      throws java.io.IOException,
                             AutomationException
Retrieve an unplaced label from the label cache.

Parameters:
index - The index (in)
classID - The classID (out: use single element array)
label - The label (out: use single element array)
geom - A reference to a com.esri.arcgis.geometry.IGeometry (out: use single element array)
angle - The angle (out: use single element array)
anchorPoint - A reference to a com.esri.arcgis.geometry.IPoint (out: use single element array)
mbr - A reference to a com.esri.arcgis.geometry.IEnvelope (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

putDisplaySettings

void putDisplaySettings(double scale,
                        double dataframeRotation)
                        throws java.io.IOException,
                               AutomationException
Settings of the display transformation when cache was created.

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

getDisplaySettings

void getDisplaySettings(double[] scale,
                        double[] dataframeRotation)
                        throws java.io.IOException,
                               AutomationException
Settings of the display transformation when cache was created.

Parameters:
scale - The scale (out: use single element array)
dataframeRotation - The dataframeRotation (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