com.esri.arcgis.schematic
Interface INgDiagramFlagManager

All Superinterfaces:
Serializable
All Known Implementing Classes:
INgDiagramFlagManagerProxy, NgDiagram

public interface INgDiagramFlagManager
extends Serializable

Provides access to members that control the management of the flags in the diagrams.

Description

In this Schematics version, two type of flags can be positionned in a diagram: the flag that defines a schematic root element and the flag that defines the schematic end node element.

Product Availability

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


Method Summary
 void addFlag(String flagTypeName, INgElement element)
          Sets a flag based on the 'FlagTypeName' type on the 'Element' element.
 INgElements getFlaggedElements(String flagTypeName)
          List of the elements that are indicated by a flag based on the 'FlagTypeName' type.
 boolean isFlagged(String flagTypeName, INgElement element)
          Indicates if there is a flag based on the 'FlagTypeName' type on the 'Element' element.
 boolean isHighlightFlags(String flagTypeName)
          Indicates if the elements with a flag based on the 'FlagTypeName' type are currently highlighted.
 void removeAllFlags(String flagTypeName)
          Unsets all the flags based on the 'FlagTypeName' type in the diagrams.
 void removeFlag(String flagTypeName, INgElement element)
          Unsets the flag based on the 'FlagTypeName' type for the 'Element' element.
 void setHighlightFlags(String flagTypeName, boolean highlight)
          Indicates if the elements with a flag based on the 'FlagTypeName' type are currently highlighted.
 

Method Detail

addFlag

void addFlag(String flagTypeName,
             INgElement element)
             throws IOException,
                    AutomationException
Sets a flag based on the 'FlagTypeName' type on the 'Element' element.

Product Availability

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

Parameters:
flagTypeName - The flagTypeName (in)
element - A reference to a com.esri.arcgis.schematic.INgElement (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgDiagramFlagManager.removeFlag(String, com.esri.arcgis.schematic.INgElement)

removeFlag

void removeFlag(String flagTypeName,
                INgElement element)
                throws IOException,
                       AutomationException
Unsets the flag based on the 'FlagTypeName' type for the 'Element' element.

Product Availability

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

Parameters:
flagTypeName - The flagTypeName (in)
element - A reference to a com.esri.arcgis.schematic.INgElement (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgDiagramFlagManager.removeAllFlags(String), INgDiagramFlagManager.addFlag(String, com.esri.arcgis.schematic.INgElement)

removeAllFlags

void removeAllFlags(String flagTypeName)
                    throws IOException,
                           AutomationException
Unsets all the flags based on the 'FlagTypeName' type in the diagrams.

Product Availability

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

Parameters:
flagTypeName - The flagTypeName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgDiagramFlagManager.removeFlag(String, com.esri.arcgis.schematic.INgElement)

isFlagged

boolean isFlagged(String flagTypeName,
                  INgElement element)
                  throws IOException,
                         AutomationException
Indicates if there is a flag based on the 'FlagTypeName' type on the 'Element' element.

Product Availability

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

Parameters:
flagTypeName - The flagTypeName (in)
element - A reference to a com.esri.arcgis.schematic.INgElement (in)
Returns:
The isFlagged
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHighlightFlags

void setHighlightFlags(String flagTypeName,
                       boolean highlight)
                       throws IOException,
                              AutomationException
Indicates if the elements with a flag based on the 'FlagTypeName' type are currently highlighted.

Product Availability

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

Parameters:
flagTypeName - The flagTypeName (in)
highlight - The highlight (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isHighlightFlags

boolean isHighlightFlags(String flagTypeName)
                         throws IOException,
                                AutomationException
Indicates if the elements with a flag based on the 'FlagTypeName' type are currently highlighted.

Product Availability

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

Parameters:
flagTypeName - The flagTypeName (in)
Returns:
The highlight
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFlaggedElements

INgElements getFlaggedElements(String flagTypeName)
                               throws IOException,
                                      AutomationException
List of the elements that are indicated by a flag based on the 'FlagTypeName' type.

Product Availability

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

Parameters:
flagTypeName - The flagTypeName (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.