com.esri.arcgis.schematic
Class NgFlagModel

java.lang.Object
  extended by com.esri.arcgis.schematic.NgFlagModel
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, INgFlagModel, Serializable

public class NgFlagModel
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INgFlagModel

Graphic flag model object.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
NgFlagModel(Object obj)
          Construct a NgFlagModel using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 void delete()
          Deletes the flag model.
 boolean equals(Object o)
          Compare this object with another
 Object getEffect(int effect)
          Returns the effect 'effect' set for the flag model (see esriNgFlagModelEffect).
 String getName()
          Name of the flag model.
 INgProject getProject()
          Project of the flag model.
 int hashCode()
          the hashcode for this object
 boolean isEffectSet(int effect)
          Indicates if the effect 'effect' related to the flag model is set (see esriNgFlagModelEffect).
 void removeEffect(int effect)
          Removes the effect or restores the default effect 'effect' set for the flag model (see esriNgFlagModelEffect).
 void setEffect(int effect, Object effValue)
          Modifies the effect 'effect' set for the flag model (see esriNgFlagModelEffect).
 void setName(String pVal)
          Name of the flag model.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

NgFlagModel

public NgFlagModel(Object obj)
            throws IOException
Construct a NgFlagModel using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to NgFlagModel.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
NgFlagModel o = (NgFlagModel)obj; // will not work

NgFlagModel o = new NgFlagModel(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:
IOException - if there are interop problems NgFlagModel theNgFlagModel = (NgFlagModel) obj;
Method Detail

equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getName

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

Description

This name is defined when the flag model is created:

- either by calling the INgProjectBuilder CreateFlagModel method in the code,

- or when the flag model is created through ArcGIS Schematics Designer.

Product Availability

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

Specified by:
getName in interface INgFlagModel
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 flag model.

Product Availability

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

Specified by:
setName in interface INgFlagModel
Parameters:
pVal - The pVal (in)
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 flag model (see esriNgFlagModelEffect).

Product Availability

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

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

setEffect

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

Product Availability

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

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

removeEffect

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

Description

Note that removing an effect that is always set, returns to the default effect value and removing an effect that is not set by default, really removes the effect: the effect is not set any more!

Product Availability

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

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

isEffectSet

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

Description

By default, Schematics automatically sets default values for some flag model effects (see the List of the flag model effect default values, below). For all these effects, the IsEffectSet method returns TRUE. For the others effects (those that are not automatically set by Schematics), the IsEffectSet method returns TRUE only if the effect has been set either through Designer during its associated flag model effects definition, or when calling the SetEffect method in the code.


List of the flag model effect default values

esriNgFlagModelDetectability: esriNgDetectable

esriNgFlagModelHighlightedState: esriNgNotHighlighted

esriNgFlagModelPriority: 301 or more

esriNgFlagModelSelectability: esriNgSelectable

esriNgFlagModelVisibility: esriNgVisible

esriNgFlagModelMobility: esriNgMovable

esriNgFlagModelResizability: esriNgResizable

esriNgFlagModelPositionOnSegment: 0.5

esriNgFlagModelShiftAngle: 0

esriNgFlagModelShiftDistance: 0

esriNgFlagModelXShift: 0

esriNgFlagModelYShift: 0


For more details, see Flag Model Effects Constants Definition.

Product Availability

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

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

delete

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

Description

When deleting a flag model, the associations between this flag model object and the element types its was associated with, and the associations between this flag model object and the elements it was assigned to are automatically removed.

Product Availability

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

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

getProject

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

Product Availability

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

Specified by:
getProject in interface INgFlagModel
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.