com.esri.arcgis.schematic
Class INgProjectViewsProxy

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

All Implemented Interfaces:

INgProjectViews, Externalizable, Serializable

public class INgProjectViewsProxy
extends com.esri.arcgis.interop.Dispatch
implements INgProjectViews, Serializable

Provides access to members that control the view windows positioning and the printer configuration.

Product Availability

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

See Also:

INgProject, Serialized Form

Field Summary

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

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E

Constructor Summary

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
INgViews	getOpenedViews() List of the views that are currently open in the project.
void	getPrintableArea(double[] width, double[] height) Returns the current printing area defined in the printer configuration dialog box.
int	getSaveMode() Saving mode for the schematic session.
void	getScreenSize(int[] width, int[] height) Returns the screen 'width' and 'height' in pixels units.
void	getTileArea(INgPoint[] upperLeftCorner, INgPoint[] lowerRightCorner) Returns the 'upperLeftCorner' and 'lowerRightCorner' points enclosing the area used to position the schematic windows.
void	printSetup() Opens the default printer configuration dialog box.
void	readExternal(ObjectInput in)
void	removeListener(String iidStr, Object theListener)
void	restoreSession(String sessionName) Restores the session named 'sessionName'; that is, restores the views to their last saved position and display state.
void	saveSession(String sessionName) Saves the schematic session associated with the project.
void	setSaveMode(int pVal) Saving mode for the schematic session.
void	setTileArea(INgPoint upperLeftCorner, INgPoint lowerRightCorner) Defines the area enclosed between the 'upperLeftCorner' and 'lowerRightCorner' points that will be used to position the schematic windows.
void	tileViews(int mode) Arranges the views according to the 'mode' tile views option (see esriNgTileViewMode).
void	unsetTileArea() Restores the default area used to position the view windows.
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

INgProjectViewsProxy

public INgProjectViewsProxy()

INgProjectViewsProxy

public INgProjectViewsProxy(Object obj)
                     throws IOException

Throws:

IOException

INgProjectViewsProxy

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

getPrintableArea

public void getPrintableArea(double[] width,
                             double[] height)
                      throws IOException,
                             AutomationException

Returns the current printing area defined in the printer configuration dialog box.

Product Availability

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

Specified by:

getPrintableArea in interface INgProjectViews

Parameters:

width - The width (out: use single element array)

height - The height (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgView.printView(String, boolean)

getScreenSize

public void getScreenSize(int[] width,
                          int[] height)
                   throws IOException,
                          AutomationException

Returns the screen 'width' and 'height' in pixels units.

Product Availability

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

Specified by:

getScreenSize in interface INgProjectViews

Parameters:

width - The width (out: use single element array)

height - The height (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTileArea

public void getTileArea(INgPoint[] upperLeftCorner,
                        INgPoint[] lowerRightCorner)
                 throws IOException,
                        AutomationException

Returns the 'upperLeftCorner' and 'lowerRightCorner' points enclosing the area used to position the schematic windows.

Product Availability

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

Specified by:

getTileArea in interface INgProjectViews

Parameters:

upperLeftCorner - A reference to a com.esri.arcgis.schematic.INgPoint (out: use single element array)

lowerRightCorner - A reference to a com.esri.arcgis.schematic.INgPoint (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectViews.setTileArea(com.esri.arcgis.schematic.INgPoint, com.esri.arcgis.schematic.INgPoint), INgProjectViews.unsetTileArea(), INgProjectViews.tileViews(int)

setTileArea

public void setTileArea(INgPoint upperLeftCorner,
                        INgPoint lowerRightCorner)
                 throws IOException,
                        AutomationException

Defines the area enclosed between the 'upperLeftCorner' and 'lowerRightCorner' points that will be used to position the schematic windows.

Product Availability

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

Specified by:

setTileArea in interface INgProjectViews

Parameters:

upperLeftCorner - A reference to a com.esri.arcgis.schematic.INgPoint (in)

lowerRightCorner - A reference to a com.esri.arcgis.schematic.INgPoint (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectViews.getTileArea(com.esri.arcgis.schematic.INgPoint[], com.esri.arcgis.schematic.INgPoint[]), INgProjectViews.unsetTileArea(), INgProjectViews.tileViews(int)

getOpenedViews

public INgViews getOpenedViews()
                        throws IOException,
                               AutomationException

List of the views that are currently open in the project.

Product Availability

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

Specified by:

getOpenedViews in interface INgProjectViews

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

restoreSession

public void restoreSession(String sessionName)
                    throws IOException,
                           AutomationException

Restores the session named 'sessionName'; that is, restores the views to their last saved position and display state.

Description

The sessionName parameter is optional. By default, if that name is not specified, the RestoreSession method restores the session associated with the .ini file specified at the time the application was opened.

Note that 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 positioned based on their database coordinates or on their last saved positions. Indeed, when you save a schematic session, you save the current position and display state of the schematic windows (scale, text and symbol sizes…), but their contents (that make up the diagrams) are not saved.

Product Availability

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

Specified by:

restoreSession in interface INgProjectViews

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveSession

public void saveSession(String sessionName)
                 throws IOException,
                        AutomationException

Saves the schematic session associated with the project.

Description

This method saves all open schematic views with their characteristics (diagram name, window size and position, zoom factor, text and symbol sizes).The next time the session is opened again, all the views will be restored to the display state they were saved in.

The sessionName parameter is optional. By default, if that name is not specified, Schematics saves the current opened session under the session file which name is as your .ini file (that is, as your project's file name) with the .ses extension.

Saving session under another session name allows you to save different display states and schematic windows positions.

Note: When you save a session, the contents of the diagrams (position of the elements, page layout) is not saved. Only the positions of the schematic windows and their current display state are saved.

Product Availability

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

Specified by:

saveSession in interface INgProjectViews

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

printSetup

public void printSetup()
                throws IOException,
                       AutomationException

Opens the default printer configuration dialog box.

Product Availability

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

Specified by:

printSetup in interface INgProjectViews

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSaveMode

public int getSaveMode()
                throws IOException,
                       AutomationException

Saving mode for the schematic session.

Description

By default, saving mode value is "esriNgSaveUndefined".

- With the esriNgSaveUndefined mode, when you close your session, you are asked if you want to save it.

- With the esriNgSaveByFramework mode, Schematics automatically saves your session without asking you if you want to save changes.

- With the esriNgNotSaveByFramework mode, Schematics doesn't save the changes.

Product Availability

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

Specified by:

getSaveMode in interface INgProjectViews

Returns:

A com.esri.arcgis.schematic.esriNgSaveModeType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSaveMode

public void setSaveMode(int pVal)
                 throws IOException,
                        AutomationException

Saving mode for the schematic session.

Product Availability

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

Specified by:

setSaveMode in interface INgProjectViews

Parameters:

pVal - A com.esri.arcgis.schematic.esriNgSaveModeType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

tileViews

public void tileViews(int mode)
               throws IOException,
                      AutomationException

Arranges the views according to the 'mode' tile views option (see esriNgTileViewMode).

Description

Note#1: Whatever the mode chosen, if the area used to tile the schematic view windows has not been defined before (by calling the SetTileArea method), Schematics looks for the largest free area remaining on the screen in relation to your application's main window to determine the available space for tiling the schematic views.

Note#2: The TileViews method ignores minimized view windows.

Product Availability

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

Specified by:

tileViews in interface INgProjectViews

Parameters:

mode - A com.esri.arcgis.schematic.esriNgTileViewMode constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectViews.setTileArea(com.esri.arcgis.schematic.INgPoint, com.esri.arcgis.schematic.INgPoint), INgProjectViews.unsetTileArea()

unsetTileArea

public void unsetTileArea()
                   throws IOException,
                          AutomationException

Restores the default area used to position the view windows. Cancels the area previously defined by triggering the 'SetTileArea' method.

Product Availability

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

Specified by:

unsetTileArea in interface INgProjectViews

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectViews.setTileArea(com.esri.arcgis.schematic.INgPoint, com.esri.arcgis.schematic.INgPoint), INgProjectViews.getTileArea(com.esri.arcgis.schematic.INgPoint[], com.esri.arcgis.schematic.INgPoint[]), INgProjectViews.tileViews(int)

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