org.xoe.services
Interface IHistory

All Superinterfaces:
Constants, IService

public interface IHistory
extends IService

Describes a service which helps keep track of the displayed document history for an application.


Field Summary
static String FUNCTIONALITY
           
static String INTERFACE
           
 
Fields inherited from interface org.xoe.core.Constants
ACTION_ATTR, ADD, ADD_APP, AMPERSAND_KEY, AMPERSAND_SYMBOL, AMPERSAND_SYMBOL_STRING, APOSTROPHE_KEY, APOSTROPHE_SYMBOL, ASCENDING_SORT, BACK, BANNER_ATTR, BEEP, BEEP_PROPERTY, CONTEXT_ATTR, COPYRIGHT_KEY, COPYRIGHT_SYMBOL, COUNTRY_PROPERTY, DATA_DOC, DEFAULT_BOOTSTRAP, DEFAULT_NAMESPACE, DEFAULT_THEME, DEFAULT_THEMES_DIR, DEFAULT_VIEW, DELETE, DESCENDING_SORT, DISPLAY, DISPLAY_VIEW, DOCTYPE_NAME_NS_XHTML, DOUBLE_QUOTE_KEY, DOUBLE_QUOTE_SYMBOL, EDIT, EDIT_ITEM_VIEW, EXTENSION_ALL, EXTENSION_DTD, EXTENSION_HTML, EXTENSION_LNK, EXTENSION_WML, EXTENSION_XHTML, EXTENSION_XML, EXTENSION_XOE, EXTENSION_XOE_CONFIG, EXTENSION_ZIP, FEATURE_DOCTYPE_NAME_NS, FEATURE_EXTENSION, FEATURE_MIMETYPE, FILE_PROTOCOL, FORWARD, FUNCTION_CONTENT_HANDLER, GREATER_THAN_KEY, GREATER_THAN_SYMBOL, HIDE_IF_ATTR, HOMEDIR_PROPERTY, HREF_ATTR, INSERT_BEFORE_ATTR, LANGUAGE_PROPERTY, LAUNCH, LESSER_THAN_KEY, LESSER_THAN_SYMBOL, LOADTHEME, LOGGING_PROPERTY, MID_DOT_KEY, MID_DOT_SYMBOL, MIMETYPE_ALL, MIMETYPE_APPLICATION_XOE, MIMETYPE_APPLICATION_ZIP, MIMETYPE_STASHDIR, MIMETYPE_TEXT_HTML, MIMETYPE_TEXT_PLAIN, MIMETYPE_TEXT_VND_TVT_LNK, MIMETYPE_TEXT_WML, MIMETYPE_TEXT_XML, MIMETYPE_TEXT_XML_DTD, MIMETYPE_UNKNOWN, NAME_ATTR, NAMESPACE_SEPARATOR, NEW, NEW_ITEM_VIEW, NO_PATH, NON_BREAKING_SPACE_KEY, NON_BREAKING_SPACE_SYMBOL, NUM_LAST_APPS, ONCHANGE_ATTR, ONCLICK_ATTR, ONKEYPRESS_ATTR, ONLOAD_ATTR, ONMOUSEDOWN_ATTR, ONMOUSEOUT_ATTR, ONMOUSEOVER_ATTR, ONMOUSEUP_ATTR, PACKAGE_ARCHIVE_ROOT, PARENT_FRAME, PKG_ARCHIVE_ATTR, PKG_URI_ATTR, PKG_WORKSPACE_ATTR, PREVIOUS_DIR, PROPERTY_PREFIX, QUERY_DELIMITER, REFRESH, RESET, SAVE, SCREEN_COLORS_PROPERTY, SCREEN_HEIGHT_PROPERTY, SCREEN_TYPE_PROPERTY, SCREEN_WIDTH_PROPERTY, SCRIPT_PROPERTY, SCRIPT_SUPPORT, SELECT, SORT_BANNER_ATTR, SORT_ORDER_ATTR, SRC_ATTR, STASH_DIR_PROPERTY, STASH_FILE_SEPARATOR, STASH_PROTOCOL, STOP, STYLE_ATTR, TEMP_DIR, THEME_PROPERTY, THEMES_DIR_PROPERTY, TOP, TRIGGER_ATTR, UNICODE_DECIMAL_SYMBOL, UNICODE_HEX_SYMBOL, UNKNOWN_ICON, UNSET_NODE_TYPE, URL_CONTEXT_ATTR, USER_NAME, USERDIR_PROPERTY, VALUE_ATTR, WML_NAMESPACE, XHTML_NAMESPACE, XML, XML_PREFIX_NAMESPACE, XMLNS, XMLNS_NAMESPACE, XOE_CONFIG_DOCTYPE_NAME_NS, XOE_LOCALIZE, XPATH_ATTR
 
Method Summary
 void back(org.xoe.display.dom.DocumentViewer dv)
          Pop the previous document off the document history stack for dv, and set it as the displayed document for dv.
 void forward(org.xoe.display.dom.DocumentViewer dv)
          Get the next document off the document history stack for dv, and set it as the displayed document for dv.
 void forward(org.xoe.display.dom.DocumentViewer dv, org.w3c.dom.Document doc, URL url)
          Push doc onto the top of the document history stack for dv and set it as the currently displayed document.
 void trackHistory(org.xoe.display.dom.DocumentViewer dv, boolean propagate)
          Set up the local data and callbacks to track the Document objects displayed by dv.
 
Methods inherited from interface org.xoe.core.services.IService
getFeatures, getFunctionalities, getInformation, getInterfaces, init
 

Field Detail

INTERFACE

public static final String INTERFACE

FUNCTIONALITY

public static final String FUNCTIONALITY
Method Detail

trackHistory

public void trackHistory(org.xoe.display.dom.DocumentViewer dv,
                         boolean propagate)
Set up the local data and callbacks to track the Document objects displayed by dv.
Parameters:
propagate - propogate history events to the first enclosing DocumentViewer with history tracking.

forward

public void forward(org.xoe.display.dom.DocumentViewer dv,
                    org.w3c.dom.Document doc,
                    URL url)
Push doc onto the top of the document history stack for dv and set it as the currently displayed document.

back

public void back(org.xoe.display.dom.DocumentViewer dv)
Pop the previous document off the document history stack for dv, and set it as the displayed document for dv.
Parameters:
dv - a DocumentViewer value

forward

public void forward(org.xoe.display.dom.DocumentViewer dv)
Get the next document off the document history stack for dv, and set it as the displayed document for dv.