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, java.io.Externalizable, java.io.Serializable

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

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

Description 'An object that controls label symbol and placement properties.' 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

static long

serialVersionUID

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

IID, IID4c90de7a_cb77_11d2_9f34_00c04f6bc6a5, xxDummy

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

IID, IID3178ec81_a0a5_4cf0_b055_11dea12edc28, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

Constructor Summary

LabelStyle()
Constructs a LabelStyle using ArcGIS Engine.

LabelStyle(java.lang.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(java.lang.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 java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
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(java.io.ObjectInput in)
void	release() Release a LabelStyle.
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(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

LabelStyle

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

Constructs a LabelStyle using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

LabelStyle

public LabelStyle(java.lang.Object obj)
           throws java.io.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:

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

Specified by:

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

setSymbolByRef

public void setSymbolByRef(ITextSymbol textSymbol)
                    throws java.io.IOException,
                           AutomationException

The text symbol used to draw the label.

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:

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

AutomationException - If the ArcObject component throws an exception.

getSymbol

public ITextSymbol getSymbol()
                      throws java.io.IOException,
                             AutomationException

The text symbol used to draw the label.

Specified by:

getSymbol in interface ILabelStyle

Specified by:

getSymbol in interface ILabelStyle2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBasicOverposterLayerPropertiesByRef

public void setBasicOverposterLayerPropertiesByRef(IBasicOverposterLayerProperties props)
                                            throws java.io.IOException,
                                                   AutomationException

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

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:

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

AutomationException - If the ArcObject component throws an exception.

getBasicOverposterLayerProperties

public IBasicOverposterLayerProperties getBasicOverposterLayerProperties()
                                                                  throws java.io.IOException,
                                                                         AutomationException

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

Specified by:

getBasicOverposterLayerProperties in interface ILabelStyle

Specified by:

getBasicOverposterLayerProperties in interface ILabelStyle2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOverposterLayerPropertiesByRef

public void setOverposterLayerPropertiesByRef(IOverposterLayerProperties props)
                                       throws java.io.IOException,
                                              AutomationException

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

Specified by:

setOverposterLayerPropertiesByRef in interface ILabelStyle2

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOverposterLayerProperties

public IOverposterLayerProperties getOverposterLayerProperties()
                                                        throws java.io.IOException,
                                                               AutomationException

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

Specified by:

getOverposterLayerProperties in interface ILabelStyle2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

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

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

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

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException