com.esri.arcgis.carto
Class MaplexOffsetAlongLineProperties

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

public class MaplexOffsetAlongLineProperties
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IMaplexOffsetAlongLineProperties, IPersistStream, IClone, Externalizable

Properties that specify the offset along line rules.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
MaplexOffsetAlongLineProperties()
          Constructs a MaplexOffsetAlongLineProperties using ArcGIS Engine.
MaplexOffsetAlongLineProperties(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MaplexOffsetAlongLineProperties theMaplexOffsetAlongLineProperties = (MaplexOffsetAlongLineProperties) 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.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 double getDistance()
          Distance along the line.
 int getDistanceUnit()
          The distance and tolerance are interpreted to be in this unit.
 int getLabelAnchorPoint()
          Anchor point on label where distance is measured to.
 int getPlacementMethod()
          Method of placing label along the line.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 double getTolerance()
          Tolerance either side of the specified position.
 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.
 boolean isUseLineDirection()
          Indicates whether to preserve the direction of line.
 void load(IStream pstm)
          load
 void readExternal(ObjectInput in)
           
 void save(IStream pstm, int fClearDirty)
          save
 void setDistance(double distance)
          Distance along the line.
 void setDistanceUnit(int unit)
          The distance and tolerance are interpreted to be in this unit.
 void setLabelAnchorPoint(int option)
          Anchor point on label where distance is measured to.
 void setPlacementMethod(int option)
          Method of placing label along the line.
 void setTolerance(double distance)
          Tolerance either side of the specified position.
 void setUseLineDirection(boolean flag)
          Indicates whether to preserve the direction of line.
 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

MaplexOffsetAlongLineProperties

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

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

MaplexOffsetAlongLineProperties

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

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

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

getPlacementMethod

public int getPlacementMethod()
                       throws IOException,
                              AutomationException
Method of placing label along the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getPlacementMethod in interface IMaplexOffsetAlongLineProperties
Returns:
A com.esri.arcgis.carto.esriMaplexOffsetAlongLineMethod constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPlacementMethod

public void setPlacementMethod(int option)
                        throws IOException,
                               AutomationException
Method of placing label along the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setPlacementMethod in interface IMaplexOffsetAlongLineProperties
Parameters:
option - A com.esri.arcgis.carto.esriMaplexOffsetAlongLineMethod constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabelAnchorPoint

public int getLabelAnchorPoint()
                        throws IOException,
                               AutomationException
Anchor point on label where distance is measured to.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLabelAnchorPoint in interface IMaplexOffsetAlongLineProperties
Returns:
A com.esri.arcgis.carto.esriMaplexLabelAnchorPoint constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabelAnchorPoint

public void setLabelAnchorPoint(int option)
                         throws IOException,
                                AutomationException
Anchor point on label where distance is measured to.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setLabelAnchorPoint in interface IMaplexOffsetAlongLineProperties
Parameters:
option - A com.esri.arcgis.carto.esriMaplexLabelAnchorPoint constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDistance

public double getDistance()
                   throws IOException,
                          AutomationException
Distance along the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDistance in interface IMaplexOffsetAlongLineProperties
Returns:
The distance
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDistance

public void setDistance(double distance)
                 throws IOException,
                        AutomationException
Distance along the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getTolerance

public double getTolerance()
                    throws IOException,
                           AutomationException
Tolerance either side of the specified position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getTolerance in interface IMaplexOffsetAlongLineProperties
Returns:
The distance
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTolerance

public void setTolerance(double distance)
                  throws IOException,
                         AutomationException
Tolerance either side of the specified position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getDistanceUnit

public int getDistanceUnit()
                    throws IOException,
                           AutomationException
The distance and tolerance are interpreted to be in this unit.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDistanceUnit in interface IMaplexOffsetAlongLineProperties
Returns:
A com.esri.arcgis.carto.esriMaplexUnit constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDistanceUnit

public void setDistanceUnit(int unit)
                     throws IOException,
                            AutomationException
The distance and tolerance are interpreted to be in this unit.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDistanceUnit in interface IMaplexOffsetAlongLineProperties
Parameters:
unit - A com.esri.arcgis.carto.esriMaplexUnit constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseLineDirection

public boolean isUseLineDirection()
                           throws IOException,
                                  AutomationException
Indicates whether to preserve the direction of line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isUseLineDirection in interface IMaplexOffsetAlongLineProperties
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseLineDirection

public void setUseLineDirection(boolean flag)
                         throws IOException,
                                AutomationException
Indicates whether to preserve the direction of line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setUseLineDirection in interface IMaplexOffsetAlongLineProperties
Parameters:
flag - The flag (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
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