com.esri.arcgis.schematiccontrols
Class ISchematicBuilderUIProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.schematiccontrols.ISchematicBuilderUIProxy
All Implemented Interfaces:
ISchematicBuilderUI, Externalizable, Serializable

public class ISchematicBuilderUIProxy
extends com.esri.arcgis.interop.Dispatch
implements ISchematicBuilderUI, Serializable

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

See Also:
Serialized Form

Field Summary
 boolean noncastable
           
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef
 
Constructor Summary
  ISchematicBuilderUIProxy()
           
  ISchematicBuilderUIProxy(Object obj)
           
protected ISchematicBuilderUIProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 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 removeListener(String iidStr, Object theListener)
           
 void setObject(ISchematicDiagramClass pSchematicDiagramClass, Object hook, ISchematicCreateDiagramDialog pDiagramDialog)
          Supplies the builder UI with the diagram class, the application and the create diagram dialog.
 
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, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

noncastable

public boolean noncastable
Constructor Detail

ISchematicBuilderUIProxy

public ISchematicBuilderUIProxy()

ISchematicBuilderUIProxy

public ISchematicBuilderUIProxy(Object obj)
                         throws IOException
Throws:
IOException

ISchematicBuilderUIProxy

protected ISchematicBuilderUIProxy(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

applies

public boolean applies(ISchematicDiagramClass pSchematicDiagramClass)
                throws IOException,
                       AutomationException
Indicates if the UI applies to the specified diagram class.

Specified by:
applies in interface ISchematicBuilderUI
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

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

Specified by:
setObject in interface ISchematicBuilderUI
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

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

Specified by:
getHWnd in interface ISchematicBuilderUI
Returns:
The pHWND (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

oKEnabled

public boolean oKEnabled()
                  throws IOException,
                         AutomationException
Indicates if the OK button is enabled.

Specified by:
oKEnabled in interface ISchematicBuilderUI
Returns:
The pOK
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

oKValid

public boolean oKValid()
                throws IOException,
                       AutomationException
Indicates if all parameters are valid. Called when the OK button is pressed.

Specified by:
oKValid in interface ISchematicBuilderUI
Returns:
The pOK
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.