com.esri.arcgis.schematic
Class INgPatternModelProxy

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

public class INgPatternModelProxy
extends com.esri.arcgis.interop.Dispatch
implements INgPatternModel, Serializable

Provides access to members that control the pattern model.

Description

A pattern is a symbol or a text that is repeated one or more times along a link path route. Adding a pattern along a link path route can be an interesting alternative to the basic graphic effects (color, style, width) that can be set to define the links display. The pattern is drawn on the link according to the rules defined in the model it is based on. There are three types of pattern styles: continuous, discrete, and origin/endpoint patterns. Directed patterns follow the link direction, going from the origin point to the endpoint.

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
  INgPatternModelProxy()
           
  INgPatternModelProxy(Object obj)
           
protected INgPatternModelProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 void delete()
          Deletes the pattern model.
 Object getEffect(int effect)
          Returns the effect 'effect' set for the pattern model (see esriNgPatternModelEffect).
 String getName()
          Name of the pattern model.
 INgProject getProject()
          Project of the pattern model.
 int getType()
          Type of the pattern model.
 boolean isEffectSet(int effect)
          Indicates if the effect 'effect' related to the pattern model is set (see esriNgPatternModelEffect).
 void readExternal(ObjectInput in)
           
 void removeEffect(int effect)
          Removes the effect or restores the default effect 'effect' for the pattern model (see esriNgPatternModelEffect).
 void removeListener(String iidStr, Object theListener)
           
 void setEffect(int effect, Object effValue)
          Modifies the effect 'effect' set for the pattern model (see esriNgPatternModelEffect).
 void setName(String pVal)
          Name of the pattern model.
 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

INgPatternModelProxy

public INgPatternModelProxy()

INgPatternModelProxy

public INgPatternModelProxy(Object obj)
                     throws IOException
Throws:
IOException

INgPatternModelProxy

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

getName

public String getName()
               throws IOException,
                      AutomationException
Name of the pattern model.

Description

This name is defined when the pattern model is created:

- either by calling the INgProjectBuilder CreatePatternModel in the program code,

- or through ArcGIS Schematics Designer.

Product Availability

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

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

setName

public void setName(String pVal)
             throws IOException,
                    AutomationException
Name of the pattern model.

Product Availability

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

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

getType

public int getType()
            throws IOException,
                   AutomationException
Type of the pattern model.

Product Availability

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

Specified by:
getType in interface INgPatternModel
Returns:
A com.esri.arcgis.schematic.esriNgPatternType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEffect

public Object getEffect(int effect)
                 throws IOException,
                        AutomationException
Returns the effect 'effect' set for the pattern model (see esriNgPatternModelEffect).

Product Availability

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

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

setEffect

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

Product Availability

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

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

removeEffect

public void removeEffect(int effect)
                  throws IOException,
                         AutomationException
Removes the effect or restores the default effect 'effect' for the pattern model (see esriNgPatternModelEffect).

Description

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

Product Availability

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

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

isEffectSet

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

Description

By default, Schematics automatically sets default values for some pattern model effects (see the List of the pattern model effects default 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, by the application manager when defining the pattern model's characteristics in ArcGIS Schematics Designer

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


List of the pattern model effect default values

esriNgPatternModelColorMode: esriNgPatternModelNotSlave

esriNgPatternModelDrawMode: esriNgPatternModelContinuous

esriNgPatternModelOrientationMode: esriNgOriented

esriNgPatternModelPositionningMode: esriNgSegmentRelativeSpacing

esriNgPatternModelMaxItemsOnSegment: 1

esriNgPatternModelShiftDistance: 0

esriNgPatternModelSpacing: 0.5


For more details, see Pattern Model Effects Definitions.

Product Availability

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

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

delete

public void delete()
            throws IOException,
                   AutomationException
Deletes the pattern model.

Description

This method automatically removes the association between this pattern model object and:

- the element types which it was associated with,

- the links it was assigned

Product Availability

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

Specified by:
delete in interface INgPatternModel
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgLink.removePatternModel(com.esri.arcgis.schematic.INgPatternModel), INgElementType.removePatternModel(com.esri.arcgis.schematic.INgPatternModel)

getProject

public INgProject getProject()
                      throws IOException,
                             AutomationException
Project of the pattern model.

Product Availability

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

Specified by:
getProject in interface INgPatternModel
Returns:
A reference to a com.esri.arcgis.schematic.INgProject
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