com.esri.arcgis.schematic
Class ISchematicAlgoLabelPlacementOptimizerProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.schematic.ISchematicAlgoLabelPlacementOptimizerProxy

All Implemented Interfaces:

ISchematicAlgoLabelPlacementOptimizer, Externalizable, Serializable

public class ISchematicAlgoLabelPlacementOptimizerProxy
extends com.esri.arcgis.interop.Dispatch
implements ISchematicAlgoLabelPlacementOptimizer, 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.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E

Constructor Summary

	ISchematicAlgoLabelPlacementOptimizerProxy()
	ISchematicAlgoLabelPlacementOptimizerProxy(Object obj)
protected	ISchematicAlgoLabelPlacementOptimizerProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
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	readExternal(ObjectInput in)
void	removeListener(String iidStr, Object theListener)
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.
void	writeExternal(ObjectOutput out)

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ISchematicAlgoLabelPlacementOptimizerProxy

public ISchematicAlgoLabelPlacementOptimizerProxy()

ISchematicAlgoLabelPlacementOptimizerProxy

public ISchematicAlgoLabelPlacementOptimizerProxy(Object obj)
                                           throws IOException

Throws:

IOException

ISchematicAlgoLabelPlacementOptimizerProxy

protected ISchematicAlgoLabelPlacementOptimizerProxy(Object obj,
                                                     String iid)
                                              throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

execute

public 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.

Specified by:

execute in interface ISchematicAlgoLabelPlacementOptimizer

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

public 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.

Specified by:

interactiveUpdate in interface ISchematicAlgoLabelPlacementOptimizer

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

public 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.

Specified by:

interactiveUpdateByDiagram in interface ISchematicAlgoLabelPlacementOptimizer

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

public 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.

Specified by:

isInteractiveUpdate in interface ISchematicAlgoLabelPlacementOptimizer

Parameters:

diagramTypeName - The diagramTypeName (in)

Returns:

The on

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isInteractiveUpdateByDiagram

public 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.

Specified by:

isInteractiveUpdateByDiagram in interface ISchematicAlgoLabelPlacementOptimizer

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

public 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.

Specified by:

setInteractiveUpdateStatus in interface ISchematicAlgoLabelPlacementOptimizer

Parameters:

bStatus - The bStatus (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isInteractiveUpdateStatus

public 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.

Specified by:

isInteractiveUpdateStatus in interface ISchematicAlgoLabelPlacementOptimizer

Returns:

The bStatus

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelPortPriorities

public 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.

Specified by:

setLabelPortPriorities in interface ISchematicAlgoLabelPlacementOptimizer

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLabelPortPriorities

public 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.

Specified by:

isLabelPortPriorities in interface ISchematicAlgoLabelPlacementOptimizer

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAboveLeft

public 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.

Specified by:

setAboveLeft in interface ISchematicAlgoLabelPlacementOptimizer

Parameters:

plVal - The plVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAboveLeft

public 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.

Specified by:

getAboveLeft in interface ISchematicAlgoLabelPlacementOptimizer

Returns:

The plVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAboveCenter

public 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.

Specified by:

setAboveCenter in interface ISchematicAlgoLabelPlacementOptimizer

Parameters:

plVal - The plVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAboveCenter

public 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.

Specified by:

getAboveCenter in interface ISchematicAlgoLabelPlacementOptimizer

Returns:

The plVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAboveRight

public 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.

Specified by:

setAboveRight in interface ISchematicAlgoLabelPlacementOptimizer

Parameters:

plVal - The plVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAboveRight

public 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.

Specified by:

getAboveRight in interface ISchematicAlgoLabelPlacementOptimizer

Returns:

The plVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCenterLeft

public 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.

Specified by:

setCenterLeft in interface ISchematicAlgoLabelPlacementOptimizer

Parameters:

plVal - The plVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCenterLeft

public 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.

Specified by:

getCenterLeft in interface ISchematicAlgoLabelPlacementOptimizer

Returns:

The plVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCenterRight

public 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.

Specified by:

setCenterRight in interface ISchematicAlgoLabelPlacementOptimizer

Parameters:

plVal - The plVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCenterRight

public 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.

Specified by:

getCenterRight in interface ISchematicAlgoLabelPlacementOptimizer

Returns:

The plVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBelowLeft

public 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.

Specified by:

setBelowLeft in interface ISchematicAlgoLabelPlacementOptimizer

Parameters:

plVal - The plVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBelowLeft

public 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.

Specified by:

getBelowLeft in interface ISchematicAlgoLabelPlacementOptimizer

Returns:

The plVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBelowCenter

public 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.

Specified by:

setBelowCenter in interface ISchematicAlgoLabelPlacementOptimizer

Parameters:

plVal - The plVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBelowCenter

public 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.

Specified by:

getBelowCenter in interface ISchematicAlgoLabelPlacementOptimizer

Returns:

The plVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBelowRight

public 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.

Specified by:

setBelowRight in interface ISchematicAlgoLabelPlacementOptimizer

Parameters:

plVal - The plVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBelowRight

public 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.

Specified by:

getBelowRight in interface ISchematicAlgoLabelPlacementOptimizer

Returns:

The plVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextualProperties

public void setTextualProperties(INgProperties ppLabelArray)
                          throws IOException,
                                 AutomationException

List of textual properties to treat.

Product Availability

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

Specified by:

setTextualProperties in interface ISchematicAlgoLabelPlacementOptimizer

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

public INgProperties getTextualProperties()
                                   throws IOException,
                                          AutomationException

List of textual properties to treat.

Product Availability

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

Specified by:

getTextualProperties in interface ISchematicAlgoLabelPlacementOptimizer

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

public void setDiagramType(String pDiagramTypeName)
                    throws IOException,
                           AutomationException

Name of the selected diagram type.

Product Availability

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

Specified by:

setDiagramType in interface ISchematicAlgoLabelPlacementOptimizer

Parameters:

pDiagramTypeName - The pDiagramTypeName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDiagramType

public String getDiagramType()
                      throws IOException,
                             AutomationException

Name of the selected diagram type.

Product Availability

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

Specified by:

getDiagramType in interface ISchematicAlgoLabelPlacementOptimizer

Returns:

The pDiagramTypeName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCenterCenter

public 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.

Specified by:

setCenterCenter in interface ISchematicAlgoLabelPlacementOptimizer

Parameters:

plVal - The plVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCenterCenter

public 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.

Specified by:

getCenterCenter in interface ISchematicAlgoLabelPlacementOptimizer

Returns:

The plVal

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

Overrides:

writeExternal in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

ClassNotFoundException