com.esri.arcgis.carto
Class LabelStyle

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

All Implemented Interfaces:

ILabelStyle, ILabelStyle2, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, Externalizable, Serializable

public class LabelStyle
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ILabelStyle, ILabelStyle2, IPersistStream, IPersist, IClone, Externalizable

An object that controls label symbol and placement properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

LabelStyle()
Constructs a LabelStyle using ArcGIS Engine.

LabelStyle(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
LabelStyle theLabelStyle = (LabelStyle) 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.
IBasicOverposterLayerProperties	getBasicOverposterLayerProperties() The overposter properties, which specify how labels are placed relative to features.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
IOverposterLayerProperties	getOverposterLayerProperties() The overposter properties, which specify how labels are placed relative to features.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
ITextSymbol	getSymbol() The text symbol used to draw the label.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
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.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	setBasicOverposterLayerPropertiesByRef(IBasicOverposterLayerProperties props) The overposter properties, which specify how labels are placed relative to features.
void	setOverposterLayerPropertiesByRef(IOverposterLayerProperties props) The overposter properties, which specify how labels are placed relative to features.
void	setSymbolByRef(ITextSymbol textSymbol) The text symbol used to draw the label.
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

LabelStyle

public LabelStyle()
           throws IOException,
                  UnknownHostException

Constructs a LabelStyle using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

LabelStyle

public LabelStyle(Object obj)
           throws IOException

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

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

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

setSymbolByRef

public void setSymbolByRef(ITextSymbol textSymbol)
                    throws IOException,
                           AutomationException

The text symbol used to draw the label.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSymbolByRef in interface ILabelStyle

Specified by:

setSymbolByRef in interface ILabelStyle2

Parameters:

textSymbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSymbol

public ITextSymbol getSymbol()
                      throws IOException,
                             AutomationException

The text symbol used to draw the label.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSymbol in interface ILabelStyle

Specified by:

getSymbol in interface ILabelStyle2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBasicOverposterLayerPropertiesByRef

public void setBasicOverposterLayerPropertiesByRef(IBasicOverposterLayerProperties props)
                                            throws IOException,
                                                   AutomationException

The overposter properties, which specify how labels are placed relative to features.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBasicOverposterLayerPropertiesByRef in interface ILabelStyle

Specified by:

setBasicOverposterLayerPropertiesByRef in interface ILabelStyle2

Parameters:

props - A reference to a com.esri.arcgis.carto.IBasicOverposterLayerProperties (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBasicOverposterLayerProperties

public IBasicOverposterLayerProperties getBasicOverposterLayerProperties()
                                                                  throws IOException,
                                                                         AutomationException

The overposter properties, which specify how labels are placed relative to features.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBasicOverposterLayerProperties in interface ILabelStyle

Specified by:

getBasicOverposterLayerProperties in interface ILabelStyle2

Returns:

A reference to a com.esri.arcgis.carto.IBasicOverposterLayerProperties

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOverposterLayerPropertiesByRef

public void setOverposterLayerPropertiesByRef(IOverposterLayerProperties props)
                                       throws IOException,
                                              AutomationException

The overposter properties, which specify how labels are placed relative to features.

Product Availability

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

Specified by:

setOverposterLayerPropertiesByRef in interface ILabelStyle2

Parameters:

props - A reference to a com.esri.arcgis.carto.IOverposterLayerProperties (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOverposterLayerProperties

public IOverposterLayerProperties getOverposterLayerProperties()
                                                        throws IOException,
                                                               AutomationException

The overposter properties, which specify how labels are placed relative to features.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getOverposterLayerProperties in interface ILabelStyle2

Returns:

A reference to a com.esri.arcgis.carto.IOverposterLayerProperties

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.

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.

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