com.esri.arcgis.schematiccontrols
Interface ISchematicBuilderUI

All Superinterfaces:

Serializable

All Known Implementing Classes:

ISchematicBuilderUIProxy

public interface ISchematicBuilderUI
extends Serializable

Provides access to members that control the schematic builder UI (this interface is only needed for developing a new builder).

Method Summary

boolean	applies(ISchematicDiagramClass pSchematicDiagramClass) Indicates if the UI applies to the specified diagram class.
int	getHWnd() Handle of the window inserted in the diagram dialog box that opens when users ask to generate a new diagram.
boolean	oKEnabled() Indicates if the OK button is enabled.
boolean	oKValid() Indicates if all parameters are valid.
void	setObject(ISchematicDiagramClass pSchematicDiagramClass, Object hook, ISchematicCreateDiagramDialog pDiagramDialog) Supplies the builder UI with the diagram class, the application and the create diagram dialog.

Method Detail

applies

boolean applies(ISchematicDiagramClass pSchematicDiagramClass)
                throws IOException,
                       AutomationException

Indicates if the UI applies to the specified diagram class.

Parameters:

pSchematicDiagramClass - A reference to a com.esri.arcgis.schematic.ISchematicDiagramClass (in)

Returns:

The pApplies

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setObject

void setObject(ISchematicDiagramClass pSchematicDiagramClass,
               Object hook,
               ISchematicCreateDiagramDialog pDiagramDialog)
               throws IOException,
                      AutomationException

Supplies the builder UI with the diagram class, the application and the create diagram dialog.

Parameters:

pSchematicDiagramClass - A reference to a com.esri.arcgis.schematic.ISchematicDiagramClass (in)

hook - A reference to another Automation Object (IDispatch) (in)

pDiagramDialog - A reference to a com.esri.arcgis.schematiccontrols.ISchematicCreateDiagramDialog (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHWnd

int getHWnd()
            throws IOException,
                   AutomationException

Handle of the window inserted in the diagram dialog box that opens when users ask to generate a new diagram.

Returns:

The pHWND (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

oKEnabled

boolean oKEnabled()
                  throws IOException,
                         AutomationException

Indicates if the OK button is enabled.

Returns:

The pOK

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

oKValid

boolean oKValid()
                throws IOException,
                       AutomationException

Indicates if all parameters are valid. Called when the OK button is pressed.

Returns:

The pOK

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.