Package org.glassfish.admingui.common.tree

Class FilterTreeEvent

java.lang.Object

java.util.EventObject

com.sun.jsftemplating.layout.event.EventObjectBase

org.glassfish.admingui.common.tree.FilterTreeEvent

All Implemented Interfaces:

com.sun.jsftemplating.layout.event.UIComponentHolder, Serializable

public class FilterTreeEvent
extends com.sun.jsftemplating.layout.event.EventObjectBase

Author:

Ken Paulsen (ken.paulsen@sun.com)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	EVENT_TYPE	The "filterTree" event type.

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
FilterTreeEvent(jakarta.faces.component.UIComponent component, List childObjects)	Constructor.

Method Summary

Modifier and Type	Method	Description
List	getChildObjects()	This method provides access to an array of Objects that are to become child TreeNodes.
protected void	setChildObjects(List objects)	This method is protected because it is only meaningful to set this array during the creation of this event.

Methods inherited from class com.sun.jsftemplating.layout.event.EventObjectBase

getUIComponent

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EVENT_TYPE

public static final String EVENT_TYPE

The "filterTree" event type. ("filterTree")

See Also:

Constant Field Values

Constructor Detail

FilterTreeEvent

public FilterTreeEvent(jakarta.faces.component.UIComponent component,
                       List childObjects)

Constructor.

Parameters:

component - The UIComponent associated with this EventObject.

Method Detail

getChildObjects

public List getChildObjects()

This method provides access to an array of Objects that are to become child TreeNodes. This allows you to manipluate them (filter them) before they are processed. You may return a new List from your handler that processes this event. Note that you NOT set the child object array using this event.

setChildObjects

protected void setChildObjects(List objects)

This method is protected because it is only meaningful to set this array during the creation of this event. Setting it any other time would not effect the original data structure and would serve no purpose. To provide a different object array, return a new Object[] from your handler that processes this event.