com.esri.arcgis.carto
Class PointPlacementPriorities

java.lang.Object
  extended by com.esri.arcgis.carto.PointPlacementPriorities
All Implemented Interfaces:
IPointPlacementPriorities, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, Externalizable, Serializable

public class PointPlacementPriorities
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IPointPlacementPriorities, IPersist, IPersistStream, IClone, Externalizable

Controls placement position priorities for point labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
PointPlacementPriorities()
          Constructs a PointPlacementPriorities using ArcGIS Engine.
PointPlacementPriorities(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
PointPlacementPriorities thePointPlacementPriorities = (PointPlacementPriorities) obj;
 
Method Summary
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 boolean equals(Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 int getAboveCenter()
          Label position priority for above and center (0-9).
 int getAboveLeft()
          Label position priority for above and to the left (0-9).
 int getAboveRight()
          Label position priority for above and to the right (0-9).
 int getBelowCenter()
          Label position priority for below and center (0-9).
 int getBelowLeft()
          Label position priority for below and to the left (0-9).
 int getBelowRight()
          Label position priority for below and to the right (0-9).
 int getCenterLeft()
          Label position priority for center and to the left (0-9).
 int getCenterRight()
          Label position priority for center and to the right (0-9).
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int hashCode()
          the hashcode for this object
 void isDirty()
          isDirty
 boolean isEqual(IClone other)
          Returns TRUE when the receiver and other have the same properties.
 boolean isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 void load(IStream pstm)
          load
 void readExternal(ObjectInput in)
           
 void save(IStream pstm, int fClearDirty)
          save
 void setAboveCenter(int priority)
          Label position priority for above and center (0-9).
 void setAboveLeft(int priority)
          Label position priority for above and to the left (0-9).
 void setAboveRight(int priority)
          Label position priority for above and to the right (0-9).
 void setBelowCenter(int priority)
          Label position priority for below and center (0-9).
 void setBelowLeft(int priority)
          Label position priority for below and to the left (0-9).
 void setBelowRight(int priority)
          Label position priority for below and to the right (0-9).
 void setCenterLeft(int priority)
          Label position priority for center and to the left (0-9).
 void setCenterRight(int priority)
          Label position priority for center and to the right (0-9).
 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

PointPlacementPriorities

public PointPlacementPriorities()
                         throws IOException,
                                UnknownHostException
Constructs a PointPlacementPriorities using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

PointPlacementPriorities

public PointPlacementPriorities(Object obj)
                         throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
PointPlacementPriorities thePointPlacementPriorities = (PointPlacementPriorities) obj;

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

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getAboveLeft

public int getAboveLeft()
                 throws IOException,
                        AutomationException
Label position priority for above and to the left (0-9).

Description

Valid range is 0-9. 0 means that the position should not be considered at all for label placement. 1 means that the position is has highest priority for placement, and 9 means that the position has lowest priority.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getAboveLeft in interface IPointPlacementPriorities
Returns:
The priority
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAboveLeft

public void setAboveLeft(int priority)
                  throws IOException,
                         AutomationException
Label position priority for above and to the left (0-9).

Description

Valid range is 0-9. 0 means that the position should not be considered at all for label placement. 1 means that the position is has highest priority for placement, and 9 means that the position has lowest priority.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setAboveLeft in interface IPointPlacementPriorities
Parameters:
priority - The priority (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAboveCenter

public int getAboveCenter()
                   throws IOException,
                          AutomationException
Label position priority for above and center (0-9).

Description

Valid range is 0-9. 0 means that the position should not be considered at all for label placement. 1 means that the position is has highest priority for placement, and 9 means that the position has lowest priority.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getAboveCenter in interface IPointPlacementPriorities
Returns:
The priority
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAboveCenter

public void setAboveCenter(int priority)
                    throws IOException,
                           AutomationException
Label position priority for above and center (0-9).

Description

Valid range is 0-9. 0 means that the position should not be considered at all for label placement. 1 means that the position is has highest priority for placement, and 9 means that the position has lowest priority.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setAboveCenter in interface IPointPlacementPriorities
Parameters:
priority - The priority (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAboveRight

public int getAboveRight()
                  throws IOException,
                         AutomationException
Label position priority for above and to the right (0-9).

Description

Valid range is 0-9. 0 means that the position should not be considered at all for label placement. 1 means that the position is has highest priority for placement, and 9 means that the position has lowest priority.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getAboveRight in interface IPointPlacementPriorities
Returns:
The priority
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAboveRight

public void setAboveRight(int priority)
                   throws IOException,
                          AutomationException
Label position priority for above and to the right (0-9).

Description

Valid range is 0-9. 0 means that the position should not be considered at all for label placement. 1 means that the position is has highest priority for placement, and 9 means that the position has lowest priority.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setAboveRight in interface IPointPlacementPriorities
Parameters:
priority - The priority (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCenterRight

public int getCenterRight()
                   throws IOException,
                          AutomationException
Label position priority for center and to the right (0-9).

Description

Valid range is 0-9. 0 means that the position should not be considered at all for label placement. 1 means that the position is has highest priority for placement, and 9 means that the position has lowest priority.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getCenterRight in interface IPointPlacementPriorities
Returns:
The priority
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCenterRight

public void setCenterRight(int priority)
                    throws IOException,
                           AutomationException
Label position priority for center and to the right (0-9).

Description

Valid range is 0-9. 0 means that the position should not be considered at all for label placement. 1 means that the position is has highest priority for placement, and 9 means that the position has lowest priority.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCenterRight in interface IPointPlacementPriorities
Parameters:
priority - The priority (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBelowRight

public int getBelowRight()
                  throws IOException,
                         AutomationException
Label position priority for below and to the right (0-9).

Description

Valid range is 0-9. 0 means that the position should not be considered at all for label placement. 1 means that the position is has highest priority for placement, and 9 means that the position has lowest priority.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getBelowRight in interface IPointPlacementPriorities
Returns:
The priority
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBelowRight

public void setBelowRight(int priority)
                   throws IOException,
                          AutomationException
Label position priority for below and to the right (0-9).

Description

Valid range is 0-9. 0 means that the position should not be considered at all for label placement. 1 means that the position is has highest priority for placement, and 9 means that the position has lowest priority.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setBelowRight in interface IPointPlacementPriorities
Parameters:
priority - The priority (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBelowCenter

public int getBelowCenter()
                   throws IOException,
                          AutomationException
Label position priority for below and center (0-9).

Description

Valid range is 0-9. 0 means that the position should not be considered at all for label placement. 1 means that the position is has highest priority for placement, and 9 means that the position has lowest priority.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getBelowCenter in interface IPointPlacementPriorities
Returns:
The priority
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBelowCenter

public void setBelowCenter(int priority)
                    throws IOException,
                           AutomationException
Label position priority for below and center (0-9).

Description

Valid range is 0-9. 0 means that the position should not be considered at all for label placement. 1 means that the position is has highest priority for placement, and 9 means that the position has lowest priority.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setBelowCenter in interface IPointPlacementPriorities
Parameters:
priority - The priority (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBelowLeft

public int getBelowLeft()
                 throws IOException,
                        AutomationException
Label position priority for below and to the left (0-9).

Description

Valid range is 0-9. 0 means that the position should not be considered at all for label placement. 1 means that the position is has highest priority for placement, and 9 means that the position has lowest priority.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getBelowLeft in interface IPointPlacementPriorities
Returns:
The priority
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBelowLeft

public void setBelowLeft(int priority)
                  throws IOException,
                         AutomationException
Label position priority for below and to the left (0-9).

Description

Valid range is 0-9. 0 means that the position should not be considered at all for label placement. 1 means that the position is has highest priority for placement, and 9 means that the position has lowest priority.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setBelowLeft in interface IPointPlacementPriorities
Parameters:
priority - The priority (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCenterLeft

public int getCenterLeft()
                  throws IOException,
                         AutomationException
Label position priority for center and to the left (0-9).

Description

Valid range is 0-9. 0 means that the position should not be considered at all for label placement. 1 means that the position is has highest priority for placement, and 9 means that the position has lowest priority.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getCenterLeft in interface IPointPlacementPriorities
Returns:
The priority
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCenterLeft

public void setCenterLeft(int priority)
                   throws IOException,
                          AutomationException
Label position priority for center and to the left (0-9).

Description

Valid range is 0-9. 0 means that the position should not be considered at all for label placement. 1 means that the position is has highest priority for placement, and 9 means that the position has lowest priority.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCenterLeft in interface IPointPlacementPriorities
Parameters:
priority - The priority (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException
getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException
isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDirty in interface IPersistStream
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException
load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException
save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException
getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException
Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:
esri_clone in interface IClone
Returns:
A reference to a com.esri.arcgis.system.IClone
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException
Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
assign in interface IClone
Parameters:
src - A reference to a com.esri.arcgis.system.IClone (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException
Returns TRUE when the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isEqual in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The equal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException
Returns TRUE when the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isIdentical in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The identical
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Throws:
IOException
ClassNotFoundException