com.esri.arcgis.carto
Interface IGraphicsContainer

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
CompositeGraphicsLayer, FDOGraphicsLayer, GlobeGraphicsLayer, GraphicsLayer3D, GraphicsSubLayer, IGraphicsContainerProxy, Map, PageLayout

public interface IGraphicsContainer
extends java.io.Serializable

COM Interface 'IGraphicsContainer'. Generated 3/19/2015 1:20:51 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to members that control the Graphics Container.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IIDd09411d1_4bb4_11d1_b6cc_080009b996cc
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void addElement(IElement element, int zorder)
          Add a new graphic element to the layer.
 void addElements(IElementCollection elements, int zorder)
          Add new graphic elements to the layer.
 void bringForward(IEnumElement elements)
          Move the specified elements one step closer to the top of the stack of elements.
 void bringToFront(IEnumElement elements)
          Make the specified elements draw in front of all other elements.
 void deleteAllElements()
          Delete all the elements.
 void deleteElement(IElement element)
          Delete the given element.
 IFrameElement findFrame(java.lang.Object frameObject)
          Find the frame that contains the specified object.
 java.lang.Object getElementOrder(IEnumElement elements)
          Private order object.
 IEnumElement locateElements(IPoint point, double tolerance)
          Returns the elements at the given coordinate.
 IEnumElement locateElementsByEnvelope(IEnvelope envelope)
          Returns the elements inside the given envelope.
 void moveElementFromGroup(IGroupElement group, IElement element, int zorder)
          Move the element from the group to the container.
 void moveElementToGroup(IElement element, IGroupElement group)
          Move the element from the container to the group.
 IElement next()
          Returns the next graphic in the container.
 void putElementOrder(java.lang.Object order)
          Private order object.
 void reset()
          Reset internal cursor so that Next returns the first element.
 void sendBackward(IEnumElement elements)
          Move the specified elements one step closer to the bottom of the stack of elements.
 void sendToBack(IEnumElement elements)
          Make the specified elements draw behind all other elements.
 void updateElement(IElement element)
          The graphic element's properties have changed.
 

Field Detail

IIDd09411d1_4bb4_11d1_b6cc_080009b996cc

static final int IIDd09411d1_4bb4_11d1_b6cc_080009b996cc
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

next

IElement next()
              throws java.io.IOException,
                     AutomationException
Returns the next graphic in the container.

Returns:
A reference to a com.esri.arcgis.carto.IElement
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

reset

void reset()
           throws java.io.IOException,
                  AutomationException
Reset internal cursor so that Next returns the first element.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addElement

void addElement(IElement element,
                int zorder)
                throws java.io.IOException,
                       AutomationException
Add a new graphic element to the layer.

Parameters:
element - A reference to a com.esri.arcgis.carto.IElement (in)
zorder - The zorder (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addElements

void addElements(IElementCollection elements,
                 int zorder)
                 throws java.io.IOException,
                        AutomationException
Add new graphic elements to the layer.

Parameters:
elements - A reference to a com.esri.arcgis.carto.IElementCollection (in)
zorder - The zorder (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteElement

void deleteElement(IElement element)
                   throws java.io.IOException,
                          AutomationException
Delete the given element.

Parameters:
element - A reference to a com.esri.arcgis.carto.IElement (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteAllElements

void deleteAllElements()
                       throws java.io.IOException,
                              AutomationException
Delete all the elements.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

moveElementToGroup

void moveElementToGroup(IElement element,
                        IGroupElement group)
                        throws java.io.IOException,
                               AutomationException
Move the element from the container to the group.

Parameters:
element - A reference to a com.esri.arcgis.carto.IElement (in)
group - A reference to a com.esri.arcgis.carto.IGroupElement (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

moveElementFromGroup

void moveElementFromGroup(IGroupElement group,
                          IElement element,
                          int zorder)
                          throws java.io.IOException,
                                 AutomationException
Move the element from the group to the container.

Parameters:
group - A reference to a com.esri.arcgis.carto.IGroupElement (in)
element - A reference to a com.esri.arcgis.carto.IElement (in)
zorder - The zorder (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

locateElements

IEnumElement locateElements(IPoint point,
                            double tolerance)
                            throws java.io.IOException,
                                   AutomationException
Returns the elements at the given coordinate.

Parameters:
point - A reference to a com.esri.arcgis.geometry.IPoint (in)
tolerance - The tolerance (in)
Returns:
A reference to a com.esri.arcgis.carto.IEnumElement
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

locateElementsByEnvelope

IEnumElement locateElementsByEnvelope(IEnvelope envelope)
                                      throws java.io.IOException,
                                             AutomationException
Returns the elements inside the given envelope.

Parameters:
envelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Returns:
A reference to a com.esri.arcgis.carto.IEnumElement
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findFrame

IFrameElement findFrame(java.lang.Object frameObject)
                        throws java.io.IOException,
                               AutomationException
Find the frame that contains the specified object.

Parameters:
frameObject - A Variant (in)
Returns:
A reference to a com.esri.arcgis.carto.IFrameElement
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateElement

void updateElement(IElement element)
                   throws java.io.IOException,
                          AutomationException
The graphic element's properties have changed.

Parameters:
element - A reference to a com.esri.arcgis.carto.IElement (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getElementOrder

java.lang.Object getElementOrder(IEnumElement elements)
                                 throws java.io.IOException,
                                        AutomationException
Private order object. Used to undo ordering operations.

Parameters:
elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

putElementOrder

void putElementOrder(java.lang.Object order)
                     throws java.io.IOException,
                            AutomationException
Private order object. Used to undo ordering operations.

Parameters:
order - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

bringToFront

void bringToFront(IEnumElement elements)
                  throws java.io.IOException,
                         AutomationException
Make the specified elements draw in front of all other elements.

Parameters:
elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

sendToBack

void sendToBack(IEnumElement elements)
                throws java.io.IOException,
                       AutomationException
Make the specified elements draw behind all other elements.

Parameters:
elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

sendBackward

void sendBackward(IEnumElement elements)
                  throws java.io.IOException,
                         AutomationException
Move the specified elements one step closer to the bottom of the stack of elements.

Parameters:
elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

bringForward

void bringForward(IEnumElement elements)
                  throws java.io.IOException,
                         AutomationException
Move the specified elements one step closer to the top of the stack of elements.

Parameters:
elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.