| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.esri.arcgis.carto.BasicOverposter
public class BasicOverposter
An engine that places labels for features using conflict detection.
| Constructor Summary | |
|---|---|
| BasicOverposter()Constructs a BasicOverposter using ArcGIS Engine. | |
| BasicOverposter(Object obj)Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.  BasicOverposter theBasicOverposter = (BasicOverposter) obj; | |
| 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. | 
|  int | addClass(IOverposterLayerProperties props,
         ITextSymbol symbol)Adds a class to the overposter and specifies its properties. | 
|  void | addCurvedLabel(int classIndex,
               String label,
               Object widths,
               Object ascents,
               Object descents,
               double fontHeight,
               double fontDescent,
               IGeometry controlShape,
               int featureId,
               ISymbol symbol)Adds a curved label object to be placed. | 
|  void | addIBasicOverposterEventsListener(IBasicOverposterEvents theListener)addIBasicOverposterEventsListener. | 
|  void | addLabel(int classIndex,
         String label,
         double width,
         double height,
         IGeometry controlShape,
         int featureId,
         ISymbol symbol)Adds a label object to be placed. | 
|  void | addLabel2(int classIndex,
          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. | 
|  void | enumConnectionPoints(IEnumConnectionPoints[] ppEnum)enumConnectionPoints | 
|  boolean | equals(Object o)Compare this object with another | 
|  void | findConnectionPoint(GUID riid,
                    IConnectionPoint[] ppCP)findConnectionPoint | 
|  int | getCapabilities(ILayer layer)Overposter capabilities for the specified layer. | 
|  void | getClassID(GUID[] pClassID)getClassID | 
| static String | getClsid()getClsid. | 
|  int | getNumberOfPlacedLabels()The number of unplaced labels. | 
|  int | getNumberOfUnplacedLabels()The number of unplaced labels. | 
|  int | getNumClasses()The number of classes. | 
|  void | getSizeMax(_ULARGE_INTEGER[] pcbSize)getSizeMax | 
|  int | hashCode()the hashcode for this object | 
|  void | initialize(IEnvelope extent,
           IDisplay display)Initializes the overposter for drawing into the specified area of the map display. | 
|  void | initialize(IEnvelope extent,
           IDisplay display,
           IOverposterProperties pOverposterProps)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 | isDirty()isDirty | 
|  void | load(IStream pstm)load | 
|  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 | readExternal(ObjectInput in) | 
|  void | releaseResources()Releases current objects from memory. | 
|  void | removeClass(int classIndex)Removes the class at the specified index from the overposter. | 
|  void | removeIBasicOverposterEventsListener(IBasicOverposterEvents theListener)removeIBasicOverposterEventsListener. | 
|  void | resetClasses()Removes all classes from the overposter. | 
|  void | save(IStream pstm,
     int fClearDirty)save | 
|  void | writeExternal(ObjectOutput out) | 
| Methods inherited from class java.lang.Object | 
|---|
| clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait | 
| Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef | 
|---|
| getJintegraDispatch, release | 
| Constructor Detail | 
|---|
public BasicOverposter()
                throws IOException,
                       UnknownHostException
IOException - if there are interop problems
UnknownHostException - if there are interop problems
public BasicOverposter(Object obj)
                throws IOException
 BasicOverposter theBasicOverposter = (BasicOverposter) obj;
obj to BasicOverposter.
obj - an object returned from ArcGIS Engine or Server
IOException - if there are interop problems| Method Detail | 
|---|
public static String getClsid()
public boolean equals(Object o)
equals in class Objectpublic int hashCode()
hashCode in class Object
public void addIBasicOverposterEventsListener(IBasicOverposterEvents theListener)
                                       throws IOException
theListener - An object that implements the com.esri.arcgis.carto.IBasicOverposterEvents  interface.
IOException - If there are communications problems.
public void removeIBasicOverposterEventsListener(IBasicOverposterEvents theListener)
                                          throws IOException
theListener - An object that implements the com.esri.arcgis.carto.IBasicOverposterEvents  interface.
IOException - If there are communications problems.
public int getNumClasses()
                  throws IOException,
                         AutomationException
getNumClasses in interface IOverpostergetNumClasses in interface IOverposter2getNumClasses in interface IOverposter3IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getCapabilities(ILayer layer)
                    throws IOException,
                           AutomationException
getCapabilities in interface IOverpostergetCapabilities in interface IOverposter2getCapabilities in interface IOverposter3layer - A reference to a com.esri.arcgis.carto.ILayer  (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int addClass(IOverposterLayerProperties props)
             throws IOException,
                    AutomationException
addClass in interface IOverposteraddClass in interface IOverposter2addClass in interface IOverposter3props - A reference to a com.esri.arcgis.carto.IOverposterLayerProperties  (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void insertClass(int index,
                        IOverposterLayerProperties props)
                 throws IOException,
                        AutomationException
insertClass in interface IOverposterinsertClass in interface IOverposter2insertClass in interface IOverposter3index - The index  (in)props - A reference to a com.esri.arcgis.carto.IOverposterLayerProperties  (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void removeClass(int classIndex)
                 throws IOException,
                        AutomationException
removeClass in interface IOverposterremoveClass in interface IOverposter2removeClass in interface IOverposter3classIndex - The classIndex  (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void resetClasses()
                  throws IOException,
                         AutomationException
resetClasses in interface IOverposterresetClasses in interface IOverposter2resetClasses in interface IOverposter3IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void initialize(IEnvelope extent,
                       IDisplay display)
                throws IOException,
                       AutomationException
initialize in interface IOverposterinitialize in interface IOverposter2extent - A reference to a com.esri.arcgis.geometry.IEnvelope  (in)display - A reference to a com.esri.arcgis.display.IDisplay  (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void addBarriers(int weight,
                        IGeometryCollection barriers)
                 throws IOException,
                        AutomationException
addBarriers in interface IOverposteraddBarriers in interface IOverposter2addBarriers in interface IOverposter3weight - A com.esri.arcgis.carto.esriBasicOverposterWeight constant  (in)barriers - A reference to a com.esri.arcgis.geometry.IGeometryCollection  (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void addLabel(int classIndex,
                     String label,
                     double width,
                     double height,
                     IGeometry controlShape,
                     int featureId,
                     ISymbol symbol)
              throws IOException,
                     AutomationException
addLabel in interface IOverposteraddLabel in interface IOverposter2addLabel in interface IOverposter3classIndex - 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)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void addCurvedLabel(int classIndex,
                           String label,
                           Object widths,
                           Object ascents,
                           Object descents,
                           double fontHeight,
                           double fontDescent,
                           IGeometry controlShape,
                           int featureId,
                           ISymbol symbol)
                    throws IOException,
                           AutomationException
addCurvedLabel in interface IOverposteraddCurvedLabel in interface IOverposter2addCurvedLabel in interface IOverposter3classIndex - 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)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void addSymbol(int classIndex,
                      ISymbol symbol,
                      IGeometry geometry,
                      int featureId)
               throws IOException,
                      AutomationException
addSymbol in interface IOverposteraddSymbol in interface IOverposter2addSymbol in interface IOverposter3classIndex - 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)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void placeObjects()
                  throws IOException,
                         AutomationException
placeObjects in interface IOverposterplaceObjects in interface IOverposter2placeObjects in interface IOverposter3IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void nextPlaced(IPlacedObject[] object,
                       ITrackCancel trackCancel,
                       IStepProgressor stepProgressor)
                throws IOException,
                       AutomationException
nextPlaced in interface IOverposternextPlaced in interface IOverposter2nextPlaced in interface IOverposter3object - 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)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void nextUnplaced(IPlacedObject[] object)
                  throws IOException,
                         AutomationException
nextUnplaced in interface IOverposternextUnplaced in interface IOverposter2nextUnplaced in interface IOverposter3object - A reference to a com.esri.arcgis.carto.IPlacedObject  (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void nextUnused(IPlacedObject[] object)
                throws IOException,
                       AutomationException
nextUnused in interface IOverposternextUnused in interface IOverposter2nextUnused in interface IOverposter3object - A reference to a com.esri.arcgis.carto.IPlacedObject  (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void releaseResources()
                      throws IOException,
                             AutomationException
releaseResources in interface IOverposterreleaseResources in interface IOverposter2releaseResources in interface IOverposter3IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getNumberOfUnplacedLabels()
                              throws IOException,
                                     AutomationException
getNumberOfUnplacedLabels in interface IOverpostergetNumberOfUnplacedLabels in interface IOverposter2getNumberOfUnplacedLabels in interface IOverposter3IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getNumberOfPlacedLabels()
                            throws IOException,
                                   AutomationException
getNumberOfPlacedLabels in interface IOverpostergetNumberOfPlacedLabels in interface IOverposter2getNumberOfPlacedLabels in interface IOverposter3IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void addLabel2(int classIndex,
                      String label,
                      double width,
                      double height,
                      IGeometry controlShape,
                      int featureId,
                      ISymbol symbol,
                      double angle)
               throws IOException,
                      AutomationException
addLabel2 in interface IOverposter2addLabel2 in interface IOverposter3classIndex - 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)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void initialize(IEnvelope extent,
                       IDisplay display,
                       IOverposterProperties pOverposterProps)
                throws IOException,
                       AutomationException
initialize in interface IOverposter3extent - A reference to a com.esri.arcgis.geometry.IEnvelope  (in)display - A reference to a com.esri.arcgis.display.IDisplay  (in)pOverposterProps - A reference to a com.esri.arcgis.carto.IOverposterProperties  (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int addClass(IOverposterLayerProperties props,
                    ITextSymbol symbol)
             throws IOException,
                    AutomationException
addClass in interface IOverposter4props - A reference to a com.esri.arcgis.carto.IOverposterLayerProperties  (in)symbol - A reference to a com.esri.arcgis.display.ITextSymbol  (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws IOException,
                                 AutomationException
IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.
enumConnectionPoints in interface IConnectionPointContainerppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints  (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws IOException,
                                AutomationException
IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.
findConnectionPoint in interface IConnectionPointContainerriid - A Structure: com.esri.arcgis.support.ms.stdole.GUID  (in)ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint  (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException
IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.
getClassID in interface IPersistpClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID  (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void isDirty()
             throws IOException,
                    AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
isDirty in interface IPersistStreamIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void load(IStream pstm)
          throws IOException,
                 AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
load in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream  (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
save in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream  (in)fClearDirty - The fClearDirty  (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
getSizeMax in interface IPersistStreampcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER  (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void writeExternal(ObjectOutput out)
                   throws IOException
writeExternal in interface ExternalizableIOException
public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
readExternal in interface ExternalizableIOException
ClassNotFoundException| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||