|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.bluemarsh.jswat.ui.BasicUIAdapter
Abstract class BasicUIAdapter provides a limited implementation of the UIAdapter interface. Concrete adapter implementations should extend this class.
Field Summary | |
protected java.util.Hashtable |
propertyTable
Table of properties. |
Constructor Summary | |
BasicUIAdapter()
Constructor for BasicUIAdapter class. |
Method Summary | |
abstract void |
buildInterface()
Construct the appropriate user interface and connect all the pieces together. |
abstract boolean |
canFindString()
Indicate if this interface adapter has the ability to find a string in the currently selected source view. |
abstract boolean |
canShowFile()
Indicate if this interface adapter has the ability to show source files in a manner appropriate for the user to read. |
abstract boolean |
canShowStatus()
Indicate if this interface adapter has the ability to show the status in a manner appropriate for the user to view. |
abstract void |
destroyInterface()
Deconstruct the user interface such that all components are made invisible and prepared for non-use. |
abstract void |
exit()
This is called when there are no more open Sessions. |
abstract boolean |
findString(java.lang.String query,
boolean ignoreCase)
Search for the given string in the currently selected source view. |
java.lang.Object |
getProperty(java.lang.String key)
Searches for the property with the specified key in the property list. |
abstract JSwatView |
getSelectedView()
Retrieves the currently active view in JSwat. |
abstract void |
initComplete()
Called when the Session initialization has completed. |
abstract void |
refreshDisplay()
Refresh the display to reflect changes in the program. |
abstract void |
saveSettings()
Save any settings to the appropriate places, the program is about the terminate. |
java.lang.Object |
setProperty(java.lang.String key,
java.lang.Object value)
Stores the given value in the properties list with the given key as a reference. |
abstract boolean |
showFile(SourceSource src,
int line,
int count)
Show the given file in the appropriate view and make the given line visible in that view. |
abstract void |
showStatus(java.lang.String status)
Show a status message in a reasonable location. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected java.util.Hashtable propertyTable
Constructor Detail |
public BasicUIAdapter()
Method Detail |
public abstract void buildInterface()
buildInterface
in interface UIAdapter
public abstract boolean canFindString()
canFindString
in interface UIAdapter
public abstract boolean canShowFile()
canShowFile
in interface UIAdapter
public abstract boolean canShowStatus()
canShowStatus
in interface UIAdapter
public abstract void destroyInterface()
destroyInterface
in interface UIAdapter
public abstract void exit()
exit
in interface UIAdapter
public abstract boolean findString(java.lang.String query, boolean ignoreCase) throws NoOpenViewException
findString
in interface UIAdapter
query
- string to look for.ignoreCase
- true to ignore case.NoOpenViewException
- Thrown if there is no view to be searched.public java.lang.Object getProperty(java.lang.String key)
getProperty
in interface UIAdapter
key
- the property key.public abstract JSwatView getSelectedView()
getSelectedView
in interface UIAdapter
public abstract void initComplete()
initComplete
in interface UIAdapter
public abstract void refreshDisplay()
refreshDisplay
in interface UIAdapter
public abstract void saveSettings()
saveSettings
in interface UIAdapter
public java.lang.Object setProperty(java.lang.String key, java.lang.Object value)
setProperty
in interface UIAdapter
key
- the key to be placed into this property list.value
- the value corresponding to key, or null to remove
the key and value from the properties.public abstract boolean showFile(SourceSource src, int line, int count)
showFile
in interface UIAdapter
src
- source to be displayed.line
- one-based line to be made visible, or zero for
a reasonable default.count
- number of lines to display, or zero for a
reasonable default. Some adapters will ignore
this value if, for instance, they utilize a
scrollable view.public abstract void showStatus(java.lang.String status)
showStatus
in interface UIAdapter
status
- message to be shown to the user.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |