|
Oracle Fusion Middleware extensions for Applications Core API Reference 11g Release 1 (11.1.1.5) E22562-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.apps.fnd.applcore.globalSearch.ui.TreeItem
public class TreeItem
A node in a JSF tree, used in the attributes and topics trees.
Field Summary | |
---|---|
static int |
NO_RESULT_COUNT_AVAILABLE
No result count is known. |
Constructor Summary | |
---|---|
TreeItem(SearchFilterItem.FilterType filterType,
java.lang.String displayValue,
java.lang.String value)
Construct this tree item. |
|
TreeItem(SearchFilterItem.FilterType filterType,
java.lang.String displayValue,
java.lang.String value,
int resultCount,
java.util.Map<java.lang.String,java.lang.String> additionalInfo)
Construct this tree item. |
|
TreeItem(SearchFilterItem.FilterType filterType,
java.lang.String displayValue,
java.lang.String value,
java.lang.String toolTip,
boolean leafFI,
boolean queriedForChildren,
int resultCount,
java.util.Map<java.lang.String,java.lang.String> additionalInfo)
Construct this tree item. |
Method Summary | |
---|---|
TreeItem |
addOrderedChild(TreeItem newItem)
Add the passed newItem as a child in lexographic order per the DisplayValue attribute. |
boolean |
equals(java.lang.Object obj)
|
java.lang.String |
getAdditionalItem(java.lang.String key)
Get an additional item added to this tree node. |
TreeItem |
getCategory()
Get the category for the tree item. |
java.util.List<TreeItem> |
getChildren()
Get the children of this TreeItem. |
TreeItem |
getChildSearchableObject(java.lang.String soName)
Get the child Searchable Object for this node, which must be a CATEGORY node. |
java.lang.String |
getDisplayValue()
Get the text attribute. |
java.lang.String |
getDisplayValueWithCount()
Get the display value including count (if available) in brackets. |
TreeItem |
getFacet()
Get the Facet value for this subtree. |
SearchFilterItem.FilterType |
getFilterType()
Get the type filter for the tree item. |
java.lang.String |
getIcon()
Is there an icon for this TreeItem? The icon will be provided by css styleclass fndGlobalSearchRemoveFilterIcon. |
static TreeItem |
getLeafFacetNode(SearchFilterItems filterItems,
TreeItem nodeToCheck)
Get the leaf node of an existing filter given an arbitrary node that may be selected. |
TreeItem |
getParent()
Get this nodes parent node. |
int |
getResultCount()
Get the result Count for this Tree Item. |
TreeItem |
getSearchableObject()
Get the searchable object for the tree item. |
java.lang.String |
getToolTip()
Get the toolTip for this item. |
java.lang.String |
getValue()
Get the value attribute. |
int |
hashCode()
|
boolean |
hasSameTreePath(TreeItem that)
Does this TreeItem have the same tree path (all the way to the root of the tree) as that does. |
boolean |
isBranch()
Is this a branch node (does it have children)? |
boolean |
isFolderIcon()
Should a folder Icon be shown for this node in the tree. |
boolean |
isLeafFI()
Is this a leaf Facet Item. |
boolean |
isQueriedForChildren()
Have we queried for children? Relevant when this node is of type Searchable Object of Facet Item. |
TreeItem |
replaceOrAppendChild(TreeItem newItem)
Add the passed newItem as a child at the end of the list if it does not exist already (based on a comparison of the DisplayValue attribute). |
void |
setQueriedForChildren()
Set flag indicating we have queried for children. |
void |
setResultCount(int resultCount)
Set the result count. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int NO_RESULT_COUNT_AVAILABLE
Constructor Detail |
---|
public TreeItem(SearchFilterItem.FilterType filterType, java.lang.String displayValue, java.lang.String value)
filterType
- type of filter.displayValue
- text of node (shown to user).value
- value of node (internal code value).public TreeItem(SearchFilterItem.FilterType filterType, java.lang.String displayValue, java.lang.String value, int resultCount, java.util.Map<java.lang.String,java.lang.String> additionalInfo)
filterType
- type of filter.displayValue
- text of node (shown to user).value
- value of node (internal code value).resultCount
- number of results, -1 means not known.additionalInfo
- additional information to be stored on the node.public TreeItem(SearchFilterItem.FilterType filterType, java.lang.String displayValue, java.lang.String value, java.lang.String toolTip, boolean leafFI, boolean queriedForChildren, int resultCount, java.util.Map<java.lang.String,java.lang.String> additionalInfo)
filterType
- type of filter.displayValue
- text of node (shown to user).value
- value of node (internal code value).toolTip
- tool tip to show in UI.leafFI
- are we a leaf facet item, as known by ECSF Metadata.queriedForChildren
- in cases where leafFI is false, have we queried
for the child facet items.resultCount
- number of results, possibly NO_RESULT_COUNT_AVAILABLE.additionalInfo
- additional information to be stored on the node.Method Detail |
---|
public java.lang.String getAdditionalItem(java.lang.String key)
key
- key to obtain it from.
public java.lang.String getDisplayValue()
public java.lang.String getDisplayValueWithCount()
public java.lang.String getValue()
public TreeItem getFacet()
public TreeItem getCategory()
public TreeItem getSearchableObject()
public TreeItem getChildSearchableObject(java.lang.String soName)
soName
- name of SO.
public TreeItem addOrderedChild(TreeItem newItem)
TreeItem fei = new TreeItem( ... );
fei = facetTreeItem.addOrderedChild(fei);
use fei ...
is useful.
newItem
- potential new item to add.
public TreeItem replaceOrAppendChild(TreeItem newItem)
TreeItem fei = new TreeItem( ... );
fei = facetTreeItem.replaceOrAppendChild(fei);
use fei ...
is useful.
newItem
- potential new item to add.
public java.util.List<TreeItem> getChildren()
public static TreeItem getLeafFacetNode(SearchFilterItems filterItems, TreeItem nodeToCheck)
filterItems
- the list of filter items in the treenodeToCheck
- the node to test
public java.lang.String getIcon()
public boolean isBranch()
public boolean isFolderIcon()
public TreeItem getParent()
public SearchFilterItem.FilterType getFilterType()
public boolean hasSameTreePath(TreeItem that)
that
- another node to check.
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public java.lang.String getToolTip()
public void setResultCount(int resultCount)
resultCount
- new result count.public boolean isLeafFI()
public void setQueriedForChildren()
public boolean isQueriedForChildren()
public int getResultCount()
|
Oracle Fusion Middleware extensions for Applications Core API Reference 11g Release 1 (11.1.1.5) E22562-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |