AsyncUniqueNode

java.lang.Object
- javax.swing.tree.DefaultMutableTreeNode
- - com.alee.laf.tree.UniqueNode
  - - com.alee.extended.tree.AsyncUniqueNode

All Implemented Interfaces:

com.alee.api.IconSupport, com.alee.api.Identifiable, java.io.Serializable, java.lang.Cloneable, javax.swing.tree.MutableTreeNode, javax.swing.tree.TreeNode

Direct Known Subclasses:

FileTreeNode, SampleNode
```
public abstract class AsyncUniqueNode
extends UniqueNode
implements com.alee.api.IconSupport, java.io.Serializable
```
Custom UniqueNode for WebAsyncTree. In addition to UniqueNode it contains a load icon and busy state indicator.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected static javax.swing.Icon`	`failedStateIcon` Special failed state icon.
`protected static java.util.Map<javax.swing.Icon,javax.swing.Icon>`	`failedStateIcons` User failed icons cache.
`protected java.lang.Throwable`	`failureCause` Children load failure cause.
`static LoadIconType`	`loadIconType` Default load icon type.
`protected java.awt.image.ImageObserver`	`observer` Load icon observer.
`protected AsyncNodeState`	`state` Current async node state.

Fields inherited from class com.alee.laf.tree.UniqueNode
id, ID_PREFIX

Fields inherited from class javax.swing.tree.DefaultMutableTreeNode
allowsChildren, children, EMPTY_ENUMERATION, parent, userObject

Constructor Summary

Constructors
Constructor and Description
`AsyncUniqueNode()` Costructs default node.
`AsyncUniqueNode(java.lang.Object userObject)` Constructs AsyncUniqueNode with a custom user object.
`AsyncUniqueNode(java.lang.String id, java.lang.Object userObject)` Constructs AsyncUniqueNode with a custom user object and node ID.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`attachLoadIconObserver(WebAsyncTree tree)` Attaches node load icon observer to the specified async tree.
`void`	`detachLoadIconObserver()` Detaches node load icon observer.
`AsyncUniqueNode`	`getChildAt(int index)`
`javax.swing.Icon`	`getFailedStateIcon(javax.swing.Icon icon)` Returns failed state icon for this node.
`java.lang.Throwable`	`getFailureCause()` Returns children load failure cause.
`javax.swing.Icon`	`getIcon()`
`javax.swing.Icon`	`getLoadIcon()` Returns load icon for this node.
`abstract javax.swing.Icon`	`getNodeIcon()` Returns specific icon for this node.
`AsyncUniqueNode`	`getParent()`
`AsyncNodeState`	`getState()` Returns async node state.
`boolean`	`isFailed()` Returns whether node children load failed or not.
`boolean`	`isLoaded()` Returns whether node children are loaded or not.
`boolean`	`isLoading()` Returns whether node children are being loaded or not.
`boolean`	`isWaiting()` Returns whether node is in waiting state.
`void`	`setFailureCause(java.lang.Throwable failureCause)` Sets children load failure cause.
`void`	`setState(AsyncNodeState state)` Sets async node state.

Methods inherited from class com.alee.laf.tree.UniqueNode
getId, getTreePath, setId, setId, toString

Methods inherited from class javax.swing.tree.DefaultMutableTreeNode
add, breadthFirstEnumeration, children, clone, depthFirstEnumeration, getAllowsChildren, getChildAfter, getChildBefore, getChildCount, getDepth, getFirstChild, getFirstLeaf, getIndex, getLastChild, getLastLeaf, getLeafCount, getLevel, getNextLeaf, getNextNode, getNextSibling, getPath, getPathToRoot, getPreviousLeaf, getPreviousNode, getPreviousSibling, getRoot, getSharedAncestor, getSiblingCount, getUserObject, getUserObjectPath, insert, isLeaf, isNodeAncestor, isNodeChild, isNodeDescendant, isNodeRelated, isNodeSibling, isRoot, pathFromAncestorEnumeration, postorderEnumeration, preorderEnumeration, remove, remove, removeAllChildren, removeFromParent, setAllowsChildren, setParent, setUserObject

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - failedStateIcon
```
protected static final javax.swing.Icon failedStateIcon
```
    Special failed state icon.
  - failedStateIcons
```
protected static final java.util.Map<javax.swing.Icon,javax.swing.Icon> failedStateIcons
```
    User failed icons cache.
  - loadIconType
```
public static LoadIconType loadIconType
```
    Default load icon type.
  - state
```
protected AsyncNodeState state
```
    Current async node state.
  - observer
```
protected java.awt.image.ImageObserver observer
```
    Load icon observer.
  - failureCause
```
protected java.lang.Throwable failureCause
```
    Children load failure cause.
- Constructor Detail
  - AsyncUniqueNode
```
public AsyncUniqueNode()
```
    Costructs default node.
  - AsyncUniqueNode
```
public AsyncUniqueNode(java.lang.Object userObject)
```
    Constructs AsyncUniqueNode with a custom user object.
    
    Parameters:
    
    userObject - custom user object
  - AsyncUniqueNode
```
public AsyncUniqueNode(java.lang.String id,
                       java.lang.Object userObject)
```
    Constructs AsyncUniqueNode with a custom user object and node ID.
    
    Parameters:
    
    id - node ID
    
    userObject - custom user object
- Method Detail
  - getState
```
public AsyncNodeState getState()
```
    Returns async node state.
    
    Returns:
    
    async node state
  - isWaiting
```
public boolean isWaiting()
```
    Returns whether node is in waiting state.
    
    Returns:
    
    true if node is in waiting state, false otherwise
  - isLoading
```
public boolean isLoading()
```
    Returns whether node children are being loaded or not.
    
    Returns:
    
    true if node children are being loaded, false otherwise
  - isLoaded
```
public boolean isLoaded()
```
    Returns whether node children are loaded or not.
    
    Returns:
    
    true if node children are loaded, false otherwise
  - isFailed
```
public boolean isFailed()
```
    Returns whether node children load failed or not.
    
    Returns:
    
    true if node children load failed, false otherwise
  - setState
```
public void setState(AsyncNodeState state)
```
    Sets async node state. Do not change this value on your own since that might break the tree.
    
    Parameters:
    
    state - new async node state
  - getFailureCause
```
public java.lang.Throwable getFailureCause()
```
    Returns children load failure cause.
    
    Returns:
    
    children load failure cause
  - setFailureCause
```
public void setFailureCause(java.lang.Throwable failureCause)
```
    Sets children load failure cause.
    
    Parameters:
    
    failureCause - children load failure cause
  - getIcon
```
public javax.swing.Icon getIcon()
```
    Specified by:
    
    getIcon in interface com.alee.api.IconSupport
  - getLoadIcon
```
public javax.swing.Icon getLoadIcon()
```
    Returns load icon for this node. This icon represents node loading state.
    
    Returns:
    
    load icon
  - attachLoadIconObserver
```
public void attachLoadIconObserver(WebAsyncTree tree)
```
    Attaches node load icon observer to the specified async tree.
    
    Parameters:
    
    tree - async tree
  - detachLoadIconObserver
```
public void detachLoadIconObserver()
```
    Detaches node load icon observer.
  - getNodeIcon
```
public abstract javax.swing.Icon getNodeIcon()
```
    Returns specific icon for this node. This icon usually represents node content type or state.
    
    Returns:
    
    specific icon for this node
  - getFailedStateIcon
```
public javax.swing.Icon getFailedStateIcon(javax.swing.Icon icon)
```
    Returns failed state icon for this node.
    
    Parameters:
    
    icon - node icon
    
    Returns:
    
    failed state icon for this node
  - getParent
```
public AsyncUniqueNode getParent()
```
    Specified by:
    
    getParent in interface javax.swing.tree.TreeNode
    
    Overrides:
    
    getParent in class UniqueNode
  - getChildAt
```
public AsyncUniqueNode getChildAt(int index)
```
    Specified by:
    
    getChildAt in interface javax.swing.tree.TreeNode
    
    Overrides:
    
    getChildAt in class javax.swing.tree.DefaultMutableTreeNode

Class AsyncUniqueNode

Field Summary

Fields inherited from class com.alee.laf.tree.UniqueNode

Fields inherited from class javax.swing.tree.DefaultMutableTreeNode

Constructor Summary

Method Summary

Methods inherited from class com.alee.laf.tree.UniqueNode

Methods inherited from class javax.swing.tree.DefaultMutableTreeNode

Methods inherited from class java.lang.Object

Field Detail

failedStateIcon

failedStateIcons

loadIconType

state

observer

failureCause

Constructor Detail

AsyncUniqueNode

AsyncUniqueNode

AsyncUniqueNode

Method Detail

getState

isWaiting

isLoading

isLoaded

isFailed

setState

getFailureCause

setFailureCause

getIcon

getLoadIcon

attachLoadIconObserver

detachLoadIconObserver

getNodeIcon

getFailedStateIcon

getParent

getChildAt