com.esri.arcgis.carto
Class LabelCache

java.lang.Object
  com.esri.arcgis.carto.LabelCache

All Implemented Interfaces:

IActiveViewEvents, ILabelCache, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable, java.util.EventListener

public class LabelCache
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ILabelCache, IActiveViewEvents

COM Class 'LabelCache'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'Standard labeling 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 =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.carto.ILabelCache

IID, IIDed758af4_ff98_4c14_bba4_e7580433afd6, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IActiveViewEvents

IID, IIDe79c5940_52dd_11d0_98be_00805f7ced21, xxDummy

Constructor Summary

LabelCache()
Constructs a LabelCache using ArcGIS Engine.

LabelCache(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
LabelCache theLabelCache = (LabelCache) obj;

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	afterDraw(IActiveViewEventsAfterDrawEvent theEvent) Fired after the specified phase is drawn.
void	afterItemDraw(IActiveViewEventsAfterItemDrawEvent theEvent) Fired after an individual view item is drawn.
void	contentsChanged(IActiveViewEventsContentsChangedEvent theEvent) Fired when the contents of the view changes.
void	contentsCleared(IActiveViewEventsContentsClearedEvent theEvent) Fired when the contents of the view is cleared.
void	empty() Empty label cache.
boolean	equals(java.lang.Object o) Compare this object with another
void	focusMapChanged(IActiveViewEventsFocusMapChangedEvent theEvent) Fired when a new map is made active.
int	getClassCount() Number of classes in the cache.
static java.lang.String	getClsid() getClsid.
void	getDisplaySettings(double[] scale, double[] dataframeRotation) Settings of the display transformation when cache was created.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
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.
int	hashCode() the hashcode for this object
void	init(IMap map) Initialize label cache.
void	itemAdded(IActiveViewEventsItemAddedEvent theEvent) Fired when an item is added to the view.
void	itemDeleted(IActiveViewEventsItemDeletedEvent theEvent) Fired when an item is deleted from the view.
void	itemReordered(IActiveViewEventsItemReorderedEvent theEvent) Fired when a view item is reordered.
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.
void	release() Release a LabelCache.
void	selectionChanged(IActiveViewEventsSelectionChangedEvent theEvent) Call this function to fire the selection changed event.
void	spatialReferenceChanged(IActiveViewEventsSpatialReferenceChangedEvent theEvent) Fired when the spatial reference is changed.
void	viewRefreshed(IActiveViewEventsViewRefreshedEvent theEvent) Fired when view is refreshed before draw happens.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LabelCache

public LabelCache()
           throws java.io.IOException,
                  java.net.UnknownHostException

Constructs a LabelCache using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

LabelCache

public LabelCache(java.lang.Object obj)
           throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
LabelCache theLabelCache = (LabelCache) obj;

Construct a LabelCache using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to LabelCache.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a LabelCache.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

init

public void init(IMap map)
          throws java.io.IOException,
                 AutomationException

Initialize label cache.

Specified by:

init in interface ILabelCache

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

public void empty()
           throws java.io.IOException,
                  AutomationException

Empty label cache.

Specified by:

empty in interface ILabelCache

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addClass

public void addClass(int classID,
                     ILabelEngineLayerProperties pLayerProps)
              throws java.io.IOException,
                     AutomationException

Add a class to the label cache.

Specified by:

addClass in interface ILabelCache

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

public int getClassCount()
                  throws java.io.IOException,
                         AutomationException

Number of classes in the cache.

Specified by:

getClassCount in interface ILabelCache

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryClass

public 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.

Specified by:

queryClass in interface ILabelCache

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

public void addLabel(IPlacedObject3 placedObject,
                     IPoint anchorPoint,
                     IEnvelope pEnvelope)
              throws java.io.IOException,
                     AutomationException

Add a label to the label cache.

Specified by:

addLabel in interface ILabelCache

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

public int getPlacedLabelCount()
                        throws java.io.IOException,
                               AutomationException

Number of placed labels stored the cache.

Specified by:

getPlacedLabelCount in interface ILabelCache

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPlacedLabel

public 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.

Specified by:

getPlacedLabel in interface ILabelCache

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

public int getUnplacedLabelCount()
                          throws java.io.IOException,
                                 AutomationException

Number of unplaced labels stored the cache.

Specified by:

getUnplacedLabelCount in interface ILabelCache

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUnplacedLabel

public 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.

Specified by:

getUnplacedLabel in interface ILabelCache

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

public void putDisplaySettings(double scale,
                               double dataframeRotation)
                        throws java.io.IOException,
                               AutomationException

Settings of the display transformation when cache was created.

Specified by:

putDisplaySettings in interface ILabelCache

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

public void getDisplaySettings(double[] scale,
                               double[] dataframeRotation)
                        throws java.io.IOException,
                               AutomationException

Settings of the display transformation when cache was created.

Specified by:

getDisplaySettings in interface ILabelCache

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.

contentsChanged

public void contentsChanged(IActiveViewEventsContentsChangedEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

Fired when the contents of the view changes.

Specified by:

contentsChanged in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

contentsCleared

public void contentsCleared(IActiveViewEventsContentsClearedEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

Fired when the contents of the view is cleared.

Specified by:

contentsCleared in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

itemAdded

public void itemAdded(IActiveViewEventsItemAddedEvent theEvent)
               throws java.io.IOException,
                      AutomationException

Fired when an item is added to the view.

Specified by:

itemAdded in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

itemDeleted

public void itemDeleted(IActiveViewEventsItemDeletedEvent theEvent)
                 throws java.io.IOException,
                        AutomationException

Fired when an item is deleted from the view.

Specified by:

itemDeleted in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

itemReordered

public void itemReordered(IActiveViewEventsItemReorderedEvent theEvent)
                   throws java.io.IOException,
                          AutomationException

Fired when a view item is reordered.

Specified by:

itemReordered in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

selectionChanged

public void selectionChanged(IActiveViewEventsSelectionChangedEvent theEvent)
                      throws java.io.IOException,
                             AutomationException

Call this function to fire the selection changed event.

Specified by:

selectionChanged in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

viewRefreshed

public void viewRefreshed(IActiveViewEventsViewRefreshedEvent theEvent)
                   throws java.io.IOException,
                          AutomationException

Fired when view is refreshed before draw happens.

Specified by:

viewRefreshed in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

afterDraw

public void afterDraw(IActiveViewEventsAfterDrawEvent theEvent)
               throws java.io.IOException,
                      AutomationException

Fired after the specified phase is drawn.

Specified by:

afterDraw in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

afterItemDraw

public void afterItemDraw(IActiveViewEventsAfterItemDrawEvent theEvent)
                   throws java.io.IOException,
                          AutomationException

Fired after an individual view item is drawn. Example: view items include layers in a map or elements in a page layout.

Specified by:

afterItemDraw in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

focusMapChanged

public void focusMapChanged(IActiveViewEventsFocusMapChangedEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

Fired when a new map is made active.

Specified by:

focusMapChanged in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

spatialReferenceChanged

public void spatialReferenceChanged(IActiveViewEventsSpatialReferenceChangedEvent theEvent)
                             throws java.io.IOException,
                                    AutomationException

Fired when the spatial reference is changed.

Specified by:

spatialReferenceChanged in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.