com.esri.arcgis.carto
Interface IMaplexOverposterProperties

All Superinterfaces:
Serializable
All Known Implementing Classes:
MaplexOverposterProperties

public interface IMaplexOverposterProperties
extends Serializable

Provides access to members that are common to all layers being labeled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 int getConnectionType()
          Provides the option to turn off line connection.
 IMaplexDictionaries getDictionaries()
          Abbreviation dictionaries used by placement.
 int getPlacementQuality()
          The placement quality for text placement.
 boolean isAllowBorderOverlap()
          Indicates whether to allow labels to the cross the map border or not.
 boolean isEnableConnection()
          Indicates whether to turn off line connection.
 boolean isLabelLargestPolygon()
          Indicates whether to label only the largest polygon in a compound polygon feature.
 void setAllowBorderOverlap(boolean flag)
          Indicates whether to allow labels to the cross the map border or not.
 void setConnectionType(int type)
          Provides the option to turn off line connection.
 void setDictionaries(IMaplexDictionaries dictionaries)
          Abbreviation dictionaries used by placement.
 void setEnableConnection(boolean flag)
          Indicates whether to turn off line connection.
 void setLabelLargestPolygon(boolean flag)
          Indicates whether to label only the largest polygon in a compound polygon feature.
 void setPlacementQuality(int quality)
          The placement quality for text placement.
 

Method Detail

getPlacementQuality

int getPlacementQuality()
                        throws IOException,
                               AutomationException
The placement quality for text placement.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.carto.esriMaplexPlacementQuality constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPlacementQuality

void setPlacementQuality(int quality)
                         throws IOException,
                                AutomationException
The placement quality for text placement.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
quality - A com.esri.arcgis.carto.esriMaplexPlacementQuality constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAllowBorderOverlap

boolean isAllowBorderOverlap()
                             throws IOException,
                                    AutomationException
Indicates whether to allow labels to the cross the map border or not.

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.

setAllowBorderOverlap

void setAllowBorderOverlap(boolean flag)
                           throws IOException,
                                  AutomationException
Indicates whether to allow labels to the cross the map border or not.

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.

getDictionaries

IMaplexDictionaries getDictionaries()
                                    throws IOException,
                                           AutomationException
Abbreviation dictionaries used by placement.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.carto.IMaplexDictionaries
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDictionaries

void setDictionaries(IMaplexDictionaries dictionaries)
                     throws IOException,
                            AutomationException
Abbreviation dictionaries used by placement.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
dictionaries - A reference to a com.esri.arcgis.carto.IMaplexDictionaries (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEnableConnection

boolean isEnableConnection()
                           throws IOException,
                                  AutomationException
Indicates whether to turn off line connection.

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.

setEnableConnection

void setEnableConnection(boolean flag)
                         throws IOException,
                                AutomationException
Indicates whether to turn off line connection.

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.

getConnectionType

int getConnectionType()
                      throws IOException,
                             AutomationException
Provides the option to turn off line connection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.carto.esriMaplexConnectionType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setConnectionType

void setConnectionType(int type)
                       throws IOException,
                              AutomationException
Provides the option to turn off line connection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
type - A com.esri.arcgis.carto.esriMaplexConnectionType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isLabelLargestPolygon

boolean isLabelLargestPolygon()
                              throws IOException,
                                     AutomationException
Indicates whether to label only the largest polygon in a compound polygon feature.

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.

setLabelLargestPolygon

void setLabelLargestPolygon(boolean flag)
                            throws IOException,
                                   AutomationException
Indicates whether to label only the largest polygon in a compound polygon feature.

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.