com.esri.arcgis.schematic
Interface ISchematicAlgoLabelPlacementOptimizer

All Superinterfaces:

Serializable

All Known Implementing Classes:

ISchematicAlgoLabelPlacementOptimizerProxy, SchematicAlgoLabelPlacementOptimizer

public interface ISchematicAlgoLabelPlacementOptimizer
extends Serializable

Provides access to members that control the Label Placement Optimizer schematic algorithm.

Description

This interface is new at ArcGIS 9.3.

Product Availability

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

Method Summary

void	execute(INgDiagram pDiag) Executes the Label Placement Optimizer schematic algorithm in the specified graphic diagram.
int	getAboveCenter() Define the priority of position Above Center of a node label.
int	getAboveLeft() Define the priority of position Above Left of a node label.
int	getAboveRight() Define the priority of position Above Right of a node label.
int	getBelowCenter() Define the priority of position Below Center of a node label.
int	getBelowLeft() Define the priority of position Below Left of a node label.
int	getBelowRight() Define the priority of position Below Right of a node label.
int	getCenterCenter() Define the priority of position Center Center of a node label.
int	getCenterLeft() Define the priority of position Center Left of a node label.
int	getCenterRight() Define the priority of position Center Right of a node label.
String	getDiagramType() Name of the selected diagram type.
INgProperties	getTextualProperties() List of textual properties to treat.
void	interactiveUpdate(String diagramTypeName, boolean on) Enables the automatical execution of the Label Placement Optimizer algorithm each time the graphic elements contained in any diagram implemented by the specified graphic diagram type are moved.
void	interactiveUpdateByDiagram(String diagramTypeName, String diagramName, boolean on) Enables the automatical execution of the Label Placement Optimizer algorithm each time the graphic elements contained in the specified diagram implemented by the specified graphic diagram type are moved.
boolean	isInteractiveUpdate(String diagramTypeName) Indicates if the Label Placement Optimizer algorithm must be automatically applied each time the graphic elements contained in any diagram implemented by the specified graphic diagram type are moved.
boolean	isInteractiveUpdateByDiagram(String diagramTypeName, String diagramName) Indicates if the Label Placement Optimizer algorithm must be automatically applied each time the graphic elements contained in the specified diagram implemented by the specified graphic diagram type are moved.
boolean	isInteractiveUpdateStatus() Indicates if the Automatically applied option is currently checked in the Label Placement Optimizer algorithm algorithm properties tab.
boolean	isLabelPortPriorities() Indicates whether the label placement is driven by the label port numbers or by placement priorities.
void	setAboveCenter(int plVal) Define the priority of position Above Center of a node label.
void	setAboveLeft(int plVal) Define the priority of position Above Left of a node label.
void	setAboveRight(int plVal) Define the priority of position Above Right of a node label.
void	setBelowCenter(int plVal) Define the priority of position Below Center of a node label.
void	setBelowLeft(int plVal) Define the priority of position Below Left of a node label.
void	setBelowRight(int plVal) Define the priority of position Below Right of a node label.
void	setCenterCenter(int plVal) Define the priority of position Center Center of a node label.
void	setCenterLeft(int plVal) Define the priority of position Center Left of a node label.
void	setCenterRight(int plVal) Define the priority of position Center Right of a node label.
void	setDiagramType(String pDiagramTypeName) Name of the selected diagram type.
void	setInteractiveUpdateStatus(boolean bStatus) Indicates if the Automatically applied option is currently checked in the Label Placement Optimizer algorithm algorithm properties tab.
void	setLabelPortPriorities(boolean pVal) Indicates whether the label placement is driven by the label port numbers or by placement priorities.
void	setTextualProperties(INgProperties ppLabelArray) List of textual properties to treat.

Method Detail

execute

void execute(INgDiagram pDiag)
             throws IOException,
                    AutomationException

Executes the Label Placement Optimizer schematic algorithm in the specified graphic diagram.

Product Availability

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

Parameters:

pDiag - A reference to a com.esri.arcgis.schematic.INgDiagram (in, optional, pass 0 if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interactiveUpdate

void interactiveUpdate(String diagramTypeName,
                       boolean on)
                       throws IOException,
                              AutomationException

Enables the automatical execution of the Label Placement Optimizer algorithm each time the graphic elements contained in any diagram implemented by the specified graphic diagram type are moved.

Product Availability

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

Parameters:

diagramTypeName - The diagramTypeName (in, optional, pass if not required)

on - The on (in, optional, pass true if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interactiveUpdateByDiagram

void interactiveUpdateByDiagram(String diagramTypeName,
                                String diagramName,
                                boolean on)
                                throws IOException,
                                       AutomationException

Enables the automatical execution of the Label Placement Optimizer algorithm each time the graphic elements contained in the specified diagram implemented by the specified graphic diagram type are moved.

Product Availability

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

Parameters:

diagramTypeName - The diagramTypeName (in)

diagramName - The diagramName (in)

on - The on (in, optional, pass true if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isInteractiveUpdate

boolean isInteractiveUpdate(String diagramTypeName)
                            throws IOException,
                                   AutomationException

Indicates if the Label Placement Optimizer algorithm must be automatically applied each time the graphic elements contained in any diagram implemented by the specified graphic diagram type are moved.

Product Availability

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

Parameters:

diagramTypeName - The diagramTypeName (in)

Returns:

The on

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isInteractiveUpdateByDiagram

boolean isInteractiveUpdateByDiagram(String diagramTypeName,
                                     String diagramName)
                                     throws IOException,
                                            AutomationException

Indicates if the Label Placement Optimizer algorithm must be automatically applied each time the graphic elements contained in the specified diagram implemented by the specified graphic diagram type are moved.

Product Availability

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

Parameters:

diagramTypeName - The diagramTypeName (in)

diagramName - The diagramName (in)

Returns:

The on

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInteractiveUpdateStatus

void setInteractiveUpdateStatus(boolean bStatus)
                                throws IOException,
                                       AutomationException

Indicates if the Automatically applied option is currently checked in the Label Placement Optimizer algorithm algorithm properties tab.

Product Availability

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

Parameters:

bStatus - The bStatus (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isInteractiveUpdateStatus

boolean isInteractiveUpdateStatus()
                                  throws IOException,
                                         AutomationException

Indicates if the Automatically applied option is currently checked in the Label Placement Optimizer algorithm algorithm properties tab.

Product Availability

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

Returns:

The bStatus

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelPortPriorities

void setLabelPortPriorities(boolean pVal)
                            throws IOException,
                                   AutomationException

Indicates whether the label placement is driven by the label port numbers or by placement priorities.

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLabelPortPriorities

boolean isLabelPortPriorities()
                              throws IOException,
                                     AutomationException

Indicates whether the label placement is driven by the label port numbers or by placement priorities.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAboveLeft

void setAboveLeft(int plVal)
                  throws IOException,
                         AutomationException

Define the priority of position Above Left of a node label.

Product Availability

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

Parameters:

plVal - The plVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAboveLeft

int getAboveLeft()
                 throws IOException,
                        AutomationException

Define the priority of position Above Left of a node label.

Product Availability

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

Returns:

The plVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAboveCenter

void setAboveCenter(int plVal)
                    throws IOException,
                           AutomationException

Define the priority of position Above Center of a node label.

Product Availability

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

Parameters:

plVal - The plVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAboveCenter

int getAboveCenter()
                   throws IOException,
                          AutomationException

Define the priority of position Above Center of a node label.

Product Availability

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

Returns:

The plVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAboveRight

void setAboveRight(int plVal)
                   throws IOException,
                          AutomationException

Define the priority of position Above Right of a node label.

Product Availability

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

Parameters:

plVal - The plVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAboveRight

int getAboveRight()
                  throws IOException,
                         AutomationException

Define the priority of position Above Right of a node label.

Product Availability

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

Returns:

The plVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCenterLeft

void setCenterLeft(int plVal)
                   throws IOException,
                          AutomationException

Define the priority of position Center Left of a node label.

Product Availability

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

Parameters:

plVal - The plVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCenterLeft

int getCenterLeft()
                  throws IOException,
                         AutomationException

Define the priority of position Center Left of a node label.

Product Availability

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

Returns:

The plVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCenterRight

void setCenterRight(int plVal)
                    throws IOException,
                           AutomationException

Define the priority of position Center Right of a node label.

Product Availability

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

Parameters:

plVal - The plVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCenterRight

int getCenterRight()
                   throws IOException,
                          AutomationException

Define the priority of position Center Right of a node label.

Product Availability

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

Returns:

The plVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBelowLeft

void setBelowLeft(int plVal)
                  throws IOException,
                         AutomationException

Define the priority of position Below Left of a node label.

Product Availability

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

Parameters:

plVal - The plVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBelowLeft

int getBelowLeft()
                 throws IOException,
                        AutomationException

Define the priority of position Below Left of a node label.

Product Availability

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

Returns:

The plVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBelowCenter

void setBelowCenter(int plVal)
                    throws IOException,
                           AutomationException

Define the priority of position Below Center of a node label.

Product Availability

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

Parameters:

plVal - The plVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBelowCenter

int getBelowCenter()
                   throws IOException,
                          AutomationException

Define the priority of position Below Center of a node label.

Product Availability

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

Returns:

The plVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBelowRight

void setBelowRight(int plVal)
                   throws IOException,
                          AutomationException

Define the priority of position Below Right of a node label.

Product Availability

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

Parameters:

plVal - The plVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBelowRight

int getBelowRight()
                  throws IOException,
                         AutomationException

Define the priority of position Below Right of a node label.

Product Availability

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

Returns:

The plVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextualProperties

void setTextualProperties(INgProperties ppLabelArray)
                          throws IOException,
                                 AutomationException

List of textual properties to treat.

Product Availability

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

Parameters:

ppLabelArray - A reference to a com.esri.arcgis.schematic.INgProperties (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextualProperties

INgProperties getTextualProperties()
                                   throws IOException,
                                          AutomationException

List of textual properties to treat.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.schematic.INgProperties

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDiagramType

void setDiagramType(String pDiagramTypeName)
                    throws IOException,
                           AutomationException

Name of the selected diagram type.

Product Availability

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

Parameters:

pDiagramTypeName - The pDiagramTypeName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDiagramType

String getDiagramType()
                      throws IOException,
                             AutomationException

Name of the selected diagram type.

Product Availability

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

Returns:

The pDiagramTypeName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCenterCenter

void setCenterCenter(int plVal)
                     throws IOException,
                            AutomationException

Define the priority of position Center Center of a node label.

Product Availability

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

Parameters:

plVal - The plVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCenterCenter

int getCenterCenter()
                    throws IOException,
                           AutomationException

Define the priority of position Center Center of a node label.

Product Availability

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

Returns:

The plVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.