com.softwareag.cis.plugin.item
Interface Item


public interface Item

Implementors of this interface represents a visual component in the Pluggable UI context


Field Summary
static java.lang.String rcs_id
           
 
Method Summary
 java.util.Collection getChildren()
          Get (optionally cached) collection of child items - equivalent to getChildren(false)
 java.util.Collection getChildren(boolean refresh)
          Get (optionally cached) collection of child items
 java.util.List getCommands()
          Get list of commands available for the current object
 Command getDefaultCommand()
           
 java.lang.String getImageURL()
          Get URL of icon to be used for rendering of item.
 Item getItem()
           
 java.util.Locale getLocale()
          Get Locale
 java.lang.String getName()
          Get localized name of item
 boolean hasChildren()
           
 boolean mayHaveChildren()
          Check whether this node may have children
 

Field Detail

rcs_id

static final java.lang.String rcs_id
See Also:
Constant Field Values
Method Detail

getName

java.lang.String getName()
                         throws java.lang.Exception
Get localized name of item

Returns:
the name
Throws:
java.lang.Exception

getImageURL

java.lang.String getImageURL()
                             throws java.lang.Exception
Get URL of icon to be used for rendering of item. Normally should be non-null.

Returns:
the URL
Throws:
java.lang.Exception

getCommands

java.util.List getCommands()
Get list of commands available for the current object

Returns:
the list of commands

getDefaultCommand

Command getDefaultCommand()
Returns:
Returns the defaultCommand.

getLocale

java.util.Locale getLocale()
Get Locale

Returns:
the Locale used for this Item

getItem

Item getItem()
Returns:
the item - may be a wrapped object if this is a proxy item otherwise the reference to this Item is returned. This mechanism is especially helpful as support for server side scrolling

mayHaveChildren

boolean mayHaveChildren()
Check whether this node may have children

Returns:
true if this node may have children

hasChildren

boolean hasChildren()
                    throws java.lang.Exception
Returns:
true if this item has children
Throws:
java.lang.Exception

getChildren

java.util.Collection getChildren()
                                 throws java.lang.Exception
Get (optionally cached) collection of child items - equivalent to getChildren(false)

Returns:
the collection of child items
Throws:
java.lang.Exception

getChildren

java.util.Collection getChildren(boolean refresh)
                                 throws java.lang.Exception
Get (optionally cached) collection of child items

Parameters:
refresh - if true, recomputation of child nodes is enforced
Returns:
the collection of child items
Throws:
java.lang.Exception