Detailed Description

This group contains methods for adding and deleting objects from a Container.

These methods may be used to add objects or popup dialogs to the drawing at run time, well as adding points to a polygon.

The Container Methods of the Intermediate API may be used to access elements of a container.

The following files in the GLG installation directory provide examples of using container methods of the Extended API:

DEMOS_JAVA/GlgAirTrafficDemo.java provides an example of adding dynamic aircraft icons to the drawing at run time.
DEMOS_JAVA/GlgDiagram.java provides an example of adding objects from a palette using a point-and-click interface.
DEMOS_JAVA/GlgSatelliteDemo.java provides an example of adding points to a polygon at run time.

Functions
boolean	AddObject (Object object, GlgAccessType access_type, GlgPositionModifier pos_modifier)
	A generic method for adding an object to the container. More...

boolean	AddObjectAt (Object object, int index)
	Adds an object at the specified position inside the container. More...

boolean	AddObjectToBottom (Object object)
	Adds an object at the end of the container. More...

boolean	AddObjectToTop (Object object)
	Adds an object at the beginning of the container. More...

boolean	DeleteBottomObject ()
	Deletes an object from the bottom of the container. More...

boolean	DeleteObject (GlgAccessType access_type, GlgPositionModifier pos_modifier, boolean replace_element, Object replace_obj)
	A generic method for deleting an object from the container. More...

boolean	DeleteObject (Object object)
	Finds and deletes an object from the container. More...

boolean	DeleteObjectAt (int index)
	Deletes an object from the specified position in the container. More...

boolean	DeleteTopObject ()
	Deletes an object from the beginning of the container. More...

void	Flush (int size)
	Set the size of the container object. More...

boolean	SetElement (int index, Object new_object)
	Replaces the object at the specified position in the container. More...

Function Documentation

◆ AddObject()

boolean AddObject	(	Object	object,
		GlgAccessType	access_type,
		GlgPositionModifier	pos_modifier
	)

A generic method for adding an object to the container.

Parameters

object	The object to be added.
access_type	The position at which the object is inserted: TOP adds the object at the beginning of the object list BOTTOM adds the object at the end of the object list CURRENT adds the object at the current position.
pos_modifier	Is used only with the CURRENT access type to control where the object is added (use 0 for other access types): BEFORE - adds object before the object defined by the current position. AFTER adds the object after the object defined by the current position.

Returns: Success or failure status.

A container object keeps an internal current position pointer, which is set by a successful call to a method that accesses an element, such as GetElement, GetIndex, GetNamedObject, GetStringIndex or ContainsObject.

For a call to AddObject immediately following the call to one of the element access methods, the pos_modifier parameter defines where to add the new object: right before or right after the object pointed to by the current position.

The position modifier also defines how the insert position defined by the current position pointer is adjusted after the insertion:

for BEFORE, the current position is left unchanged
for AFTER, the current position is incremented by 1.

This allows you to call AddObject repeatedly after an initial call to one of the element access methods.

For example, the following sequence of calls adds three objects before the target_object:

if( container.GetIndex( target_object ) != -1 )
{
   container.GlgAddObject( object_1, GlgObject.CURRENT, GlgObject.BEFORE );
   container.GlgAddObject( object_2, GlgObject.CURRENT, GlgObject.BEFORE );
   container.GlgAddObject( object_3, GlgObject.CURRENT, GlgObject.BEFORE );
}

The following sequence adds three objects after the target_object:

if( container.GetIndex( target_object ) != -1 )
{
   container.GlgAddObject( object_1, GlgObject.CURRENT, GlgObject.AFTER );
   container.GlgAddObject( object_2, GlgObject.CURRENT, GlgObject.AFTER );
   container.GlgAddObject( object_3, GlgObject.CURRENT, GlgObject.AFTER );
}

Note: Any method calls that access, add or delete elements of the container may affect its current position pointer. The current position pointer must be used immediately after the method call that accesses a container's element.

◆ AddObjectAt()

boolean AddObjectAt	(	Object	object,
		int	index
	)

Adds an object at the specified position inside the container.

Parameters

object	The object to be added.
index	The position in a container.

Returns: Success or failure status.

This method can be used to add objects to the drawing at run time. If the method is invoked on a viewport or a group inside a viewport, you may add any graphical object to it. An attempt to add a non-graphical object to a viewport or a group inside a viewport will generate an error message.

The method can be invoked on a polygon object to add points to it. An attempt to add an object different from a point (an Attribute object of a G (geometrical) data type) to a polygon will generate an error message.

The method can also be invoked on a GIS Object object to add dynamic icons to be displayed on top of the map in lat/lon coordinates.

Objects at the end (the bottom) of the container are drawn last and will appear in front of other objects.

Note: For viewports with integrated scrolling enabled by the viewport's Pan attribute, child viewport objects added to the bottom of the viewport object list will appear in front of the integrated scrollbars until the viewport is reset. Other graphical objects added to the bottom of the container will also appear on top of the integrated scrollbars that use light viewports. Resetting the viewport reorders the scrollbars to be the last in the object list. To achieve proper rendering without resetting the viewport, use AddObjectAt to add the child viewport at a proper position before the integrated scrollbars. If a single X or Y scrollbar is used, the position index will be list_size - 1, where list_size is the number of objects in the viewport. If both X and Y scrollbars are active, list_size - 3 position should be used.

◆ AddObjectToBottom()

boolean AddObjectToBottom ( Object object )

Adds an object at the end of the container.

Parameters

object The object to be added.

Returns: Success or failure status.

This method can be used to add objects to the drawing at run time. If the method is invoked on a viewport or a group inside a viewport, you may add any graphical object to it. An attempt to add a non-graphical object to a viewport or a group inside a viewport will generate an error message.

The method can be invoked on a polygon object to add points to it. An attempt to add an object different from a point (an Attribute object of a G (geometrical) data type) to a polygon will generate an error message.

The method can also be invoked on a GIS Object object to add dynamic icons to be displayed on top of the map in lat/lon coordinates.

Objects at the end (the bottom) of the container are drawn last and will appear in front of other objects.

Note: For viewports with integrated scrolling enabled by the viewport's Pan attribute, child viewport objects added to the bottom of the viewport object list will appear in front of the integrated scrollbars until the viewport is reset. Other graphical objects added to the bottom of the container will also appear on top of the integrated scrollbars that use light viewports. Resetting the viewport reorders the scrollbars to be the last in the object list. To achieve proper rendering without resetting the viewport, use AddObjectAt to add the child viewport at a proper position before the integrated scrollbars. If a single X or Y scrollbar is used, the position index will be list_size - 1, where list_size is the number of objects in the viewport. If both X and Y scrollbars are active, list_size - 3 position should be used.

◆ AddObjectToTop()

boolean AddObjectToTop ( Object object )

Adds an object at the beginning of the container.

Parameters

object The object to be added.

Returns: Success or failure status.

This method can be used to add objects to the drawing at run time. If the method is invoked on a viewport or a group inside a viewport, you may add any graphical object to it. An attempt to add a non-graphical object to a viewport or a group inside a viewport will generate an error message.

The method can be invoked on a polygon object to add points to it. An attempt to add an object different from a point (an Attribute object of a G (geometrical) data type) to a polygon will generate an error message.

The method can also be invoked on a GIS Object object to add dynamic icons to be displayed on top of the map in lat/lon coordinates.

Objects at the beginning (the top) of the container are drawn first and will appear behind of other objects.

◆ DeleteBottomObject()

boolean DeleteBottomObject ( )

Deletes an object from the bottom of the container.

Returns: Success or failure status.

Note: For viewports with integrated scrolling enabled by the viewport's Pan attribute, the last object in the viewport is one of the integrated scrollbars. Use DeleteObject to avoid interfering with the viewport's integrated scrollbars.

◆ DeleteObject() [1/2]

boolean DeleteObject	(	GlgAccessType	access_type,
		GlgPositionModifier	pos_modifier,
		boolean	replace_element,
		Object	replace_obj
	)

A generic method for deleting an object from the container.

Parameters

access_type	The position of the object to be deleted: TOP deletes the object at the beginning of the object list BOTTOM deletes the object at the end of the object list CURRENT deletes the object at the current position.
pos_modifier	Is used only with the CURRENT access type to define how to adjust the current position after the delete operation, use 0 for other access types. This parameter allows to use the method repeatedly to delete several objects before or after the object defined by the current position: BEFORE moves the current position pointer to the previous object in the list AFTER moves the current position pointer to the next object in the list.
replace_element	If true, the targeted element will be replaced with the value of the replace_obj parameter. If false, the targeted element will be deleted.
replace_obj	The object to replace the targeted element with if replace_element=true.

Returns: Success or failure status.

A container object keeps an internal current position pointer, which is set by a successful call to a method that accesses an element, such as GetElement, GetIndex, GetNamedObject, GetStringIndex or ContainsObject.

For example, the following sequence of calls deletes target_object and the two objects after it:

if( container.GetIndex( target_object ) != -1 )
{
   container.DeleteObject( null, GlgObject.CURRENT, GlgObject.AFTER, false, null );
   container.DeleteObject( null, GlgObject.CURRENT, GlgObject.AFTER, false, null );
   container.DeleteObject( null, GlgObject.CURRENT, GlgObject.AFTER, false, null );
}

The following sequence deletes the target_object and the two objects before it:

if( container.GetIndex( target_object ) != -1 )
{
   container.DeleteObject( null, GlgObject.CURRENT, GlgObject.BEFORE, false, null );
   container.DeleteObject( null, GlgObject.CURRENT, GlgObject.BEFORE, false, null );
   container.DeleteObject( null, GlgObject.CURRENT, GlgObject.BEFORE, false, null );
}

Note: Any method calls that access, add or delete elements of the container may affect its current position pointer. The current position pointer must be used immediately after the method call that accesses a container's element.

◆ DeleteObject() [2/2]

boolean DeleteObject ( Object object )

Finds and deletes an object from the container.

Parameters

object An object to be deleted.

Returns: true if the object was successfully deleted. If the object was not found, the method returns false without generating an error message.

◆ DeleteObjectAt()

boolean DeleteObjectAt ( int index )

Deletes an object from the specified position in the container.

Parameters

index An index of the object to be deleted.

Returns: Success or failure status.

◆ DeleteTopObject()

boolean DeleteTopObject ( )

Deletes an object from the beginning of the container.

Returns: Success or failure status.

◆ Flush()

void Flush ( int size )

Set the size of the container object.

Parameters

size	The new size.

This method sets the container size to the requested size. If the new size is less than the current container size, extra elements are removed. If the new size is greater than the current size, the method adds elements by making a copy of the last element in the container.

The method can only be invoked if the container has not been set up. If the container has been set up (drawn), the method must be surrounded by the SuspendObject and ReleaseObject calls.

◆ SetElement()

boolean SetElement	(	int	index,
		Object	new_object
	)

Replaces the object at the specified position in the container.

Parameters

index	An index of the element to be modified.
new_object	A new element value.

Returns: Success or failure status. If the specified index is invalid, an error message is generated and false is returned.

Detailed Description

Functions

Function Documentation

◆ AddObject()

◆ AddObjectAt()

◆ AddObjectToBottom()

◆ AddObjectToTop()

◆ DeleteBottomObject()

◆ DeleteObject() [1/2]

◆ DeleteObject() [2/2]

◆ DeleteObjectAt()

◆ DeleteTopObject()

◆ Flush()

◆ SetElement()