com.esri.arcgis.carto
Class MaplexRotationProperties

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

All Implemented Interfaces:

IMaplexRotationProperties, IMaplexRotationProperties2, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, Externalizable, Serializable

public class MaplexRotationProperties
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IMaplexRotationProperties, IMaplexRotationProperties2, IPersistStream, IClone, Externalizable

Properties that specify the label rotation rules.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

MaplexRotationProperties()
Constructs a MaplexRotationProperties using ArcGIS Engine.

MaplexRotationProperties(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MaplexRotationProperties theMaplexRotationProperties = (MaplexRotationProperties) 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	getAdditionalAngle() Additional angle to add to the value obtained from the field.
int	getAlignmentType() Defines alignment options for a rotated label.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
String	getRotationField() The attribute field that contains the label angle.
int	getRotationType() Defines the format the rotation field in.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
boolean	isAlignLabelToAngle() Indicates whether to draw the label aligned to the angle (no flip).
void	isDirty() isDirty
boolean	isEnable() Indicates whether to rotate a label by attribute.
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	isPerpendicularToAngle() Indicates whether to draw the label perpendicular to the angle.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	setAdditionalAngle(int value) Additional angle to add to the value obtained from the field.
void	setAlignLabelToAngle(boolean flag) Indicates whether to draw the label aligned to the angle (no flip).
void	setAlignmentType(int type) Defines alignment options for a rotated label.
void	setEnable(boolean flag) Indicates whether to rotate a label by attribute.
void	setPerpendicularToAngle(boolean flag) Indicates whether to draw the label perpendicular to the angle.
void	setRotationField(String field) The attribute field that contains the label angle.
void	setRotationType(int type) Defines the format the rotation field in.
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

MaplexRotationProperties

public MaplexRotationProperties()
                         throws IOException,
                                UnknownHostException

Constructs a MaplexRotationProperties using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

MaplexRotationProperties

public MaplexRotationProperties(Object obj)
                         throws IOException

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

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

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

isEnable

public boolean isEnable()
                 throws IOException,
                        AutomationException

Indicates whether to rotate a label by attribute.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEnable in interface IMaplexRotationProperties

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnable

public void setEnable(boolean flag)
               throws IOException,
                      AutomationException

Indicates whether to rotate a label by attribute.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setEnable in interface IMaplexRotationProperties

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRotationType

public int getRotationType()
                    throws IOException,
                           AutomationException

Defines the format the rotation field in.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getRotationType in interface IMaplexRotationProperties

Returns:

A com.esri.arcgis.carto.esriLabelRotationType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRotationType

public void setRotationType(int type)
                     throws IOException,
                            AutomationException

Defines the format the rotation field in.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRotationType in interface IMaplexRotationProperties

Parameters:

type - A com.esri.arcgis.carto.esriLabelRotationType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRotationField

public String getRotationField()
                        throws IOException,
                               AutomationException

The attribute field that contains the label angle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getRotationField in interface IMaplexRotationProperties

Returns:

The field

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRotationField

public void setRotationField(String field)
                      throws IOException,
                             AutomationException

The attribute field that contains the label angle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRotationField in interface IMaplexRotationProperties

Parameters:

field - The field (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPerpendicularToAngle

public boolean isPerpendicularToAngle()
                               throws IOException,
                                      AutomationException

Indicates whether to draw the label perpendicular to the angle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isPerpendicularToAngle in interface IMaplexRotationProperties

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPerpendicularToAngle

public void setPerpendicularToAngle(boolean flag)
                             throws IOException,
                                    AutomationException

Indicates whether to draw the label perpendicular to the angle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPerpendicularToAngle in interface IMaplexRotationProperties

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAlignLabelToAngle

public boolean isAlignLabelToAngle()
                            throws IOException,
                                   AutomationException

Indicates whether to draw the label aligned to the angle (no flip).

Product Availability

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

Specified by:

isAlignLabelToAngle in interface IMaplexRotationProperties

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAlignLabelToAngle

public void setAlignLabelToAngle(boolean flag)
                          throws IOException,
                                 AutomationException

Indicates whether to draw the label aligned to the angle (no flip).

Product Availability

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

Specified by:

setAlignLabelToAngle in interface IMaplexRotationProperties

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAlignmentType

public int getAlignmentType()
                     throws IOException,
                            AutomationException

Defines alignment options for a rotated label.

Product Availability

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

Specified by:

getAlignmentType in interface IMaplexRotationProperties2

Returns:

A com.esri.arcgis.carto.esriMaplexRotationAlignmentType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAlignmentType

public void setAlignmentType(int type)
                      throws IOException,
                             AutomationException

Defines alignment options for a rotated label.

Product Availability

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

Specified by:

setAlignmentType in interface IMaplexRotationProperties2

Parameters:

type - A com.esri.arcgis.carto.esriMaplexRotationAlignmentType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAdditionalAngle

public int getAdditionalAngle()
                       throws IOException,
                              AutomationException

Additional angle to add to the value obtained from the field.

Product Availability

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

Specified by:

getAdditionalAngle in interface IMaplexRotationProperties2

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAdditionalAngle

public void setAdditionalAngle(int value)
                        throws IOException,
                               AutomationException

Additional angle to add to the value obtained from the field.

Product Availability

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

Specified by:

setAdditionalAngle in interface IMaplexRotationProperties2

Parameters:

value - The value (in)

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