All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface semper.util.browser.Browseable

public interface Browseable
A Browseable object will be manipulated in several ways when a user is browsing. The Browseables are first loaded by the Browser. Subsequently, the Browseables are made available to the user in a number of ways. To support the interaction with the user, a Browseable object provides methods, that make (part of) the contents of the object available to the Browser.

See Also:
Browser

Method Index

o compareTo(Browseable, int, boolean)
Method for sorting Browseables on a specified key.
o exportToLineOfASCII()
Export as a flat ASCII String.
o exportToLineOfHTML()
Export as an HTML formatted String, consisting of a single line.
o exportToLinesOfHTML()
Export as an HTML formatted String, consisting of several lines.
o getActions()
Obtain the names of the actions which can be called for a browseable.
o getKeys()
Obtain the names of the keys which can be used to sort.
o getMethodName(int)
Obtain the name of the method that should be called for a browseable.
o getName()
Returns the formal name of the browseable, e.g.

Methods

o getName 
 public abstract String getName()
Returns the formal name of the browseable, e.g. Certificate, Payment, Deal. This is used for the title of the dialog windows displayed for the browser.

o exportToLineOfHTML 
 public abstract String exportToLineOfHTML()
Export as an HTML formatted String, consisting of a single line. The HTML should be limited to those HTML tags supported by the Tinguin. The method gives full control over the formatting.

o exportToLinesOfHTML 
 public abstract String exportToLinesOfHTML()
Export as an HTML formatted String, consisting of several lines. The HTML should be limited to those HTML tags supported by the Tinguin. The method gives full control over the formatting.

o exportToLineOfASCII 
 public abstract String exportToLineOfASCII()
Export as a flat ASCII String. The ASCII String is to be included in a simply formatted file, for example. The method gives full control over the formatting.

o compareTo 
 public abstract int compareTo(Browseable other,
                               int keyno,
                               boolean reverse)
Method for sorting Browseables on a specified key. Other methods could make sorting (and selecting) on individual fields possible.

Precondition: the objects must be of the same type.

Parameters:
other - Browseable object to compare with this.
keyno - number of the key field to use in comparisons.
reverse - if true use the reverse order.
Returns:
-1, 0, or 1 iff this is "less than", "equal to", or "larger than" other, respectively.
o getKeys 
 public abstract String[] getKeys()
Obtain the names of the keys which can be used to sort. The index of the key in the result array is its key number.

Returns:
a String per key.
o getActions 
 public abstract String[] getActions()
Obtain the names of the actions which can be called for a browseable.

Returns:
a String per action.
o getMethodName 
 public abstract String getMethodName(int n)
Obtain the name of the method that should be called for a browseable.

Returns:
the name of the method. 
All Packages  Class Hierarchy  This Package  Previous  Next  Index