com.esri.arcgis.carto
Class BasicOverposterProperties

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

All Implemented Interfaces:

IOverposterOptions, IOverposterOptions2, IOverposterProperties, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, Externalizable, Serializable

public class BasicOverposterProperties
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IOverposterProperties, IOverposterOptions, IOverposterOptions2, IPersist, IPersistStream, IClone, Externalizable

Basic label placement control properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

BasicOverposterProperties()
Constructs a BasicOverposterProperties using ArcGIS Engine.

BasicOverposterProperties(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
BasicOverposterProperties theBasicOverposterProperties = (BasicOverposterProperties) 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.
IUID	getAnnotateFeatureID() The UID of the required AnnotateFeature object.
IUID	getAnnotateMapID() The UID of the required AnnotateMap object.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
IUID	getFeatureLayerPropertiesID() The UID of the required labeling LabelEngineLayerProperties object.
double	getInvertedLabelTolerance() The angle at which the label orientation is switched.
IUID	getLabelStyleID() The UID of the required LabelStyle object.
String	getName() Name of the overposter.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
IColor	getUnplacedLabelColor() The color with which unplaced labels are drawn.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isEnableDrawUnplaced() Indicates whether the unplaced labels are drawn.
boolean	isEnableLabelCache() Indicates whether labels are returned from cache or placement run.
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isPauseLabeling() Indicates whether to pause the drawing of labels.
boolean	isRotateLabelWithDataFrame() Indicates if labels are rotated if the data frame is rotated.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	setEnableDrawUnplaced(boolean flag) Indicates whether the unplaced labels are drawn.
void	setEnableLabelCache(boolean flag) Indicates whether labels are returned from cache or placement run.
void	setInvertedLabelTolerance(double angle) The angle at which the label orientation is switched.
void	setPauseLabeling(boolean flag) Indicates whether to pause the drawing of labels.
void	setRotateLabelWithDataFrame(boolean flag) Indicates if labels are rotated if the data frame is rotated.
void	setUnplacedLabelColorByRef(IColor color) The color with which unplaced labels are drawn.
void	stackLabel(ILabelEngineLayerProperties layerprops, boolean forceStack, String labelIn, boolean[] stacked, String[] labelOut) Provides the option to stack a label based on the current overposter properties.
void	translateLabel(ILabelEngineLayerProperties layerprops, String labelIn, boolean[] translated, String[] labelOut) Provides the option to translate a label based on the current overposter properties.
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

BasicOverposterProperties

public BasicOverposterProperties()
                          throws IOException,
                                 UnknownHostException

Constructs a BasicOverposterProperties using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

BasicOverposterProperties

public BasicOverposterProperties(Object obj)
                          throws IOException

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

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

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

getName

public String getName()
               throws IOException,
                      AutomationException

Name of the overposter.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IOverposterProperties

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAnnotateFeatureID

public IUID getAnnotateFeatureID()
                          throws IOException,
                                 AutomationException

The UID of the required AnnotateFeature object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAnnotateFeatureID in interface IOverposterProperties

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAnnotateMapID

public IUID getAnnotateMapID()
                      throws IOException,
                             AutomationException

The UID of the required AnnotateMap object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAnnotateMapID in interface IOverposterProperties

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFeatureLayerPropertiesID

public IUID getFeatureLayerPropertiesID()
                                 throws IOException,
                                        AutomationException

The UID of the required labeling LabelEngineLayerProperties object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFeatureLayerPropertiesID in interface IOverposterProperties

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabelStyleID

public IUID getLabelStyleID()
                     throws IOException,
                            AutomationException

The UID of the required LabelStyle object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLabelStyleID in interface IOverposterProperties

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

translateLabel

public void translateLabel(ILabelEngineLayerProperties layerprops,
                           String labelIn,
                           boolean[] translated,
                           String[] labelOut)
                    throws IOException,
                           AutomationException

Provides the option to translate a label based on the current overposter properties.

Product Availability

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

Specified by:

translateLabel in interface IOverposterOptions

Parameters:

layerprops - A reference to a com.esri.arcgis.carto.ILabelEngineLayerProperties (in)

labelIn - The labelIn (in)

translated - The translated (out: use single element array)

labelOut - The labelOut (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stackLabel

public void stackLabel(ILabelEngineLayerProperties layerprops,
                       boolean forceStack,
                       String labelIn,
                       boolean[] stacked,
                       String[] labelOut)
                throws IOException,
                       AutomationException

Provides the option to stack a label based on the current overposter properties.

Product Availability

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

Specified by:

stackLabel in interface IOverposterOptions

Parameters:

layerprops - A reference to a com.esri.arcgis.carto.ILabelEngineLayerProperties (in)

forceStack - The forceStack (in)

labelIn - The labelIn (in)

stacked - The stacked (out: use single element array)

labelOut - The labelOut (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnableLabelCache

public boolean isEnableLabelCache()
                           throws IOException,
                                  AutomationException

Indicates whether labels are returned from cache or placement run.

Product Availability

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

Specified by:

isEnableLabelCache in interface IOverposterOptions

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnableLabelCache

public void setEnableLabelCache(boolean flag)
                         throws IOException,
                                AutomationException

Indicates whether labels are returned from cache or placement run.

Product Availability

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

Specified by:

setEnableLabelCache in interface IOverposterOptions

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnableDrawUnplaced

public boolean isEnableDrawUnplaced()
                             throws IOException,
                                    AutomationException

Indicates whether the unplaced labels are drawn.

Product Availability

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

Specified by:

isEnableDrawUnplaced in interface IOverposterOptions

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnableDrawUnplaced

public void setEnableDrawUnplaced(boolean flag)
                           throws IOException,
                                  AutomationException

Indicates whether the unplaced labels are drawn.

Product Availability

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

Specified by:

setEnableDrawUnplaced in interface IOverposterOptions

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUnplacedLabelColorByRef

public void setUnplacedLabelColorByRef(IColor color)
                                throws IOException,
                                       AutomationException

The color with which unplaced labels are drawn.

Product Availability

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

Specified by:

setUnplacedLabelColorByRef in interface IOverposterOptions

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUnplacedLabelColor

public IColor getUnplacedLabelColor()
                             throws IOException,
                                    AutomationException

The color with which unplaced labels are drawn.

Product Availability

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

Specified by:

getUnplacedLabelColor in interface IOverposterOptions

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInvertedLabelTolerance

public void setInvertedLabelTolerance(double angle)
                               throws IOException,
                                      AutomationException

The angle at which the label orientation is switched.

Product Availability

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

Specified by:

setInvertedLabelTolerance in interface IOverposterOptions

Parameters:

angle - The angle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInvertedLabelTolerance

public double getInvertedLabelTolerance()
                                 throws IOException,
                                        AutomationException

The angle at which the label orientation is switched.

Product Availability

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

Specified by:

getInvertedLabelTolerance in interface IOverposterOptions

Returns:

The angle

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRotateLabelWithDataFrame

public void setRotateLabelWithDataFrame(boolean flag)
                                 throws IOException,
                                        AutomationException

Indicates if labels are rotated if the data frame is rotated.

Product Availability

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

Specified by:

setRotateLabelWithDataFrame in interface IOverposterOptions

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRotateLabelWithDataFrame

public boolean isRotateLabelWithDataFrame()
                                   throws IOException,
                                          AutomationException

Indicates if labels are rotated if the data frame is rotated.

Product Availability

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

Specified by:

isRotateLabelWithDataFrame in interface IOverposterOptions

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPauseLabeling

public boolean isPauseLabeling()
                        throws IOException,
                               AutomationException

Indicates whether to pause the drawing of labels.

Product Availability

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

Specified by:

isPauseLabeling in interface IOverposterOptions2

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPauseLabeling

public void setPauseLabeling(boolean flag)
                      throws IOException,
                             AutomationException

Indicates whether to pause the drawing of labels.

Product Availability

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

Specified by:

setPauseLabeling in interface IOverposterOptions2

Parameters:

flag - The flag (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

Indicates if 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

Indicates if 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