com.esri.arcgis.schematic
Class INgPoleProxy

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

All Implemented Interfaces:

INgPole, Externalizable, Serializable

public class INgPoleProxy
extends com.esri.arcgis.interop.Dispatch
implements INgPole, Serializable

Provides access to members that control the pole.

Description

A pole is an object that symbolizes the connection between a flag and the network element it is associated with. It is represented by a vector segment.

For maximum quality graphics, pole ports, or special (hidden) points onto which flag poles are to be connected, can be defined for node and flag symbols. The pole will then be calculated so as to automatically snap to the nearest flag and associated element pole ports.

Product Availability

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

See Also:

Serialized Form

Field Summary

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

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E

Constructor Summary

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
Object	getEffect(int effect) Returns the effect 'effect' set for the pole (see esriNgPoleEffect).
INgPoint	getExtremityPoint(INgView view) Returns the end point of the pole in the view 'view'.
INgPoint	getOriginPoint(INgView view) Returns the origin point of the pole in the view 'view'.
boolean	isEffectSet(int effect) Indicates if the effect 'effect' related to the pole is set (see esriNgPoleEffect).
void	readExternal(ObjectInput in)
void	removeEffect(int effect) Removes the effect or restores the default effect 'effect' set for the pole (see esriNgPoleEffect).
void	removeListener(String iidStr, Object theListener)
void	setEffect(int effect, Object effValue) Modifies the effect 'effect' set for the pole (see esriNgPoleEffect).
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

INgPoleProxy

public INgPoleProxy()

INgPoleProxy

public INgPoleProxy(Object obj)
             throws IOException

Throws:

IOException

INgPoleProxy

protected INgPoleProxy(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 pole (see esriNgPoleEffect).

Product Availability

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

Specified by:

getEffect in interface INgPole

Parameters:

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

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

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

setEffect

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

Modifies the effect 'effect' set for the pole (see esriNgPoleEffect).

Description

A pole is an object that symbolizes the connection between a flag and the network element it is associated with. It is represented by a vector segment.

For maximum quality graphics, pole ports, or special (hidden) points onto which flag poles are to be connected, can be defined for node and flag symbols. The pole will then be calculated so as to automatically snap to the nearest flag and associated element pole ports.

Product Availability

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

Specified by:

setEffect in interface INgPole

Parameters:

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

effValue - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

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

removeEffect

public void removeEffect(int effect)
                  throws IOException,
                         AutomationException

Removes the effect or restores the default effect 'effect' set for the pole (see esriNgPoleEffect).

Description

Note that when removing an effect that is always set, the pole default effect value is automatically restored; and removing an effect that is not set by default, really removes the pole effect.

Product Availability

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

Specified by:

removeEffect in interface INgPole

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

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

isEffectSet

public boolean isEffectSet(int effect)
                    throws IOException,
                           AutomationException

Indicates if the effect 'effect' related to the pole is set (see esriNgPoleEffect).

Description

By default, Schematics automatically sets default values for some pole effects (see the List of the pole default effect values, below). For all these effects, the IsEffectSet method returns True. For the other 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 pole's characteristics in ArcGIS Schematics Designer

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

List of the pole effect default values

esriNgPoleDetectability: esriNgDetectable

esriNgPoleHighlightedState: esriNgNotHighlighted

esriNgPolePriority: 50 or more

esriNgPoleSelectability: esriNgSelectable

esriNgPoleVisibility: esriNgVisible

For more details, see Pole Effects Definition.

Product Availability

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

Specified by:

isEffectSet in interface INgPole

Parameters:

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

Returns:

The isSet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

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

getOriginPoint

public INgPoint getOriginPoint(INgView view)
                        throws IOException,
                               AutomationException

Returns the origin point of the pole in the view 'view'.

Description

You can specify the view where the pole is displayed. In fact, if your pole appears in two views (for example, one view and its associated view) and if symbol scaling is different in these views, the origin point of the pole could be different in the two views.

Product Availability

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

Specified by:

getOriginPoint in interface INgPole

Parameters:

view - A reference to a com.esri.arcgis.schematic.INgView (in, optional, pass 0 if not required)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgPole.getExtremityPoint(com.esri.arcgis.schematic.INgView)

getExtremityPoint

public INgPoint getExtremityPoint(INgView view)
                           throws IOException,
                                  AutomationException

Returns the end point of the pole in the view 'view'.

Description

You can specify the view where the pole is displayed. In fact, if your pole appears in two views (for example, one view and its associated view) and if symbol scaling is different in these views, the end point of the pole could be different in the two views.

Product Availability

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

Specified by:

getExtremityPoint in interface INgPole

Parameters:

view - A reference to a com.esri.arcgis.schematic.INgView (in, optional, pass 0 if not required)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgPole.getOriginPoint(com.esri.arcgis.schematic.INgView)

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