org.jdesktop.swingx.hyperlink
Class LinkModel

java.lang.Object
  org.jdesktop.swingx.hyperlink.LinkModel

All Implemented Interfaces:

Comparable

public class LinkModel
extends Object
implements Comparable

An bean which represents an URL link. Text, URL and visited are bound properties. Compares by Text.

Field Summary

static String

VISITED_PROPERTY

Constructor Summary

LinkModel()

LinkModel(String text)

LinkModel(String text, String target, String template, String[] args)

LinkModel(String text, String target, URL url)

Method Summary

void	addPropertyChangeListener(PropertyChangeListener l)
int	compareTo(Object obj) Compares this object with the specified object for order.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
protected void	firePropertyChange(String property, boolean oldValue, boolean newValue)
protected void	firePropertyChange(String property, Object oldValue, Object newValue)
String	getTarget() Return the target for the URL.
String	getText()
URL	getURL()
boolean	getVisited()
int	hashCode() Returns a hash code value for the object.
void	removePropertyChangeListener(PropertyChangeListener l)
void	setTarget(String target) Set the target that the URL should load into.
void	setText(String text) Set the display text.
void	setURL(URL url) Set the url and resets the visited flag.
void	setURLString(String howToURLString)
void	setVisited(boolean visited) Sets a flag to indicate if the link has been visited.
String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

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

Field Detail

VISITED_PROPERTY

public static final String VISITED_PROPERTY

See Also:

Constant Field Values

Constructor Detail

LinkModel

public LinkModel(String text,
                 String target,
                 URL url)

Parameters:

text -

target -

url -

LinkModel

public LinkModel()

LinkModel

public LinkModel(String text)

LinkModel

public LinkModel(String text,
                 String target,
                 String template,
                 String[] args)

Parameters:

text - text to that a renderer would display

target - the target that a URL should load into.

template - a string that represents a URL with &{N} place holders for string substitution

args - an array of strings which will be used for substitition

Method Detail

setText

public void setText(String text)

Set the display text.

getText

public String getText()

setURLString

public void setURLString(String howToURLString)

setURL

public void setURL(URL url)

Set the url and resets the visited flag. Think: keep list of visited urls here?

getURL

public URL getURL()

setTarget

public void setTarget(String target)

Set the target that the URL should load into. This can be a uri representing another control or the name of a window or special targets. See: http://www.w3c.org/TR/html401/present/frames.html#adef-target

getTarget

public String getTarget()

Return the target for the URL.

Returns:

value of the target. If null then "_blank" will be returned.

setVisited

public void setVisited(boolean visited)

Sets a flag to indicate if the link has been visited. The state of this flag can be used to render the color of the link.

getVisited

public boolean getVisited()

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener l)

firePropertyChange

protected void firePropertyChange(String property,
                                  Object oldValue,
                                  Object newValue)

firePropertyChange

protected void firePropertyChange(String property,
                                  boolean oldValue,
                                  boolean newValue)

compareTo

public int compareTo(Object obj)

Description copied from interface: java.lang.Comparable

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

In the foregoing description, the notation sgn(expression) designates the mathematical signum function, which is defined to return one of -1, 0, or 1 according to whether the value of expression is negative, zero or positive. The implementor must ensure sgn(x.compareTo(y)) == -sgn(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception iff y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y)>0 && y.compareTo(z)>0) implies x.compareTo(z)>0.

Finally, the implementer must ensure that x.compareTo(y)==0 implies that sgn(x.compareTo(z)) == sgn(y.compareTo(z)), for all z.

It is strongly recommended, but not strictly required that (x.compareTo(y)==0) == (x.equals(y)). Generally speaking, any class that implements the Comparable interface and violates this condition should clearly indicate this fact. The recommended language is "Note: this class has a natural ordering that is inconsistent with equals."

Specified by:

compareTo in interface Comparable

Parameters:

obj - the Object to be compared.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

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

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.