com.esri.arcgis.carto
Interface ILabelCache

All Superinterfaces:
Serializable
All Known Implementing Classes:
LabelCache

public interface ILabelCache
extends Serializable

Provides access to members that control a label cache.

Remarks

This interface is not supported for customization and may be removed at a future release.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


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, 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, 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, String[] className, IFeatureLayer[] featureLayer, ITextSymbol[] textSymbol)
          Retrieve a class from the label cache.
 

Method Detail

init

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

empty

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

addClass

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getClassCount

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

queryClass

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

addLabel

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getPlacedLabelCount

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getPlacedLabel

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getUnplacedLabelCount

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getUnplacedLabel

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

putDisplaySettings

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getDisplaySettings

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
scale - The scale (out: use single element array)
dataframeRotation - The dataframeRotation (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.