com.esri.arcgis.carto
Class LineLabelPosition

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

All Implemented Interfaces:

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

public class LineLabelPosition
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ILineLabelPosition, IPersist, IPersistStream, IClone, Externalizable

Controls the relative positions of line labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

LineLabelPosition()
Constructs a LineLabelPosition using ArcGIS Engine.

LineLabelPosition(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
LineLabelPosition theLineLabelPosition = (LineLabelPosition) 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	getOffset() Offset from the start/end of lines (in map units).
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
boolean	isAbove() Indicates if labels are placed above lines.
boolean	isAtEnd() Indicates if labels are placed at the end of lines.
boolean	isAtStart() Indicates if labels are placed at the start of lines.
boolean	isBelow() Indicates if labels are placed below lines.
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isHorizontal() Indicates if labels are placed horizontally.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isInLine() Indicates if labels are placed along lines at the best position.
boolean	isLeft() Indicates if labels are placed to the left of lines.
boolean	isOnTop() Indicates if labels are placed on top of lines.
boolean	isParallel() Indicates if labels are placed parallel to lines.
boolean	isPerpendicular() Indicates if labels are placed perpendicular to lines.
boolean	isProduceCurvedLabels() Indicates if labels follow lines.
boolean	isRight() Indicates if labels are placed to the right of lines.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	setAbove(boolean flag) Indicates if labels are placed above lines.
void	setAtEnd(boolean flag) Indicates if labels are placed at the end of lines.
void	setAtStart(boolean flag) Indicates if labels are placed at the start of lines.
void	setBelow(boolean flag) Indicates if labels are placed below lines.
void	setHorizontal(boolean flag) Indicates if labels are placed horizontally.
void	setInLine(boolean flag) Indicates if labels are placed along lines at the best position.
void	setLeft(boolean flag) Indicates if labels are placed to the left of lines.
void	setOffset(double offset) Offset from the start/end of lines (in map units).
void	setOnTop(boolean flag) Indicates if labels are placed on top of lines.
void	setParallel(boolean flag) Indicates if labels are placed parallel to lines.
void	setPerpendicular(boolean flag) Indicates if labels are placed perpendicular to lines.
void	setProduceCurvedLabels(boolean flag) Indicates if labels follow lines.
void	setRight(boolean flag) Indicates if labels are placed to the right of lines.
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

LineLabelPosition

public LineLabelPosition()
                  throws IOException,
                         UnknownHostException

Constructs a LineLabelPosition using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

LineLabelPosition

public LineLabelPosition(Object obj)
                  throws IOException

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

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

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

isProduceCurvedLabels

public boolean isProduceCurvedLabels()
                              throws IOException,
                                     AutomationException

Indicates if labels follow lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isProduceCurvedLabels in interface ILineLabelPosition

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProduceCurvedLabels

public void setProduceCurvedLabels(boolean flag)
                            throws IOException,
                                   AutomationException

Indicates if labels follow lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setProduceCurvedLabels in interface ILineLabelPosition

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAbove

public boolean isAbove()
                throws IOException,
                       AutomationException

Indicates if labels are placed above lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isAbove in interface ILineLabelPosition

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAbove

public void setAbove(boolean flag)
              throws IOException,
                     AutomationException

Indicates if labels are placed above lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAbove in interface ILineLabelPosition

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBelow

public boolean isBelow()
                throws IOException,
                       AutomationException

Indicates if labels are placed below lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isBelow in interface ILineLabelPosition

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBelow

public void setBelow(boolean flag)
              throws IOException,
                     AutomationException

Indicates if labels are placed below lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBelow in interface ILineLabelPosition

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isOnTop

public boolean isOnTop()
                throws IOException,
                       AutomationException

Indicates if labels are placed on top of lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isOnTop in interface ILineLabelPosition

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOnTop

public void setOnTop(boolean flag)
              throws IOException,
                     AutomationException

Indicates if labels are placed on top of lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setOnTop in interface ILineLabelPosition

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLeft

public boolean isLeft()
               throws IOException,
                      AutomationException

Indicates if labels are placed to the left of lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isLeft in interface ILineLabelPosition

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLeft

public void setLeft(boolean flag)
             throws IOException,
                    AutomationException

Indicates if labels are placed to the left of lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLeft in interface ILineLabelPosition

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRight

public boolean isRight()
                throws IOException,
                       AutomationException

Indicates if labels are placed to the right of lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isRight in interface ILineLabelPosition

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRight

public void setRight(boolean flag)
              throws IOException,
                     AutomationException

Indicates if labels are placed to the right of lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRight in interface ILineLabelPosition

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isInLine

public boolean isInLine()
                 throws IOException,
                        AutomationException

Indicates if labels are placed along lines at the best position.

Remarks

If True then each label is placed along its line feature at the best position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isInLine in interface ILineLabelPosition

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInLine

public void setInLine(boolean flag)
               throws IOException,
                      AutomationException

Indicates if labels are placed along lines at the best position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setInLine in interface ILineLabelPosition

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAtStart

public boolean isAtStart()
                  throws IOException,
                         AutomationException

Indicates if labels are placed at the start of lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isAtStart in interface ILineLabelPosition

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAtStart

public void setAtStart(boolean flag)
                throws IOException,
                       AutomationException

Indicates if labels are placed at the start of lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAtStart in interface ILineLabelPosition

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAtEnd

public boolean isAtEnd()
                throws IOException,
                       AutomationException

Indicates if labels are placed at the end of lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isAtEnd in interface ILineLabelPosition

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAtEnd

public void setAtEnd(boolean flag)
              throws IOException,
                     AutomationException

Indicates if labels are placed at the end of lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAtEnd in interface ILineLabelPosition

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isParallel

public boolean isParallel()
                   throws IOException,
                          AutomationException

Indicates if labels are placed parallel to lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isParallel in interface ILineLabelPosition

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParallel

public void setParallel(boolean flag)
                 throws IOException,
                        AutomationException

Indicates if labels are placed parallel to lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setParallel in interface ILineLabelPosition

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPerpendicular

public boolean isPerpendicular()
                        throws IOException,
                               AutomationException

Indicates if labels are placed perpendicular to lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isPerpendicular in interface ILineLabelPosition

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPerpendicular

public void setPerpendicular(boolean flag)
                      throws IOException,
                             AutomationException

Indicates if labels are placed perpendicular to lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPerpendicular in interface ILineLabelPosition

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHorizontal

public boolean isHorizontal()
                     throws IOException,
                            AutomationException

Indicates if labels are placed horizontally.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isHorizontal in interface ILineLabelPosition

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHorizontal

public void setHorizontal(boolean flag)
                   throws IOException,
                          AutomationException

Indicates if labels are placed horizontally.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setHorizontal in interface ILineLabelPosition

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOffset

public double getOffset()
                 throws IOException,
                        AutomationException

Offset from the start/end of lines (in map units).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getOffset in interface ILineLabelPosition

Returns:

The offset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOffset

public void setOffset(double offset)
               throws IOException,
                      AutomationException

Offset from the start/end of lines (in map units).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setOffset in interface ILineLabelPosition

Parameters:

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