com.esri.arcgis.schematic
Class INgViewProxy

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

All Implemented Interfaces:

INgView, Externalizable, Serializable

public class INgViewProxy
extends com.esri.arcgis.interop.Dispatch
implements INgView, Serializable

Provides access to members that control the graphic view.

Description

A schematic diagram cannot exist without a view. All views of a diagram will display the same network in the same geographic or schematic position, with each view differing only in its zoom level or symbol size. An element selected in one view will be selected in all open views created from the same diagram.

Product Availability

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

See Also:

INgProjectViews, INgDiagram, Serialized Form

Field Summary

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

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E

Constructor Summary

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
void	bringToTop(boolean topMost) Brings the view to the foreground.
void	close() Closes the view.
INgRasterImage	createRasterImage(String imageName, String fName, INgPoint upperLeftCorner, INgPoint lowerRightCorner) Creates a background raster image named 'imageName' from the file 'fName' in the view and places this raster image between the 'upperLeftCorner' and 'lowerRightCorner' points.
INgVectorImage	createVectorImage(String imageName, String fName) Creates a background vector image named 'imageName' from the file 'fName' in the view.
void	exportAs(int fileType, String fileName) Exports the view's content into a BMP or an EMF format image file.
void	fitAll() Fits all the elements contained in the view.
void	fitElements(INgElements elements) Fits all the elements contained in the 'Elements' list in the view.
void	fitSelection() Fits the set of elements currently selected in the view.
INgDiagram	getDiagram() Diagram the view is related to.
void	getDisplayArea(INgPoint[] upperLeftCorner, INgPoint[] lowerRightCorner) Returns the two 'upperLeftCorner' and 'lowerRightCorner' points corresponding to the upper left and lower right corners of the view display area in user coordinates.
Object	getEffect(int effect) Returns the effect 'effect' set for the view (see esriNgViewEffect).
INgElement	getElementAtPoint(INgPoint point) Returns the elements located at the position 'point' in the view.
void	getElementsBoundingBox(INgElements elements, INgPoint[] upperLeftCorner, INgPoint[] lowerRightCorner) Returns the 'upperLeftCorner' and 'lowerRightCorner' points defining the bounding box of the elements contained in the 'Elements' list.
INgElements	getElementsInZone(INgPoints pts) Returns a list of all the elements contained in the area defined by the list of points 'pts' in the view.
void	getExtent(INgPoint[] upperLeftCorner, INgPoint[] lowerRightCorner) Returns the 'upperLeftCorner' and 'lowerRightCorner' points defining the extend of the view.
int	getHandle() The handle of the view window.
INgInformation	getInformationAtPoint(INgPoint point) Returns information about the element located at the 'point' point in the view.
INgLegend	getLegend() Legend related to the view.
INgLegendDescription	getLegendDescription() Legend description related to the view.
String	getName() Name of the view.
void	getPosition(INgPoint[] upperLeftCorner, INgPoint[] lowerRightCorner) Returns the screen coordinates (in pixels unit) of the view 'upperLeftCorner' and 'lowerRightCorner' points.
INgRasterImages	getRasterImages() List of the background raster images related to the view.
INgElements	getSelectedElements() List of the elements currently selected in the view.
INgFlags	getSelectedFlags() List of the flags currently selected in the view.
String	getTitle() View window title.
INgVectorImages	getVectorImages() List of the background vector images related to the view.
boolean	isEffectSet(int effect) Indicates if the effect 'effect' related to the view is set (see esriNgViewEffect).
boolean	isMaximized() Indicates if the view is maximized.
boolean	isMinimized() Indicates if the view is minimized.
void	maximize() Maximizes the view.
void	minimize() Minimizes the view.
void	move(INgPoint upperLeftCorner, INgPoint lowerRightCorner) Moves and resizes the view so that its upper left and lower left corners coincide with the 'upperLeftCorner' and 'lowerRightCorner' points.
void	paintOnDC(int hDC, double xMin, double yMin, double xMax, double yMax, int left, int right, int top, int bottom, double rotation) Displays the view in the 'hDC' device context.
void	printView(String viewTitle, boolean hideSetupDialog) Prints the view.
void	printWithTitleBlock(int position, INgDrawing titleBlock, String viewTitle, boolean hideSetupDialog) Prints the view with a title block.
void	readExternal(ObjectInput in)
void	redraw(int mode) Redraws the elements displayed in the view according to the 'mode' redrawing option.
void	removeEffect(int effect) Restores the default effect 'effect' set for the view.
void	removeListener(String iidStr, Object theListener)
void	restore() Restores the view to its position prior to being minimized or maximized.
void	selectAll(boolean redraw) Selects all the elements contained in the view.
void	setActive() Activates the view.
void	setEffect(int effect, Object effValue) Modifies the effect 'effect' for the view (see esriNgViewEffect).
void	setTitle(String pVal) View window title.
void	unselectAll(boolean redraw) Deselects all the elements currently selected in the view.
void	writeExternal(ObjectOutput out)
void	zoomIn(INgPoint upperLeftCorner, INgPoint lowerRightCorner, int zoomMode) Zooms in on the area enclosed between the view 'upperLeftCorner' and 'lowerRightCorner' points.

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

INgViewProxy

public INgViewProxy()

INgViewProxy

public INgViewProxy(Object obj)
             throws IOException

Throws:

IOException

INgViewProxy

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

getEffect

public Object getEffect(int effect)
                 throws IOException,
                        AutomationException

Returns the effect 'effect' set for the view (see esriNgViewEffect).

Product Availability

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

Specified by:

getEffect in interface INgView

Parameters:

effect - A com.esri.arcgis.schematic.esriNgViewEffect constant (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgView.setEffect(int, java.lang.Object), INgView.removeEffect(int), INgView.isEffectSet(int)

setEffect

public void setEffect(int effect,
                      Object effValue)
               throws IOException,
                      AutomationException

Modifies the effect 'effect' for the view (see esriNgViewEffect).

Product Availability

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

Specified by:

setEffect in interface INgView

Parameters:

effect - A com.esri.arcgis.schematic.esriNgViewEffect constant (in)

effValue - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgView.getEffect(int), INgView.removeEffect(int), INgView.isEffectSet(int)

removeEffect

public void removeEffect(int effect)
                  throws IOException,
                         AutomationException

Restores the default effect 'effect' set for the view.

Product Availability

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

Specified by:

removeEffect in interface INgView

Parameters:

effect - A com.esri.arcgis.schematic.esriNgViewEffect constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgView.getEffect(int), INgView.setEffect(int, java.lang.Object), INgView.isEffectSet(int)

isEffectSet

public boolean isEffectSet(int effect)
                    throws IOException,
                           AutomationException

Indicates if the effect 'effect' related to the view is set (see esriNgViewEffect).

Description

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

- Either when defining the associated diagram type's characteristics through ArcGIS Schematics Designer,

- Or by calling the SetEffect method in the project.

List of the View effect default values

esriNgViewBackgroundColor: 7 (white).

esriNgViewLabelScaling: 1.

esriNgViewSymbolScaling: 1.

For more details, see View Effects Definitions.

Product Availability

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

Specified by:

isEffectSet in interface INgView

Parameters:

effect - A com.esri.arcgis.schematic.esriNgViewEffect constant (in)

Returns:

The isSet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgView.getEffect(int), INgView.setEffect(int, java.lang.Object), INgView.removeEffect(int)

fitSelection

public void fitSelection()
                  throws IOException,
                         AutomationException

Fits the set of elements currently selected in the view.

Product Availability

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

Specified by:

fitSelection in interface INgView

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgView.fitAll(), INgView.fitElements(com.esri.arcgis.schematic.INgElements)

fitElements

public void fitElements(INgElements elements)
                 throws IOException,
                        AutomationException

Fits all the elements contained in the 'Elements' list in the view.

Product Availability

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

Specified by:

fitElements in interface INgView

Parameters:

elements - A reference to a com.esri.arcgis.schematic.INgElements (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgView.fitAll(), INgView.fitSelection()

zoomIn

public void zoomIn(INgPoint upperLeftCorner,
                   INgPoint lowerRightCorner,
                   int zoomMode)
            throws IOException,
                   AutomationException

Zooms in on the area enclosed between the view 'upperLeftCorner' and 'lowerRightCorner' points.

Description

The zoom executed is either a constant scale zoom or a standard zoom, depending on the value assigned to the zoomMode parameter (see esriNgZoomMode list)

Product Availability

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

Specified by:

zoomIn in interface INgView

Parameters:

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

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

zoomMode - A com.esri.arcgis.schematic.esriNgZoomMode constant (in)

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)

getLegend

public INgLegend getLegend()
                    throws IOException,
                           AutomationException

Legend related to the view.

Product Availability

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

Specified by:

getLegend in interface INgView

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDiagram

public INgDiagram getDiagram()
                      throws IOException,
                             AutomationException

Diagram the view is related to.

Product Availability

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

Specified by:

getDiagram in interface INgView

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.

getName

public String getName()
               throws IOException,
                      AutomationException

Name of the view.

Description

By default, the name of a view is formatted as follows DiagramTypeName::#::DiagramName

where:

- DiagramTypeName, is the diagram type name associated with the view.

- DaigramName, is the diagram name associated with the view.

Do not mistake the default view name for the default view title whose format is as follows: DiagramTypeName::DiagramName.

Note that if view titles can be modified, this is not the case of view names.

Product Availability

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

Specified by:

getName in interface INgView

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgView.getTitle()

getSelectedElements

public INgElements getSelectedElements()
                                throws IOException,
                                       AutomationException

List of the elements currently selected in the view.

Product Availability

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

Specified by:

getSelectedElements in interface INgView

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.fitSelection(), INgProject.getSelectedElements()

createRasterImage

public INgRasterImage createRasterImage(String imageName,
                                        String fName,
                                        INgPoint upperLeftCorner,
                                        INgPoint lowerRightCorner)
                                 throws IOException,
                                        AutomationException

Creates a background raster image named 'imageName' from the file 'fName' in the view and places this raster image between the 'upperLeftCorner' and 'lowerRightCorner' points.

Description

The background raster image named imageName associated with the file fileName is placed in between the two upperLeftCorner and lowerRightCorner NgPoints.

Product Availability

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

Specified by:

createRasterImage in interface INgView

Parameters:

imageName - The imageName (in)

fName - The fName (in)

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

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgView.createVectorImage(String, String)

createVectorImage

public INgVectorImage createVectorImage(String imageName,
                                        String fName)
                                 throws IOException,
                                        AutomationException

Creates a background vector image named 'imageName' from the file 'fName' in the view.

Product Availability

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

Specified by:

createVectorImage in interface INgView

Parameters:

imageName - The imageName (in)

fName - The fName (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgView.createRasterImage(String, String, com.esri.arcgis.schematic.INgPoint, com.esri.arcgis.schematic.INgPoint)

getRasterImages

public INgRasterImages getRasterImages()
                                throws IOException,
                                       AutomationException

List of the background raster images related to the view.

Product Availability

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

Specified by:

getRasterImages in interface INgView

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgView.getVectorImages(), INgView.createRasterImage(String, String, com.esri.arcgis.schematic.INgPoint, com.esri.arcgis.schematic.INgPoint)

getVectorImages

public INgVectorImages getVectorImages()
                                throws IOException,
                                       AutomationException

List of the background vector images related to the view.

Product Availability

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

Specified by:

getVectorImages in interface INgView

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgView.getRasterImages(), INgView.createVectorImage(String, String)

printView

public void printView(String viewTitle,
                      boolean hideSetupDialog)
               throws IOException,
                      AutomationException

Prints the view.

Description

If the view is to be printed with a title, the matching character string must be passed as a parameter to the function.

Product Availability

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

Specified by:

printView in interface INgView

Parameters:

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

hideSetupDialog - The hideSetupDialog (in, optional, pass false if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectEvents.isPrintMadeByFramework(com.esri.arcgis.schematic.INgProjectEventsIsPrintMadeByFrameworkEvent), INgView.printWithTitleBlock(int, com.esri.arcgis.schematic.INgDrawing, String, boolean)

printWithTitleBlock

public void printWithTitleBlock(int position,
                                INgDrawing titleBlock,
                                String viewTitle,
                                boolean hideSetupDialog)
                         throws IOException,
                                AutomationException

Prints the view with a title block.

Description

The titleBlock title block to be printed and its print position must be specified (see esriNgTitleBlockPosition list).

If the view is to be printed with a title, the matching character string must be passed as a parameter to the function (title).

By default, the optional hideSetupDialog is set to False: when the printing is launched, Schematics automatically brings up the printing dialog box.

Remarks

When you print a view, Schematics prints the current schematic view window contents: the elements situated out of the current display area are not printed!

Product Availability

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

Specified by:

printWithTitleBlock in interface INgView

Parameters:

position - A com.esri.arcgis.schematic.esriNgTitleBlockPosition constant (in)

titleBlock - A reference to a com.esri.arcgis.schematic.INgDrawing (in)

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

hideSetupDialog - The hideSetupDialog (in, optional, pass false if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgView.printView(String, boolean), INgProjectEvents.isPrintMadeByFramework(com.esri.arcgis.schematic.INgProjectEventsIsPrintMadeByFrameworkEvent)

getDisplayArea

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

Returns the two 'upperLeftCorner' and 'lowerRightCorner' points corresponding to the upper left and lower right corners of the view display area in user coordinates.

Product Availability

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

Specified by:

getDisplayArea in interface INgView

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.getTileArea(com.esri.arcgis.schematic.INgPoint[], com.esri.arcgis.schematic.INgPoint[]), INgProjectViews.getPrintableArea(double[], double[])

getElementsBoundingBox

public void getElementsBoundingBox(INgElements elements,
                                   INgPoint[] upperLeftCorner,
                                   INgPoint[] lowerRightCorner)
                            throws IOException,
                                   AutomationException

Returns the 'upperLeftCorner' and 'lowerRightCorner' points defining the bounding box of the elements contained in the 'Elements' list.

Product Availability

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

Specified by:

getElementsBoundingBox in interface INgView

Parameters:

elements - A reference to a com.esri.arcgis.schematic.INgElements (in)

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.

getElementsInZone

public INgElements getElementsInZone(INgPoints pts)
                              throws IOException,
                                     AutomationException

Returns a list of all the elements contained in the area defined by the list of points 'pts' in the view.

Description

The list of points passed as a parameter must be composed of at least three points.

Product Availability

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

Specified by:

getElementsInZone in interface INgView

Parameters:

pts - A reference to a com.esri.arcgis.schematic.INgPoints (in)

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.getElementAtPoint(com.esri.arcgis.schematic.INgPoint)

close

public void close()
           throws IOException,
                  AutomationException

Closes the view.

Product Availability

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

Specified by:

close in interface INgView

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgDiagram.close(), INgProjectEvents.beforeCloseView(com.esri.arcgis.schematic.INgProjectEventsBeforeCloseViewEvent)

setActive

public void setActive()
               throws IOException,
                      AutomationException

Activates the view.

Product Availability

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

Specified by:

setActive in interface INgView

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgView.bringToTop(boolean)

bringToTop

public void bringToTop(boolean topMost)
                throws IOException,
                       AutomationException

Brings the view to the foreground.

Description

You can also decide to have the view always displayed in the foreground by setting the optional parameter topMost to True.

Product Availability

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

Specified by:

bringToTop in interface INgView

Parameters:

topMost - The topMost (in, optional, pass false if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgView.setActive()

isMinimized

public boolean isMinimized()
                    throws IOException,
                           AutomationException

Indicates if the view is minimized.

Product Availability

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

Specified by:

isMinimized in interface INgView

Returns:

The res

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgView.maximize(), INgView.isMaximized(), INgView.minimize()

isMaximized

public boolean isMaximized()
                    throws IOException,
                           AutomationException

Indicates if the view is maximized.

Product Availability

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

Specified by:

isMaximized in interface INgView

Returns:

The res

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgView.maximize(), INgView, INgView.minimize()

minimize

public void minimize()
              throws IOException,
                     AutomationException

Minimizes the view.

Product Availability

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

Specified by:

minimize in interface INgView

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgView.maximize(), INgView.isMaximized(), INgView.isMinimized()

maximize

public void maximize()
              throws IOException,
                     AutomationException

Maximizes the view.

Product Availability

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

Specified by:

maximize in interface INgView

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgView.isMaximized(), INgView.minimize(), INgView.isMinimized()

getPosition

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

Returns the screen coordinates (in pixels unit) of the view 'upperLeftCorner' and 'lowerRightCorner' points.

Product Availability

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

Specified by:

getPosition in interface INgView

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:

INgView.move(com.esri.arcgis.schematic.INgPoint, com.esri.arcgis.schematic.INgPoint), INgView.restore()

move

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

Moves and resizes the view so that its upper left and lower left corners coincide with the 'upperLeftCorner' and 'lowerRightCorner' points.

Product Availability

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

Specified by:

move in interface INgView

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:

INgView.getPosition(com.esri.arcgis.schematic.INgPoint[], com.esri.arcgis.schematic.INgPoint[])

fitAll

public void fitAll()
            throws IOException,
                   AutomationException

Fits all the elements contained in the view.

Product Availability

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

Specified by:

fitAll in interface INgView

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgView.fitSelection(), INgView.fitElements(com.esri.arcgis.schematic.INgElements)

restore

public void restore()
             throws IOException,
                    AutomationException

Restores the view to its position prior to being minimized or maximized.

Product Availability

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

Specified by:

restore in interface INgView

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgView.getPosition(com.esri.arcgis.schematic.INgPoint[], com.esri.arcgis.schematic.INgPoint[])

getElementAtPoint

public INgElement getElementAtPoint(INgPoint point)
                             throws IOException,
                                    AutomationException

Returns the elements located at the position 'point' in the view.

Description

If there are more than one element located at the position 'point', GetElementAtPoint returns the element that is topmost.

Product Availability

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

Specified by:

getElementAtPoint in interface INgView

Parameters:

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgView.getElementsInZone(com.esri.arcgis.schematic.INgPoints), INgView.getInformationAtPoint(com.esri.arcgis.schematic.INgPoint)

redraw

public void redraw(int mode)
            throws IOException,
                   AutomationException

Redraws the elements displayed in the view according to the 'mode' redrawing option.

Description

This parameter is optional. The default mode is esriNgRedrawAll. Schematics redraws all the elements in the view.

Product Availability

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

Specified by:

redraw in interface INgView

Parameters:

mode - A com.esri.arcgis.schematic.esriNgRedrawMode constant (in, optional, pass 1 if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgDiagram.redraw(int), INgDiagram.refresh()

exportAs

public void exportAs(int fileType,
                     String fileName)
              throws IOException,
                     AutomationException

Exports the view's content into a BMP or an EMF format image file.

Description

Note#1: fileName parameter is the full path file name the function will generate.

Note#2: As the function doesn't add file extension, type your fileName with the wished extension

Product Availability

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

Specified by:

exportAs in interface INgView

Parameters:

fileType - A com.esri.arcgis.schematic.esriNgExportFileType constant (in)

fileName - The fileName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

unselectAll

public void unselectAll(boolean redraw)
                 throws IOException,
                        AutomationException

Deselects all the elements currently selected in the view.

Product Availability

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

Specified by:

unselectAll in interface INgView

Parameters:

redraw - The redraw (in, optional, pass false if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProject.unselectAll()

getSelectedFlags

public INgFlags getSelectedFlags()
                          throws IOException,
                                 AutomationException

List of the flags currently selected in the view.

Product Availability

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

Specified by:

getSelectedFlags in interface INgView

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:

INgProject.getSelectedFlags()

getTitle

public String getTitle()
                throws IOException,
                       AutomationException

View window title.

Description

Note that the default view window title is as follows: DiagramTypeName::DiagramName

where:

- DiagramTypeName, is the diagram type name associated with the view.

- DaigramName, is the diagram name associated with the view.

Do not mistake the default view title for the default view name whose format is as follows: DiagramTypeName::#::DiagramName.

Product Availability

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

Specified by:

getTitle in interface INgView

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgView.getName()

setTitle

public void setTitle(String pVal)
              throws IOException,
                     AutomationException

View window title.

Product Availability

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

Specified by:

setTitle in interface INgView

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

paintOnDC

public void paintOnDC(int hDC,
                      double xMin,
                      double yMin,
                      double xMax,
                      double yMax,
                      int left,
                      int right,
                      int top,
                      int bottom,
                      double rotation)
               throws IOException,
                      AutomationException

Displays the view in the 'hDC' device context.

Product Availability

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

Specified by:

paintOnDC in interface INgView

Parameters:

hDC - The hDC (in)

xMin - The xMin (in, optional, pass 0 if not required)

yMin - The yMin (in, optional, pass 0 if not required)

xMax - The xMax (in, optional, pass 0 if not required)

yMax - The yMax (in, optional, pass 0 if not required)

left - The left (in, optional, pass 0 if not required)

right - The right (in, optional, pass 0 if not required)

top - The top (in, optional, pass 0 if not required)

bottom - The bottom (in, optional, pass 0 if not required)

rotation - The rotation (in, optional, pass 0 if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHandle

public int getHandle()
              throws IOException,
                     AutomationException

The handle of the view window.

Product Availability

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

Specified by:

getHandle in interface INgView

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInformationAtPoint

public INgInformation getInformationAtPoint(INgPoint point)
                                     throws IOException,
                                            AutomationException

Returns information about the element located at the 'point' point in the view.

Product Availability

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

Specified by:

getInformationAtPoint in interface INgView

Parameters:

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgView.getElementAtPoint(com.esri.arcgis.schematic.INgPoint)

getExtent

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

Returns the 'upperLeftCorner' and 'lowerRightCorner' points defining the extend of the view.

Product Availability

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

Specified by:

getExtent in interface INgView

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.

selectAll

public void selectAll(boolean redraw)
               throws IOException,
                      AutomationException

Selects all the elements contained in the view.

Product Availability

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

Specified by:

selectAll in interface INgView

Parameters:

redraw - The redraw (in, optional, pass false if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLegendDescription

public INgLegendDescription getLegendDescription()
                                          throws IOException,
                                                 AutomationException

Legend description related to the view.

Product Availability

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

Specified by:

getLegendDescription in interface INgView

Returns:

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

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