com.guiseframework.platform.web
Interface WebPlatform

All Superinterfaces:

Platform

All Known Implementing Classes:

AbstractWebPlatform, HTTPServletWebPlatform

public interface WebPlatform
extends Platform

The web platform for Guise.

Author:

Garret Wilson

Nested Class Summary

static class

WebPlatform.PollCommand The web commands for controlling polling.

Field Summary

static com.globalmentor.net.URIPath	AJAX_JAVASCRIPT_PATH The path of the AJAX JavaScript file, relative to the application.
static java.lang.String	ATTRIBUTE_ATTRIBUTE_HASH The Guise attribute containing the hash of the element attributes.
static java.lang.String	ATTRIBUTE_CLASS_CONTENT The HTML class attribute indicating content.
static java.lang.String	ATTRIBUTE_CONTENT_HASH The Guise attribute containing the hash of the element content.
static java.lang.String	ATTRIBUTE_CONTENT_TYPE The Guise attribute indicating the content type of an element's contents.
static java.lang.String	ATTRIBUTE_PATCH_TYPE The Guise attribute indicating the type of patching that should occur.
static java.lang.String	ATTRIBUTE_PATCH_TYPE_NO_VALUE The Guise attribute value indicating that no patching should occur on the value.
static java.lang.String	ATTRIBUTE_PATCH_TYPE_NONE The Guise attribute value indicating that no patching should occur.
static java.lang.String	ATTRIBUTE_PATCH_TYPE_TEMP The Guise attribute value indicating that the element is a temporary element that will be replaced later; functions just like "none" for patching except that this element will be removed from the original hierarchy.
static com.globalmentor.net.URIPath	BLANK_MP3_PATH The path of the blank MP3 file, relative to the application.
static com.globalmentor.net.URIPath	DOM_JAVASCRIPT_PATH The path of the DOM JavaScript file, relative to the application.
static java.lang.String	ELEMENT_IMG_ATTRIBUTE_ORIGINAL_SRC The Guise image attribute indicating the original source location of the image.
static java.lang.String	ELEMENT_IMG_ATTRIBUTE_ROLLOVER_SRC The Guise image attribute indicating the source location of the image to be used for rollovers.
static java.lang.String	ELEMENT_TEXTAREA_ATTRIBUTE_MULTILINE The Guise textarea attribute indicating whether the user should be allowed to enter multiple physical lines; value is "true" or "false".
static com.globalmentor.net.ContentType	GUISE_AJAX_REQUEST_CONTENT_TYPE The content type of a Guise AJAX request, application/x-guise-ajax-request.
static com.globalmentor.net.ContentType	GUISE_AJAX_RESPONSE_CONTENT_TYPE The content type of a Guise AJAX response, application/x-guise-ajax-response.
static com.globalmentor.net.URIPath	GUISE_DTD_PATH The path of the Guise DTD, relative to the application.
static com.globalmentor.net.URIPath	GUISE_EMPTY_HTML_DOCUMENT_PATH The path of the empty HTML document, relative to the application.
static com.globalmentor.net.URIPath	GUISE_FLASH_PATH The path of the Guise Flash file, relative to the application.
static com.globalmentor.net.URIPath	GUISE_JAVASCRIPT_PATH The path of the Guise JavaScript file, relative to the application.
static java.lang.String	GUISE_ML_NAMESPACE_PREFIX The standard prefix to use with the Guise markup language namespace.
static java.net.URI	GUISE_ML_NAMESPACE_URI The namespace of the Guise markup language to be used with XHTML.
static java.lang.String	GUISE_SESSION_UUID_URI_QUERY_PARAMETER The URI query parameter used to specify a Guise session by UUID, overriding the Guise session based upon the HTTP session identified by the request.
static java.lang.String	GUISE_VERSION_URI_QUERY_PARAMETER The URI query parameter used to indicate the Guise version to prevent caching between versions.
static java.lang.String	GUISE_XHTML_DTD_PUBLIC_ID The public ID of the Guise XHTML DTD.
static com.globalmentor.net.URIPath	JAVASCRIPT_JAVASCRIPT_PATH The path of the JavaScript JavaScript file, relative to the application.

Method Summary

boolean	discontinuePollInterval(DepictedObject depictedObject) Indicates that a depicted object no longer requests a particular polling interval.
WebUserAgentProduct	getClientProduct()
WebDepictContext	getDepictContext() Retrieves information and functionality related to the current depiction.
long	getDepictID(java.lang.String depictIDString) Returns the depicted object ID represented by the given platform-specific ID string.
java.lang.String	getDepictIDString(long depictID) Generates an ID for the given depicted object appropriate for using on the platform.
int	getPollInterval()
java.util.Queue<WebPlatformMessage>	getSendMessageQueue()
boolean	requestPollInterval(DepictedObject depictedObject, int pollInterval) Requests a polling interval for a given depicted object.
void	setPollInterval(int newPollInterval) Sets the polling interval in millseconds.

Methods inherited from interface com.guiseframework.platform.Platform

generateDepictID, getApplication, getDepictedObject, getDepictLock, getDepictor, getEnvironment, registerDepictedObject, selectPlatformFiles, sendResource, sendResource, sendResource, sendResource, unregisterDepictedObject

Field Detail

GUISE_ML_NAMESPACE_URI

static final java.net.URI GUISE_ML_NAMESPACE_URI

The namespace of the Guise markup language to be used with XHTML.

GUISE_ML_NAMESPACE_PREFIX

static final java.lang.String GUISE_ML_NAMESPACE_PREFIX

The standard prefix to use with the Guise markup language namespace.

See Also:

Constant Field Values

GUISE_XHTML_DTD_PUBLIC_ID

static final java.lang.String GUISE_XHTML_DTD_PUBLIC_ID

The public ID of the Guise XHTML DTD.

See Also:

Constant Field Values

GUISE_SESSION_UUID_URI_QUERY_PARAMETER

static final java.lang.String GUISE_SESSION_UUID_URI_QUERY_PARAMETER

The URI query parameter used to specify a Guise session by UUID, overriding the Guise session based upon the HTTP session identified by the request.

See Also:

Constant Field Values

GUISE_VERSION_URI_QUERY_PARAMETER

static final java.lang.String GUISE_VERSION_URI_QUERY_PARAMETER

The URI query parameter used to indicate the Guise version to prevent caching between versions.

See Also:

Constant Field Values

GUISE_AJAX_REQUEST_CONTENT_TYPE

static final com.globalmentor.net.ContentType GUISE_AJAX_REQUEST_CONTENT_TYPE

The content type of a Guise AJAX request, application/x-guise-ajax-request.

GUISE_AJAX_RESPONSE_CONTENT_TYPE

static final com.globalmentor.net.ContentType GUISE_AJAX_RESPONSE_CONTENT_TYPE

The content type of a Guise AJAX response, application/x-guise-ajax-response.

ELEMENT_IMG_ATTRIBUTE_ORIGINAL_SRC

static final java.lang.String ELEMENT_IMG_ATTRIBUTE_ORIGINAL_SRC

The Guise image attribute indicating the original source location of the image.

See Also:

Constant Field Values

ELEMENT_IMG_ATTRIBUTE_ROLLOVER_SRC

static final java.lang.String ELEMENT_IMG_ATTRIBUTE_ROLLOVER_SRC

The Guise image attribute indicating the source location of the image to be used for rollovers.

See Also:

Constant Field Values

ELEMENT_TEXTAREA_ATTRIBUTE_MULTILINE

static final java.lang.String ELEMENT_TEXTAREA_ATTRIBUTE_MULTILINE

The Guise textarea attribute indicating whether the user should be allowed to enter multiple physical lines; value is "true" or "false".

See Also:

Constant Field Values

ATTRIBUTE_ATTRIBUTE_HASH

static final java.lang.String ATTRIBUTE_ATTRIBUTE_HASH

The Guise attribute containing the hash of the element attributes.

See Also:

Constant Field Values

ATTRIBUTE_CONTENT_HASH

static final java.lang.String ATTRIBUTE_CONTENT_HASH

The Guise attribute containing the hash of the element content.

See Also:

Constant Field Values

ATTRIBUTE_CONTENT_TYPE

static final java.lang.String ATTRIBUTE_CONTENT_TYPE

The Guise attribute indicating the content type of an element's contents.

See Also:

Constant Field Values

ATTRIBUTE_PATCH_TYPE

static final java.lang.String ATTRIBUTE_PATCH_TYPE

The Guise attribute indicating the type of patching that should occur.

See Also:

Constant Field Values

ATTRIBUTE_PATCH_TYPE_NO_VALUE

static final java.lang.String ATTRIBUTE_PATCH_TYPE_NO_VALUE

The Guise attribute value indicating that no patching should occur on the value.

See Also:

Constant Field Values

ATTRIBUTE_PATCH_TYPE_NONE

static final java.lang.String ATTRIBUTE_PATCH_TYPE_NONE

The Guise attribute value indicating that no patching should occur.

See Also:

Constant Field Values

ATTRIBUTE_PATCH_TYPE_TEMP

static final java.lang.String ATTRIBUTE_PATCH_TYPE_TEMP

The Guise attribute value indicating that the element is a temporary element that will be replaced later; functions just like "none" for patching except that this element will be removed from the original hierarchy.

See Also:

Constant Field Values

ATTRIBUTE_CLASS_CONTENT

static final java.lang.String ATTRIBUTE_CLASS_CONTENT

The HTML class attribute indicating content.

See Also:

Constant Field Values

BLANK_MP3_PATH

static final com.globalmentor.net.URIPath BLANK_MP3_PATH

The path of the blank MP3 file, relative to the application.

GUISE_EMPTY_HTML_DOCUMENT_PATH

static final com.globalmentor.net.URIPath GUISE_EMPTY_HTML_DOCUMENT_PATH

The path of the empty HTML document, relative to the application.

AJAX_JAVASCRIPT_PATH

static final com.globalmentor.net.URIPath AJAX_JAVASCRIPT_PATH

The path of the AJAX JavaScript file, relative to the application.

DOM_JAVASCRIPT_PATH

static final com.globalmentor.net.URIPath DOM_JAVASCRIPT_PATH

The path of the DOM JavaScript file, relative to the application.

GUISE_JAVASCRIPT_PATH

static final com.globalmentor.net.URIPath GUISE_JAVASCRIPT_PATH

The path of the Guise JavaScript file, relative to the application.

JAVASCRIPT_JAVASCRIPT_PATH

static final com.globalmentor.net.URIPath JAVASCRIPT_JAVASCRIPT_PATH

The path of the JavaScript JavaScript file, relative to the application.

GUISE_DTD_PATH

static final com.globalmentor.net.URIPath GUISE_DTD_PATH

The path of the Guise DTD, relative to the application.

GUISE_FLASH_PATH

static final com.globalmentor.net.URIPath GUISE_FLASH_PATH

The path of the Guise Flash file, relative to the application.

Method Detail

getDepictIDString

java.lang.String getDepictIDString(long depictID)

Generates an ID for the given depicted object appropriate for using on the platform.

Parameters:

depictID - The depict ID to be converted to a platform ID.

Returns:

The form of the depict ID appropriate for using on the platform.

getDepictID

long getDepictID(java.lang.String depictIDString)

Returns the depicted object ID represented by the given platform-specific ID string.

Parameters:

depictIDString - The platform-specific form of the depict ID.

depictID - The depict ID to be converted to a platform ID.

Returns:

The depict ID the platform-specific form represents.

Throws:

java.lang.NullPointerException - if the given string is null.

java.lang.IllegalArgumentException - if the given string does not represent the correct string form of a depict ID on this platform.

getClientProduct

WebUserAgentProduct getClientProduct()

Specified by:

getClientProduct in interface Platform

Returns:

The user agent client, such as a browser, used to access Guise on this platform.

getDepictContext

WebDepictContext getDepictContext()

Retrieves information and functionality related to the current depiction.

Specified by:

getDepictContext in interface Platform

Returns:

A context for the current depiction.

Throws:

java.lang.IllegalStateException - if no depict context can be returned in the current depiction state.

getSendMessageQueue

java.util.Queue<WebPlatformMessage> getSendMessageQueue()

Specified by:

getSendMessageQueue in interface Platform

Returns:

The thread-safe queue of messages to be delivered to the platform.

getPollInterval

int getPollInterval()

Returns:

The current polling interval in milleseconds.

setPollInterval

void setPollInterval(int newPollInterval)

Sets the polling interval in millseconds.

Parameters:

newPollInterval - The polling interval in millseconds.

Throws:

java.lang.IllegalArgumentException - if the given polling interval is less than zero.

requestPollInterval

boolean requestPollInterval(DepictedObject depictedObject,
                            int pollInterval)

Requests a polling interval for a given depicted object. The actual polling interval will be updated if the given polling interval is smaller than the current actual polling interval.

Parameters:

depictedObject - The depicted object requesting a polling interval.

pollInterval - The polling interval in milleseconds.

Returns:

true if the polling interval changed as a result of this request.

Throws:

java.lang.NullPointerException - if the given depicted object is null.

java.lang.IllegalArgumentException - if the value is less than zero.

See Also:

discontinuePollInterval(DepictedObject), getPollInterval(), #setPollInterval()

discontinuePollInterval

boolean discontinuePollInterval(DepictedObject depictedObject)

Indicates that a depicted object no longer requests a particular polling interval. The actual polling interval will be updated if the relinquished poll interval is less than or equal to the current poll interval.

Parameters:

depictedObject - The depicted object that is relinquishing a polling interval.

Returns:

true if the polling interval changed as a result of this relinquishment.

Throws:

java.lang.NullPointerException - if the given depicted object is null.

See Also:

requestPollInterval(DepictedObject, int), getPollInterval(), #setPollInterval()