com.esri.arcgis.schematic
Class INgProjectProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.schematic.INgProjectProxy
All Implemented Interfaces:
INgProject, Externalizable, Serializable

public class INgProjectProxy
extends com.esri.arcgis.interop.Dispatch
implements INgProject, Serializable

Provides access to members that control the graphic project.

Description

The project is the core object in your schematic application.

It acts as the central point where access is gained to other schematic components in the system as the data sources, the diagram types, the element type, etc..

Product Availability

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

See Also:
INgProjectViews, INgProjectAnalyst, INgProjectAlgorithm, INgProjectBuilder, INgProjectEvents, Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  INgProjectProxy()
           
  INgProjectProxy(Object obj)
           
protected INgProjectProxy(Object obj, String iid)
           
 
Method Summary
 void addDataSource(INgDataSource dataSource)
          Adds the specified data source into the project.
 void addListener(String iidStr, Object theListener, Object theSource)
           
 void addUserAttributes(Object userAttributes, String attributesSetName)
          Adds the specified attributes set into the project.
 void addUserProcedures(Object userProcedures, String proceduresSetName)
          Adds the specified procedures set into the project.
 void beginWaitCursor()
          Enables the wait cursor.
 void close()
          Closes the currently opened schematic session.
 void endWaitCursor()
          Disables the wait cursor.
 INgView getActiveView()
          Current active view in the project.
 INgDataSource getDataSource(String dataSourceName)
          Returns the datasource named 'dataSourceName'.
 INgDataSources getDataSources()
          List of the datasources defined for the project.
 INgDiagramType getDiagramType(String dgTypeName)
          Returns the diagram type named 'dgTypeName' implemented by the project.
 INgDiagramTypes getDiagramTypes()
          List of the diagram types associated with the project.
 Object getEffect(int effect)
          Returns the effect 'effect' set for the project (see esriNgProjectEffect).
 INgElementType getElementType(String eltTypeName)
          Returns the element type named 'eltTypeName' implemented by the project.
 INgElementTypes getElementTypes()
          List of the element types associated with the project.
 INgFlagModel getFlagModel(String flagModelName)
          Returns the flag model named 'flagModelName' implemented by the project.
 INgFlagModels getFlagModels()
          List of the flag models implemented by the project.
 String getHelpFile()
          Name of the online help file.
 Object getHighlightingEffect(int effect)
          Returns the effect 'effect' used for highlighting the elements when they are selected (see esriNgHighlightingEffectType).
 int getInteractorMode()
          Returns the currently active interaction (see esriNgInteractorMode).
 INgDiagrams getOpenedDiagrams()
          List of the diagrams currently opened in the project.
 INgPatternModel getPatternModel(String patternModelName)
          Returns the pattern model named 'patternModelName' implemented by the project.
 INgPatternModels getPatternModels()
          List of the pattern models implemented by the project.
 String getProjectFileName()
          Full pathname of the '.ini' file used to initialize the project.
 INgElements getSelectedElements()
          List of the elements currently selected in the project.
 INgFlags getSelectedFlags()
          List of the flags currently selected in the project.
 INgSymbol getSymbol(String symbolName)
          Returns the symbol named 'symbolName'.
 INgUserAttributeSets getUserAttributeSets()
          List of the user attibute sets defined for the project.
 INgUserProcedureSets getUserProcedureSets()
          List of the user procedure sets defined for the project.
 void initialize(String fName)
          Initializes the project based on the parameters contained in the file 'fName'.
 boolean isEffectSet(int effect)
          Indicates if the effect 'effect' related to the project is set (see esriNgProjectEffect).
 boolean isHighlightingEffectSet(int effect)
          Indicates if the effect 'effect' used for highlighting the elements when they are selected is set.
 boolean isProjectOpen()
          Indicates if the schematic session is open.
 void open(boolean restoreSession, boolean selectIfNotSet)
          Opens the schematic session associated with the project.
 INgDiagram openDiagram(INgDiagramType diagType, String diagramName, boolean restore)
          Opens the diagram named 'diagramName' implemented by the specified diagram type.
 void openDiagramForm()
          Opens the predefined Schematics dialog-box that allows to select a type of diagram and a diagram.
 void readExternal(ObjectInput in)
           
 void refreshToolbars()
          Triggers the 'OnRefreshToolbar' predefined callback.
 void removeHighlightingEffect(int effect)
          Removes the effect 'effect' used for highlighting the elements when they are selected (see esriNgHighlightingEffectType).
 void removeListener(String iidStr, Object theListener)
           
 void sendEvent(String evtName, int metaType, String objectType, String objectName)
          Sends the event 'eventName' to the object named 'objectName' that is implemented by the object type named 'objectType' of the 'metatype' metatype.
 void setEffect(int effect, Object effValue)
          Modifies the effect 'effect' set for the project (see esriNgProjectEffect).
 void setHelpFile(String pVal)
          Name of the online help file.
 void setHighlightingEffect(int effect, Object effValue)
          Modifies the effect 'effect' used for highlighting the elements when they are selected (see esriNgHighlightingEffectType).
 void setInteractorMode(int mode, INgElementType typeToDigit, int digitType)
          Enables the interaction mode 'mode' (see esriNgInteractorMode).
 void setProjectFileName(String pVal)
          Full pathname of the '.ini' file used to initialize the project.
 void setStatus(String status)
          Triggers the OnStatusChange' predefined callback.
 void setTraceLevel(int level)
          Enable the program tracing in 'level' mode.
 void terminate()
          Puts an end to the schematic session and removes all the schematic components created in memory.
 void unselectAll()
          Deselects all elements that are currently selected in all the opened views.
 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

INgProjectProxy

public INgProjectProxy()

INgProjectProxy

public INgProjectProxy(Object obj)
                throws IOException
Throws:
IOException

INgProjectProxy

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

getActiveView

public INgView getActiveView()
                      throws IOException,
                             AutomationException
Current active view in the project.

Product Availability

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

Specified by:
getActiveView in interface INgProject
Returns:
A reference to a com.esri.arcgis.schematic.INgView
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOpenedDiagrams

public INgDiagrams getOpenedDiagrams()
                              throws IOException,
                                     AutomationException
List of the diagrams currently opened in the project.

Product Availability

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

Specified by:
getOpenedDiagrams in interface INgProject
Returns:
A reference to a com.esri.arcgis.schematic.INgDiagrams
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProjectViews.getOpenedViews()

getSelectedElements

public INgElements getSelectedElements()
                                throws IOException,
                                       AutomationException
List of the elements currently selected in the project.

Product Availability

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

Specified by:
getSelectedElements in interface INgProject
Returns:
A reference to a com.esri.arcgis.schematic.INgElements
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgView.getSelectedElements()

getDiagramTypes

public INgDiagramTypes getDiagramTypes()
                                throws IOException,
                                       AutomationException
List of the diagram types associated with the project.

Product Availability

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

Specified by:
getDiagramTypes in interface INgProject
Returns:
A reference to a com.esri.arcgis.schematic.INgDiagramTypes
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProject.getDiagramType(String)

getElementTypes

public INgElementTypes getElementTypes()
                                throws IOException,
                                       AutomationException
List of the element types associated with the project.

Product Availability

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

Specified by:
getElementTypes in interface INgProject
Returns:
A reference to a com.esri.arcgis.schematic.INgElementTypes
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProject.getElementType(String)

initialize

public void initialize(String fName)
                throws IOException,
                       AutomationException
Initializes the project based on the parameters contained in the file 'fName'.

Product Availability

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

Specified by:
initialize in interface INgProject
Parameters:
fName - The fName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProject.terminate()

terminate

public void terminate()
               throws IOException,
                      AutomationException
Puts an end to the schematic session and removes all the schematic components created in memory.

Product Availability

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

Specified by:
terminate in interface INgProject
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProject.initialize(String)

addDataSource

public void addDataSource(INgDataSource dataSource)
                   throws IOException,
                          AutomationException
Adds the specified data source into the project.

Product Availability

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

Specified by:
addDataSource in interface INgProject
Parameters:
dataSource - A reference to a com.esri.arcgis.schematic.INgDataSource (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProject.getDataSource(String), INgProject.getDataSources()

addUserProcedures

public void addUserProcedures(Object userProcedures,
                              String proceduresSetName)
                       throws IOException,
                              AutomationException
Adds the specified procedures set into the project.

Description

The name of that set of procedures is proceduresSetName; it is that name that Schematics uses to reference this set of associated procedures.

Product Availability

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

Specified by:
addUserProcedures in interface INgProject
Parameters:
userProcedures - A reference to another Automation Object (IDispatch) (in)
proceduresSetName - The proceduresSetName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProject.getUserProcedureSets()

addUserAttributes

public void addUserAttributes(Object userAttributes,
                              String attributesSetName)
                       throws IOException,
                              AutomationException
Adds the specified attributes set into the project.

Description

The name of that set of attributes is attributesSetName; it is that name that Schematics uses to reference this set of associated attributes.

Product Availability

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

Specified by:
addUserAttributes in interface INgProject
Parameters:
userAttributes - A reference to another Automation Object (IDispatch) (in)
attributesSetName - The attributesSetName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProject.getUserAttributeSets()

open

public void open(boolean restoreSession,
                 boolean selectIfNotSet)
          throws IOException,
                 AutomationException
Opens the schematic session associated with the project.

Description

If the project is not already initialized (Initialize method), either the selectIfNotSet parameter value is TRUE and Schematics opens the Open MS Window dialog box so that the user can indicate the full pathname of the desired Schematics .ini file that contains the project definition, or the selectIfNotSet parameter value is FALSE and Schematics creates a new empty .ini file in the application's currently active directory.

If the restoreSession parameter is set to TRUE, this method restores all the views to their last saved position and display state (scale, text and symbol sizes...).

Note: If you did not save the diagrams that were open when the session was last saved, the layout of the elements in these diagrams is not restored when the session is opened: the elements associated with the diagrams are positioned based on their database coordinates or on their last saved positions. Indeed, when you save your schematic session, you save the current position and display state of the schematic windows, but their contents (that make up the diagrams) is not saved.

Remarks

About events managed during the project opening...


When the INgProject’s Open method is triggered, several Schematics event procedures are successively fired:


(1) BeforeInitProject

(2) BeforeOpenProject

(3) (OnInitApplication)

(4) AfterOpenProject

(5) OnRefreshToolbar


The following lines detail the Schematics running way during the project opening:

(1) The BeforeInitProject event is fired.


(2) If no .ini file has been set (that is, the ProjectFileName INgProject property is not set) or if the .ini file doesn't exist and if the selectIfNotSet parameter of the Open method is True (default value), the Open MS window form automatically opens allowing you to select the desired .ini file.

When the .ini file is known, the BeforeOpenProject event is fired


(3) Then, the schematic project opens: That is, the project parameters file is loaded. If an error happens during the project parameters file reading, Schematics sets the session status to Closed and the session opening is interrupted.

If no error happens, and if an OnInitApplication event has been declared in the project parameters file, the associated treatments are executed. At the end of this step, Schematics sets the session status to Open.


(4) Then, the AfterOpenProject event is fired


(5) If the restoreSession parameter of the INgProject’s Open method is True (default value), the session is restored according to its last saving: all the views are opened to their last saved position and display state (scale, text and symbol sizes...).

The OnRefreshToolbar event is fired.

Product Availability

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

Specified by:
open in interface INgProject
Parameters:
restoreSession - The restoreSession (in, optional, pass true if not required)
selectIfNotSet - The selectIfNotSet (in, optional, pass true if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProjectViews.restoreSession(String), INgProject.isProjectOpen()

close

public void close()
           throws IOException,
                  AutomationException
Closes the currently opened schematic session.

Description

If you have changed a diagram since the beginning of the session and have not saved it yet, depending on the SaveMode property value of this diagram, you may be asked if you want to save the changes. If you have not saved the current schematic session, depending on the SaveMode property value set for your project, you may be asked to do so before closing.

Note also that the Schematics BeforeCloseProject and AfterCloseProject events automatically fire when you use this method.

Remarks

About events managed during the project closure



When the INgProject’s Close method is triggered is triggered, several Schematics event procedures are successively fired:

(1) BeforeCloseProject

(2) IsDiagramSavedByFramework

(3) IsSessionSavedByFramework

(4) BeforeCloseDiagram , BeforeCloseView, IsViewDestroyedByFramework

(5) AfterCloseProject


The following lines detail the Schematics running way during the project closure:

(1) If the session is already closed, the running is interrupted. The BeforeCloseProject event is fired.


(2) If diagrams are opened, for each opened diagram, Schematics checks its SaveMode property:

. Either the SaveMode INgDiagram property returns esriNgNotSaveByFramework, or the IsDiagramSavedByFramework event procedure returns False, and in these both cases, Schematics doesn’t charge of the diagram saving.

. Either the SaveMode INgDiagram property returns esriNgSaveByFramework, or it returns esriNgSaveUndefined but the IsDiagramSavedByFramework event procedure returns True, and in these both cases, Schematics charges of the diagram saving: a predefined form is automatically opened and end-user is asked if he wants to save the changes for the current diagram.


(3) Next, Schematics takes interest about the session saving:

- Either the SaveMode INgProjectViews property returns esriNgNotSaveByFramework, or the IsSessionSavedByFramework event procedure returns False, and in these both cases, Schematics doesn’t charge of the session saving.

- Or the SaveMode INgProjectViews property returns esriNgSaveByFramework, or it returns esriNgSaveUndefined but the IsSessionSavedByFramework event procedure returns True, and in these both cases, Schematics charges of the session saving: a predefined form is automatically opened and end-user is asked if he wants to save the currently open session.


(4) Then, the running concerns the closing of all the open diagrams (if such open diagrams exists.).

For each open diagram,

The BeforeCloseDiagram event is fired.

Next, the diagram's elements are removed. Then, for each its related opened views, the BeforeCloseView event is fired. If the legend sub-window is displayed in the view, it is deleted.

If the IsViewDestroyedByFramework event procedure returns True, Schematics charges of the view destruction.


(5) The AfterCloseProject event is triggered.

Product Availability

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

Specified by:
close in interface INgProject
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

openDiagramForm

public void openDiagramForm()
                     throws IOException,
                            AutomationException
Opens the predefined Schematics dialog-box that allows to select a type of diagram and a diagram.

Description

The diagrams available from the dialog’s dropdown lists are those defined in the schematic project parameters file. You select them by their type and name.

- If the diagram chosen was saved during a previous session for instance, it is loaded and restored with the page layout thus and then saved.

- If elements relating to this diagram were created or removed in the database since it was last saved, these modifications are reflected in the display (those elements that were removed no longer appear in the diagram and those that were created are displayed).

Note that when this method is triggered, the IsDiagramOpenedByFramework event function is automatically called. If this event returns FALSE, the Schematics predefined ‘Select diagram to open’ dialog box is not brought up.

Product Availability

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

Specified by:
openDiagramForm in interface INgProject
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProject.openDiagram(com.esri.arcgis.schematic.INgDiagramType, String, boolean), INgProjectEvents.isDiagramOpenedByFramework(com.esri.arcgis.schematic.INgProjectEventsIsDiagramOpenedByFrameworkEvent)

unselectAll

public void unselectAll()
                 throws IOException,
                        AutomationException
Deselects all elements that are currently selected in all the opened views.

Product Availability

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

Specified by:
unselectAll in interface INgProject
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgView.unselectAll(boolean)

getDiagramType

public INgDiagramType getDiagramType(String dgTypeName)
                              throws IOException,
                                     AutomationException
Returns the diagram type named 'dgTypeName' implemented by the project.

Product Availability

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

Specified by:
getDiagramType in interface INgProject
Parameters:
dgTypeName - The dgTypeName (in)
Returns:
A reference to a com.esri.arcgis.schematic.INgDiagramType
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProject.getDiagramTypes(), INgProjectBuilder.createDiagramType(String, com.esri.arcgis.schematic.INgDiagramType)

getElementType

public INgElementType getElementType(String eltTypeName)
                              throws IOException,
                                     AutomationException
Returns the element type named 'eltTypeName' implemented by the project.

Product Availability

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

Specified by:
getElementType in interface INgProject
Parameters:
eltTypeName - The eltTypeName (in)
Returns:
A reference to a com.esri.arcgis.schematic.INgElementType
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProject.getElementTypes(), INgProjectBuilder.createElementType(String, int, com.esri.arcgis.schematic.INgElementType, boolean)

getFlagModel

public INgFlagModel getFlagModel(String flagModelName)
                          throws IOException,
                                 AutomationException
Returns the flag model named 'flagModelName' implemented by the project.

Product Availability

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

Specified by:
getFlagModel in interface INgProject
Parameters:
flagModelName - The flagModelName (in)
Returns:
A reference to a com.esri.arcgis.schematic.INgFlagModel
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProject.getFlagModels(), INgProjectBuilder.createFlagModel(String)

getInteractorMode

public int getInteractorMode()
                      throws IOException,
                             AutomationException
Returns the currently active interaction (see esriNgInteractorMode).

Product Availability

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

Specified by:
getInteractorMode in interface INgProject
Returns:
A com.esri.arcgis.schematic.esriNgInteractorMode constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProject.setInteractorMode(int, com.esri.arcgis.schematic.INgElementType, int)

setInteractorMode

public void setInteractorMode(int mode,
                              INgElementType typeToDigit,
                              int digitType)
                       throws IOException,
                              AutomationException
Enables the interaction mode 'mode' (see esriNgInteractorMode).

Description

In the case of the esriNgModeDigit interactor mode, the method also allows specifying the type of elements to be digitized and the digitizing mode (see esriNgDigitType list).

Product Availability

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

Specified by:
setInteractorMode in interface INgProject
Parameters:
mode - A com.esri.arcgis.schematic.esriNgInteractorMode constant (in)
typeToDigit - A reference to a com.esri.arcgis.schematic.INgElementType (in, optional, pass 0 if not required)
digitType - A com.esri.arcgis.schematic.esriNgDigitType constant (in, optional, pass 0 if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProject.getInteractorMode()

setTraceLevel

public void setTraceLevel(int level)
                   throws IOException,
                          AutomationException
Enable the program tracing in 'level' mode.

Description

The trace function can be run at three levels:

- esriNgErrorLevel; that is the program is traced and returned errors only.

- esriNgWarningLevel; that is the program is traced and returned errors and warning messages.

- esriNgInformationLevel; that is the program is traced and returned errors, warning messages and information messages (for instance, messages indicating the end of a procedure).

Product Availability

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

Specified by:
setTraceLevel in interface INgProject
Parameters:
level - A com.esri.arcgis.schematic.esriNgTraceLevel constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProjectEvents.onTrace(com.esri.arcgis.schematic.INgProjectEventsOnTraceEvent)

setEffect

public void setEffect(int effect,
                      Object effValue)
               throws IOException,
                      AutomationException
Modifies the effect 'effect' set for the project (see esriNgProjectEffect).

Product Availability

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

Specified by:
setEffect in interface INgProject
Parameters:
effect - A com.esri.arcgis.schematic.esriNgProjectEffect constant (in)
effValue - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProject.isEffectSet(int), INgProject.setHighlightingEffect(int, java.lang.Object), INgProject.getEffect(int)

openDiagram

public INgDiagram openDiagram(INgDiagramType diagType,
                              String diagramName,
                              boolean restore)
                       throws IOException,
                              AutomationException
Opens the diagram named 'diagramName' implemented by the specified diagram type.

Description

The diagramType INgDiagramType interface must already exist.

The diagramName parameter must be consistent with the diagram name identifier definition for its associated diagram type.

If the query returning all the diagrams of this type is set to NULL (that is, if there is only one diagram of this type), any diagramName can be used: all the associated diagrams represent the same network.

If there is more than one diagram of this type, the diagramName parameter syntax must follow that of the identifier defined for this diagram type otherwise the diagram that will be opened, will be empty!

Note that if the chosen open diagram was previously saved, it is loaded and restored with the page layout thus and then saved.

Remarks

Several Schematic event procedures are automatically chained during a diagram opening. For more details on these events' chaining, please see the Remarks section available from the INgDiagram Open method help-page.

Product Availability

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

Specified by:
openDiagram in interface INgProject
Parameters:
diagType - A reference to a com.esri.arcgis.schematic.INgDiagramType (in)
diagramName - The diagramName (in)
restore - The restore (in, optional, pass true if not required)
Returns:
A reference to a com.esri.arcgis.schematic.INgDiagram
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProject.openDiagramForm(), INgDiagramType.openDiagram(String, boolean)

getPatternModel

public INgPatternModel getPatternModel(String patternModelName)
                                throws IOException,
                                       AutomationException
Returns the pattern model named 'patternModelName' implemented by the project.

Product Availability

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

Specified by:
getPatternModel in interface INgProject
Parameters:
patternModelName - The patternModelName (in)
Returns:
A reference to a com.esri.arcgis.schematic.INgPatternModel
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProject.getPatternModels(), INgProjectBuilder.createPatternModel(String, int, String)

getEffect

public Object getEffect(int effect)
                 throws IOException,
                        AutomationException
Returns the effect 'effect' set for the project (see esriNgProjectEffect).

Product Availability

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

Specified by:
getEffect in interface INgProject
Parameters:
effect - A com.esri.arcgis.schematic.esriNgProjectEffect constant (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProject.isEffectSet(int), INgProject.setEffect(int, java.lang.Object), INgProject.getHighlightingEffect(int)

isEffectSet

public boolean isEffectSet(int effect)
                    throws IOException,
                           AutomationException
Indicates if the effect 'effect' related to the project is set (see esriNgProjectEffect).

Description

By default, Schematics automatically sets default values for some project effects (see the List of the project effect default values, below). For all these effects, the IsEffectSet method returns True. For the others effects (those that are not automatically set), the IsEffectSet method returns True only if the effect has been set:

- Either when defining the project's characteristics through ArcGIS Schematics Designer,

- Or by calling the SetEffect method in the program code.


List of the project effect default values

esriNgProjectFitMargin: 0.05.

esriNgProjectFitAllMargin: 0.02.

esriNgProjectFitMarginMode: esriNgRelativeMargin.

esriNgProjectFitAllMarginMode: esriNgRelativeMargin.

esriNgProjectFolderPath: Folder named "GraphicFolder" according to the ".ini" file location

esriNgProjectBackupPath: Folder named "GraphicBackup" according to the ".ini" file location

esriNgProjectSymbolPath: Folder named "Cgm" according to the ".ini" file location

esriNgProjectSymbolClipping: False

esriNgProjectSymbolScaling: 1

esriNgProjectLinkLabelDistance: 1

esriNgProjectInterlineSpacing: 0.1

esriNgProjectLineColor: 1 (red)

esriNgProjectLineStyle: esriNgSolid

esriNgProjectLineWidth: 1

esriNgprojectFillColor: 1 (red)

esriNgProjectFillStyle: esriNgSolid

esriNgProjectHatchStyle: esriNgHatchHorizontal

esriNgProjectTextAlignment: esriNgBottomLeft

esriNgProjectTextAngle: 0

esriNgProjectTextColor: 1 (red)

esriNgProjectTextSize: 1


For more details, see Project Effects Definition.

Product Availability

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

Specified by:
isEffectSet in interface INgProject
Parameters:
effect - A com.esri.arcgis.schematic.esriNgProjectEffect constant (in)
Returns:
The isSet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProject.setEffect(int, java.lang.Object), INgProject.isHighlightingEffectSet(int), INgProject.getEffect(int)

isProjectOpen

public boolean isProjectOpen()
                      throws IOException,
                             AutomationException
Indicates if the schematic session is open.

Product Availability

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

Specified by:
isProjectOpen in interface INgProject
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProject.close(), INgProject.open(boolean, boolean)

beginWaitCursor

public void beginWaitCursor()
                     throws IOException,
                            AutomationException
Enables the wait cursor.

Product Availability

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

Specified by:
beginWaitCursor in interface INgProject
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProject.endWaitCursor()

endWaitCursor

public void endWaitCursor()
                   throws IOException,
                          AutomationException
Disables the wait cursor.

Product Availability

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

Specified by:
endWaitCursor in interface INgProject
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProject.beginWaitCursor()

getSymbol

public INgSymbol getSymbol(String symbolName)
                    throws IOException,
                           AutomationException
Returns the symbol named 'symbolName'.

Description

The specified symbolName CGM file must be located in the CGM folder. If it is not, the GetSymbol function returns Nothing.

Note: The symbolName parameter must be passed to the function without the .cgm extension.

Product Availability

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

Specified by:
getSymbol in interface INgProject
Parameters:
symbolName - The symbolName (in)
Returns:
A reference to a com.esri.arcgis.schematic.INgSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

sendEvent

public void sendEvent(String evtName,
                      int metaType,
                      String objectType,
                      String objectName)
               throws IOException,
                      AutomationException
Sends the event 'eventName' to the object named 'objectName' that is implemented by the object type named 'objectType' of the 'metatype' metatype.

Description

The event eventName must be already defined (eventName is the UserEventName defined for a behavior).

Product Availability

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

Specified by:
sendEvent in interface INgProject
Parameters:
evtName - The evtName (in)
metaType - A com.esri.arcgis.schematic.esriNgMetaType constant (in)
objectType - The objectType (in)
objectName - The objectName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFlagModels

public INgFlagModels getFlagModels()
                            throws IOException,
                                   AutomationException
List of the flag models implemented by the project.

Product Availability

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

Specified by:
getFlagModels in interface INgProject
Returns:
A reference to a com.esri.arcgis.schematic.INgFlagModels
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProject.getFlagModel(String)

getPatternModels

public INgPatternModels getPatternModels()
                                  throws IOException,
                                         AutomationException
List of the pattern models implemented by the project.

Product Availability

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

Specified by:
getPatternModels in interface INgProject
Returns:
A reference to a com.esri.arcgis.schematic.INgPatternModels
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProject.getPatternModel(String)

getSelectedFlags

public INgFlags getSelectedFlags()
                          throws IOException,
                                 AutomationException
List of the flags currently selected in the project.

Product Availability

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

Specified by:
getSelectedFlags in interface INgProject
Returns:
A reference to a com.esri.arcgis.schematic.INgFlags
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgView.getSelectedFlags()

getDataSources

public INgDataSources getDataSources()
                              throws IOException,
                                     AutomationException
List of the datasources defined for the project.

Product Availability

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

Specified by:
getDataSources in interface INgProject
Returns:
A reference to a com.esri.arcgis.schematic.INgDataSources
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProject.getDataSource(String)

getUserAttributeSets

public INgUserAttributeSets getUserAttributeSets()
                                          throws IOException,
                                                 AutomationException
List of the user attibute sets defined for the project.

Product Availability

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

Specified by:
getUserAttributeSets in interface INgProject
Returns:
A reference to a com.esri.arcgis.schematic.INgUserAttributeSets
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProject.addUserAttributes(java.lang.Object, String)

getUserProcedureSets

public INgUserProcedureSets getUserProcedureSets()
                                          throws IOException,
                                                 AutomationException
List of the user procedure sets defined for the project.

Product Availability

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

Specified by:
getUserProcedureSets in interface INgProject
Returns:
A reference to a com.esri.arcgis.schematic.INgUserProcedureSets
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProject.addUserProcedures(java.lang.Object, String)

getDataSource

public INgDataSource getDataSource(String dataSourceName)
                            throws IOException,
                                   AutomationException
Returns the datasource named 'dataSourceName'.

Product Availability

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

Specified by:
getDataSource in interface INgProject
Parameters:
dataSourceName - The dataSourceName (in)
Returns:
A reference to a com.esri.arcgis.schematic.INgDataSource
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProject.addDataSource(com.esri.arcgis.schematic.INgDataSource), INgProject.getDataSources()

getProjectFileName

public String getProjectFileName()
                          throws IOException,
                                 AutomationException
Full pathname of the '.ini' file used to initialize the project.

Product Availability

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

Specified by:
getProjectFileName in interface INgProject
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setProjectFileName

public void setProjectFileName(String pVal)
                        throws IOException,
                               AutomationException
Full pathname of the '.ini' file used to initialize the project.

Product Availability

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

Specified by:
setProjectFileName in interface INgProject
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHighlightingEffect

public Object getHighlightingEffect(int effect)
                             throws IOException,
                                    AutomationException
Returns the effect 'effect' used for highlighting the elements when they are selected (see esriNgHighlightingEffectType).

Product Availability

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

Specified by:
getHighlightingEffect in interface INgProject
Parameters:
effect - A com.esri.arcgis.schematic.esriNgHighlightingEffectType constant (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProject.isHighlightingEffectSet(int), INgProject.getEffect(int), INgProject.setHighlightingEffect(int, java.lang.Object)

setHighlightingEffect

public void setHighlightingEffect(int effect,
                                  Object effValue)
                           throws IOException,
                                  AutomationException
Modifies the effect 'effect' used for highlighting the elements when they are selected (see esriNgHighlightingEffectType).

Product Availability

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

Specified by:
setHighlightingEffect in interface INgProject
Parameters:
effect - A com.esri.arcgis.schematic.esriNgHighlightingEffectType constant (in)
effValue - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProject.setEffect(int, java.lang.Object), INgProject.isHighlightingEffectSet(int), INgProject.getHighlightingEffect(int)

removeHighlightingEffect

public void removeHighlightingEffect(int effect)
                              throws IOException,
                                     AutomationException
Removes the effect 'effect' used for highlighting the elements when they are selected (see esriNgHighlightingEffectType).

Product Availability

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

Specified by:
removeHighlightingEffect in interface INgProject
Parameters:
effect - A com.esri.arcgis.schematic.esriNgHighlightingEffectType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProject.isHighlightingEffectSet(int), INgProject.setHighlightingEffect(int, java.lang.Object), INgProject

isHighlightingEffectSet

public boolean isHighlightingEffectSet(int effect)
                                throws IOException,
                                       AutomationException
Indicates if the effect 'effect' used for highlighting the elements when they are selected is set.

Description

The 'effect' effect has been set:

- Either through ArcGIS Schematics Designer when defining the Highlight tab parameters for the open project,

- Or by calling the SetHighlightingEffect method in your program code.

Product Availability

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

Specified by:
isHighlightingEffectSet in interface INgProject
Parameters:
effect - A com.esri.arcgis.schematic.esriNgHighlightingEffectType constant (in)
Returns:
The isSet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProject.isEffectSet(int), INgProject.getHighlightingEffect(int), INgProject.setHighlightingEffect(int, java.lang.Object)

getHelpFile

public String getHelpFile()
                   throws IOException,
                          AutomationException
Name of the online help file.

Product Availability

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

Specified by:
getHelpFile in interface INgProject
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHelpFile

public void setHelpFile(String pVal)
                 throws IOException,
                        AutomationException
Name of the online help file.

Product Availability

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

Specified by:
setHelpFile in interface INgProject
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

refreshToolbars

public void refreshToolbars()
                     throws IOException,
                            AutomationException
Triggers the 'OnRefreshToolbar' predefined callback.

Product Availability

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

Specified by:
refreshToolbars in interface INgProject
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProjectEvents.onRefreshToolbar(com.esri.arcgis.schematic.INgProjectEventsOnRefreshToolbarEvent)

setStatus

public void setStatus(String status)
               throws IOException,
                      AutomationException
Triggers the OnStatusChange' predefined callback.

Product Availability

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

Specified by:
setStatus in interface INgProject
Parameters:
status - The status (in)
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