getIteratorForAllOpenHierarchyLevels (webtop script and webtop tray applets)

Syntax

String getIteratorForAllOpenHierarchyLevels(String iteratorContentType)

Description

Returns a handle to an iterator that can parse all the objects the webtop script applet currently knows about. This is useful if you want to manipulate multiple webtop objects.

iteratorContentType is the type of object to be parsed using the iterator, and may be "GROUPTYPE", "ALLTYPE", "APPLICATIONTYPE", or "DOCUMENTTYPE".

This method can be used with either the webtop script applet or the webtop tray applet.

Examples

iterator = applet.getIteratorForAllOpenHierarchyLevels("ALLTYPE");

while (applet.getIteratorHasMoreElements(iterator) == "TRUE") {

  current = applet.getNextIteratorElement(iterator);
}

Shows how you can iterate through all objects on all open levels in sequential order.

Note The code doesn't form a complete example. You'll need to add your own code and adapt it to produce a working example.

Related topics
  • Webtop script applet
  • Webtop tray applet
  • openHierarchyLevel (webtop script and webtop tray applets)
  • getCurrentIteratorElement (webtop script and webtop tray applets)
  • getNextIteratorElement (webtop script and webtop tray applets)
  • getIteratorHasMoreElements (webtop script and webtop tray applets)
  • getIteratorForHierarchyLevel (webtop script and webtop tray applets)
  • killIterator (webtop script and webtop tray applets)