org.tentackle.appworx
Class AppDbTreeObject

java.lang.Object
  org.tentackle.appworx.AppDbTreeObject

Direct Known Subclasses:

AppDbTreeToggleNodeObject

public class AppDbTreeObject
extends Object

Object wrapper associated to a node in an AppDbObjectTree.

Author:

harald

Constructor Summary

AppDbTreeObject(Object object, Object parentObject)
Creates a tree object.

Method Summary

boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
ImageIcon	getIcon() Gets the icon.
Object	getObject() Gets the object wrapped by this tree object.
Object	getParentObject() Gets the parent object.
String	getToolTipText() Gets the text for the tooltip.
String	getTreeText() Gets the text displayed in the tree for this object.
int	hashCode() Returns a hash code value for the object.
boolean	isExpanded() Gets the expanded state.
boolean	isStopExpandPath() Returns whether AppDbObjectTree.doExpandPath should stop expansion (not treeWillExpand).
boolean	isStopTreeWillExpand() Returns whether this object's node should be further expanded.
void	setExpanded(boolean expanded) Sets the expanded state.
void	setIcon(ImageIcon icon) Sets the icon.
void	setObject(Object object) Sets the object wrapped by this tree object.
void	setStopExpandPath(boolean stopExpandPath) Sets whether AppDbObjectTree.doExpandPath should stop expansion (not treeWillExpand).
void	setStopTreeWillExpand(boolean stopExpansion) Defines whether this object's node should be further expanded.
void	setTreeText(String treeText) Sets the text displayed in the tree for this object.
String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

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

Constructor Detail

AppDbTreeObject

public AppDbTreeObject(Object object,
                       Object parentObject)

Creates a tree object.

Parameters:

object - the data object wrapped by this tree object

parentObject - the parent object of the given object, null = none

Method Detail

getParentObject

public Object getParentObject()

Gets the parent object.

Returns:

the parent object, null = none

equals

public boolean equals(Object obj)

Description copied from class: java.lang.Object

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Overrides:

equals in class Object

Parameters:

obj - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

Object.hashCode(), Hashtable

hashCode

public int hashCode()

Description copied from class: java.lang.Object

Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java^TM programming language.)

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object), Hashtable

getIcon

public ImageIcon getIcon()

Gets the icon.

Returns:

the icon, null if none

setIcon

public void setIcon(ImageIcon icon)

Sets the icon.

Parameters:

icon - the icon, null if none

getToolTipText

public String getToolTipText()

Gets the text for the tooltip.

Returns:

the tooltip, null if none

toString

public String toString()

Description copied from class: java.lang.Object

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:

toString in class Object

Returns:

a string representation of the object.

isExpanded

public boolean isExpanded()

Gets the expanded state.

Returns:

true if node is expanded

setExpanded

public void setExpanded(boolean expanded)

Sets the expanded state.

Parameters:

expanded - true if node is expanded

getObject

public Object getObject()

Gets the object wrapped by this tree object.

Returns:

the wrapped object

setObject

public void setObject(Object object)

Sets the object wrapped by this tree object.

Parameters:

object - the wrapped object

isStopTreeWillExpand

public boolean isStopTreeWillExpand()

Returns whether this object's node should be further expanded.

Returns:

true to stop expansion

setStopTreeWillExpand

public void setStopTreeWillExpand(boolean stopExpansion)

Defines whether this object's node should be further expanded.

Parameters:

stopExpansion - true to stop expansion

isStopExpandPath

public boolean isStopExpandPath()

Returns whether AppDbObjectTree.doExpandPath should stop expansion (not treeWillExpand). The user will still be able to expand the node by clicking on it!

Returns:

true if stop expansion

See Also:

AppDbObjectTree.doExpandPath(int, int, org.tentackle.appworx.AppDbObject, javax.swing.tree.TreePath)

setStopExpandPath

public void setStopExpandPath(boolean stopExpandPath)

Sets whether AppDbObjectTree.doExpandPath should stop expansion (not treeWillExpand). The user will still be able to expand the node by clicking on it!

Parameters:

stopExpandPath - true if stop expansion

See Also:

AppDbObjectTree.doExpandPath(int, int, org.tentackle.appworx.AppDbObject, javax.swing.tree.TreePath)

getTreeText

public String getTreeText()

Gets the text displayed in the tree for this object.

Returns:

the tree text

setTreeText

public void setTreeText(String treeText)

Sets the text displayed in the tree for this object.

Parameters:

treeText - the tree text