com.esri.arcgis.schematic
Class NgFlag

java.lang.Object
  com.esri.arcgis.schematic.NgFlag

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, INgFlag, Serializable

public class NgFlag
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INgFlag

Graphic flag object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

NgFlag(Object obj)
Construct a NgFlag using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

void	delete() Removes the flag.
boolean	equals(Object o) Compare this object with another
void	getBoundingBox(INgView view, INgPoint[] upperLeftCorner, INgPoint[] lowerRightCorner) Returns the 'upperLeftCorner' and 'lowerRightCorner' points defining the bounding box of the flag.
Object	getEffect(int effect) Returns the effect 'effect' set for the flag (see esriNgFlagEffect).
INgElement	getElement() Element the flag is attached to.
INgFlagModel	getFlagModel() Flag model that implements the flag.
INgPole	getPole() Pole connecting the flag to the element it is attached to.
double	getX() X cartesian coordinate of the flag.
double	getY() Y cartesian coordinate of the flag.
int	hashCode() the hashcode for this object
boolean	isEffectSet(int effect) Indicates if the effect 'effect' related to the flag is set (see esriNgFlagEffect).
boolean	isMoved() Indicates if the flag has been moved.
boolean	isSelected() Indicates if the flag is currently selected.
void	move(double x, double y, int moveMode) Moves the flag to the (X,Y) relative or absolute position.
void	removeEffect(int effect) Removes the effect or restores the default effect 'effect' set for the flag (see esriNgFlagEffect).
void	select(boolean redraw) Selects the flag in all the views where it displays and redraws it.
void	setEffect(int effect, Object effValue) Modifies the effect 'effect' set for the flag (see esriNgFlagEffect).
void	unselect(boolean redraw) Deselects the flag in all the views where it displays and redraws it.

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

NgFlag

public NgFlag(Object obj)
       throws IOException

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

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

Throws:

IOException - if there are interop problems NgFlag theNgFlag = (NgFlag) 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

getFlagModel

public INgFlagModel getFlagModel()
                          throws IOException,
                                 AutomationException

Flag model that implements the flag.

Product Availability

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

Specified by:

getFlagModel in interface INgFlag

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getX

public double getX()
            throws IOException,
                   AutomationException

X cartesian coordinate of the flag.

Product Availability

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

Specified by:

getX in interface INgFlag

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getY

public double getY()
            throws IOException,
                   AutomationException

Y cartesian coordinate of the flag.

Product Availability

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

Specified by:

getY in interface INgFlag

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getElement

public INgElement getElement()
                      throws IOException,
                             AutomationException

Element the flag is attached to.

Product Availability

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

Specified by:

getElement in interface INgFlag

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.

getPole

public INgPole getPole()
                throws IOException,
                       AutomationException

Pole connecting the flag to the element it is attached to.

Product Availability

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

Specified by:

getPole in interface INgFlag

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

move

public void move(double x,
                 double y,
                 int moveMode)
          throws IOException,
                 AutomationException

Moves the flag to the (X,Y) relative or absolute position.

Description

The values taken by the moveMode parameter are detailed in the esriNgMoveMode section. The default value for moveMode is esriNgAbsoluteMove, which means that, by default, the flag is moved to the (X,Y) absolute position.

NOTE: When an element is moved, its associated flag(s) is/are automatically moved. However, moving a flag does not move the element, but causes its connecting pole to be redrawn.

Product Availability

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

Specified by:

move in interface INgFlag

Parameters:

x - The x (in)

y - The y (in)

moveMode - A com.esri.arcgis.schematic.esriNgMoveMode constant (in, optional, pass 2085 if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgFlag.isMoved()

delete

public void delete()
            throws IOException,
                   AutomationException

Removes the flag.

Product Availability

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

Specified by:

delete in interface INgFlag

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 (see esriNgFlagEffect).

Product Availability

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

Specified by:

getEffect in interface INgFlag

Parameters:

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

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

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

setEffect

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

Modifies the effect 'effect' set for the flag (see esriNgFlagEffect).

Product Availability

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

Specified by:

setEffect in interface INgFlag

Parameters:

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

effValue - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

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

removeEffect

public void removeEffect(int effect)
                  throws IOException,
                         AutomationException

Removes the effect or restores the default effect 'effect' set for the flag (see esriNgFlagEffect).

Description

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

Product Availability

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

Specified by:

removeEffect in interface INgFlag

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

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

isEffectSet

public boolean isEffectSet(int effect)
                    throws IOException,
                           AutomationException

Indicates if the effect 'effect' related to the flag is set (see esriNgFlagEffect).

Description

By default, Schematics automatically sets default values for some flag effects (see the List of the flag 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 effect default values

esriNgFlagDetectability: esriNgDetectable

esriNgFlagHighlightedState: esriNgNotHighlighted

esriNgFlagPriority: 301 or more

esriNgFlagSelectability: esriNgSelectable

esriNgFlagVisibility: esriNgVisible

esriNgFlagMobility: esriNgMovable

esriNgFlagResizability: esriNgResizable

For more details, see Flag Effects Constants Definition.

Product Availability

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

Specified by:

isEffectSet in interface INgFlag

Parameters:

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

Returns:

The isSet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

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

getBoundingBox

public void getBoundingBox(INgView view,
                           INgPoint[] upperLeftCorner,
                           INgPoint[] lowerRightCorner)
                    throws IOException,
                           AutomationException

Returns the 'upperLeftCorner' and 'lowerRightCorner' points defining the bounding box of the flag.

Product Availability

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

Specified by:

getBoundingBox in interface INgFlag

Parameters:

view - A reference to a com.esri.arcgis.schematic.INgView (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.

isSelected

public boolean isSelected()
                   throws IOException,
                          AutomationException

Indicates if the flag is currently selected.

Product Availability

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

Specified by:

isSelected in interface INgFlag

Returns:

The isSelected

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgFlag.unselect(boolean), INgFlag.select(boolean)

select

public void select(boolean redraw)
            throws IOException,
                   AutomationException

Selects the flag in all the views where it displays and redraws it.

Product Availability

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

Specified by:

select in interface INgFlag

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgFlag.isSelected(), INgFlag.unselect(boolean)

unselect

public void unselect(boolean redraw)
              throws IOException,
                     AutomationException

Deselects the flag in all the views where it displays and redraws it.

Product Availability

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

Specified by:

unselect in interface INgFlag

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgFlag.isSelected(), INgFlag.select(boolean)

isMoved

public boolean isMoved()
                throws IOException,
                       AutomationException

Indicates if the flag has been moved.

Product Availability

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

Specified by:

isMoved in interface INgFlag

Returns:

The moved

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgFlag.move(double, double, int)