com.esri.arcgis.carto
Interface IACLineLabelPosition

All Superinterfaces:
Serializable
All Known Implementing Classes:
IACLineLabelPositionProxy

public interface IACLineLabelPosition
extends Serializable

Provides access to members that control ArcIMS line label position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 boolean isAbove()
          Indicates whether to place the label above the line.
 boolean isAtEnd()
          Indicates whether to place the label at the end of the line.
 boolean isAtStart()
          Indicates whether to place the label at the start of the line.
 boolean isBelow()
          Indicates whether to place the label below the line.
 boolean isHorizontal()
          Indicates whether to place the label horizontally.
 boolean isInLine()
          Indicates whether to place the label in the line.
 boolean isLeft()
          Indicates whether to place the label left of the line.
 boolean isNone()
          Indicates whether the label should not be placed.
 boolean isOnTop()
          Indicates whether to place the label on top of the line.
 boolean isParallel()
          Indicates whether to place the label parallel to the line.
 boolean isPerpendicular()
          Indicates whether to place the label perpendicular to the line.
 boolean isRight()
          Indicates whether to place the label right of the line.
 void setAbove(boolean flag)
          Indicates whether to place the label above the line.
 void setAtEnd(boolean flag)
          Indicates whether to place the label at the end of the line.
 void setAtStart(boolean flag)
          Indicates whether to place the label at the start of the line.
 void setBelow(boolean flag)
          Indicates whether to place the label below the line.
 void setHorizontal(boolean flag)
          Indicates whether to place the label horizontally.
 void setInLine(boolean flag)
          Indicates whether to place the label in the line.
 void setLeft(boolean flag)
          Indicates whether to place the label left of the line.
 void setNone(boolean flag)
          Indicates whether the label should not be placed.
 void setOnTop(boolean flag)
          Indicates whether to place the label on top of the line.
 void setParallel(boolean flag)
          Indicates whether to place the label parallel to the line.
 void setPerpendicular(boolean flag)
          Indicates whether to place the label perpendicular to the line.
 void setRight(boolean flag)
          Indicates whether to place the label right of the line.
 

Method Detail

isNone

boolean isNone()
               throws IOException,
                      AutomationException
Indicates whether the label should not be placed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNone

void setNone(boolean flag)
             throws IOException,
                    AutomationException
Indicates whether the label should not be placed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAbove

boolean isAbove()
                throws IOException,
                       AutomationException
Indicates whether to place the label above the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAbove

void setAbove(boolean flag)
              throws IOException,
                     AutomationException
Indicates whether to place the label above the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isBelow

boolean isBelow()
                throws IOException,
                       AutomationException
Indicates whether to place the label below the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBelow

void setBelow(boolean flag)
              throws IOException,
                     AutomationException
Indicates whether to place the label below the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isOnTop

boolean isOnTop()
                throws IOException,
                       AutomationException
Indicates whether to place the label on top of the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOnTop

void setOnTop(boolean flag)
              throws IOException,
                     AutomationException
Indicates whether to place the label on top of the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isLeft

boolean isLeft()
               throws IOException,
                      AutomationException
Indicates whether to place the label left of the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLeft

void setLeft(boolean flag)
             throws IOException,
                    AutomationException
Indicates whether to place the label left of the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRight

boolean isRight()
                throws IOException,
                       AutomationException
Indicates whether to place the label right of the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRight

void setRight(boolean flag)
              throws IOException,
                     AutomationException
Indicates whether to place the label right of the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isInLine

boolean isInLine()
                 throws IOException,
                        AutomationException
Indicates whether to place the label in the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setInLine

void setInLine(boolean flag)
               throws IOException,
                      AutomationException
Indicates whether to place the label in the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAtStart

boolean isAtStart()
                  throws IOException,
                         AutomationException
Indicates whether to place the label at the start of the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAtStart

void setAtStart(boolean flag)
                throws IOException,
                       AutomationException
Indicates whether to place the label at the start of the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAtEnd

boolean isAtEnd()
                throws IOException,
                       AutomationException
Indicates whether to place the label at the end of the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAtEnd

void setAtEnd(boolean flag)
              throws IOException,
                     AutomationException
Indicates whether to place the label at the end of the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isParallel

boolean isParallel()
                   throws IOException,
                          AutomationException
Indicates whether to place the label parallel to the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setParallel

void setParallel(boolean flag)
                 throws IOException,
                        AutomationException
Indicates whether to place the label parallel to the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isPerpendicular

boolean isPerpendicular()
                        throws IOException,
                               AutomationException
Indicates whether to place the label perpendicular to the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPerpendicular

void setPerpendicular(boolean flag)
                      throws IOException,
                             AutomationException
Indicates whether to place the label perpendicular to the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isHorizontal

boolean isHorizontal()
                     throws IOException,
                            AutomationException
Indicates whether to place the label horizontally.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHorizontal

void setHorizontal(boolean flag)
                   throws IOException,
                          AutomationException
Indicates whether to place the label horizontally.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.