oracle.apps.fnd.applcore.globalSearch.ui.commonTree
Class BaseTreeItem

java.lang.Object
  oracle.apps.fnd.applcore.globalSearch.ui.commonTree.BaseTreeItem

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

DateRangeTreeItem, FolderTreeItem

public abstract class BaseTreeItem
extends java.lang.Object
implements java.io.Serializable

A node in a JSF tree, used in the common filters tree.

Author:

David Groves <david.groves@oracle.com>

See Also:

Serialized Form

Constructor Summary

BaseTreeItem(java.lang.String value, java.lang.String displayValue, java.lang.String toolTip)
Construct this tree item.

Method Summary

boolean	equals(java.lang.Object obj)
java.util.List<BaseTreeItem>	getChildren() Get the children of this TreeItem.
static java.util.List<BaseTreeItem>	getDefaultCommonTreeItems() Get a list of default filters, these filters may be modified, added to, deleted etc.
java.lang.String	getDisplayValue() Get the display value.
abstract SearchFilterItem.FilterType	getFilterType() What type of Filter type this Tree Item represents.
java.lang.String	getToolTip() Get the toolTip for this item.
java.lang.String	getValue() Get the value.
int	hashCode()
boolean	isBranch() Is this a branch node (does it have children)?
boolean	isCustomRange() Does this TreeItem represent a custom range, if so more ui will be needed to render from/to values in the ui, instead of a single selectable string.
boolean	isSelectable() Is this node selectedable.
boolean	isSelected() Is this node selected.
boolean	isSomeUserData() Does this node have some user-data? This hint allows the tree to auto-disclose some nodes with user-modified data.
SearchFilterItem	toSearchFilterItem() Create an appropriate SearchFilterItem for this tree item..

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseTreeItem

public BaseTreeItem(java.lang.String value,
                    java.lang.String displayValue,
                    java.lang.String toolTip)

Construct this tree item.

Method Detail

isCustomRange

public boolean isCustomRange()

Does this TreeItem represent a custom range, if so more ui will be needed to render from/to values in the ui, instead of a single selectable string.

Returns:

true if a custom range, false if just a selectable value.

getDisplayValue

public java.lang.String getDisplayValue()

Get the display value.

Returns:

display value.

getValue

public java.lang.String getValue()

Get the value.

Returns:

value.

getToolTip

public java.lang.String getToolTip()

Get the toolTip for this item.

Returns:

toolTip for this item.

getChildren

public java.util.List<BaseTreeItem> getChildren()

Get the children of this TreeItem. Usef by the JSF tree via the children property.

Returns:

children list, never null but may be empty.

isBranch

public boolean isBranch()

Is this a branch node (does it have children)?

Returns:

true if has children, false otherwise.

isSelected

public boolean isSelected()

Is this node selected.

Returns:

true if we are to show selection icon.

isSelectable

public boolean isSelectable()

Is this node selectedable.

Returns:

true if we are to sselect this node and have something happen.

toSearchFilterItem

public SearchFilterItem toSearchFilterItem()

Create an appropriate SearchFilterItem for this tree item..

Returns:

appropriate SearchFilterItem.

getFilterType

public abstract SearchFilterItem.FilterType getFilterType()

What type of Filter type this Tree Item represents.

Returns:

FilterType

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getDefaultCommonTreeItems

public static java.util.List<BaseTreeItem> getDefaultCommonTreeItems()

Get a list of default filters, these filters may be modified, added to, deleted etc.

Returns:

modifyable list of DateRangeFilters.

isSomeUserData

public boolean isSomeUserData()

Does this node have some user-data? This hint allows the tree to auto-disclose some nodes with user-modified data.

Returns:

true if there is some user-entered (and hence to-be displayed) data.