votorola.a.web.wic

Class VPageHTML

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.Page

org.apache.wicket.markup.html.WebPage

VPage

VPageHTML

All Implemented Interfaces:

Serializable, Iterable<Component>, IEventSink, IEventSource, IClusterable, IConverterLocator, IRedirectListener, IRequestListener, IHeaderContributor, IManageablePage, IRequestableComponent, IRequestablePage, IHierarchical<Component>

Direct Known Subclasses:

LoginPage, WP_Activity, WP_CountEngine, WP_D, WP_EmailAuthen1, WP_EmailAuthen2, WP_Message, WP_MyDraft, WP_OpenIDReturn, WP_Poll, WP_Rank, WP_Server, WP_Votespace

@ThreadRestricted(value="wicket")
public abstract class VPageHTML
extends VPage

An HTML page in the Wicket web interface. The page defines the following JavaScript variables for the use of client scripts:

Name	Value
voc.pageJClass	The class name of the specific Java type that implements this page. The name is fully qualified.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Duration	CACHE_DURATION_YEAR A duration of roughly one year, which is suitable as a cache duration for pages that have stable content.
(package private) static String	COOKIE_SESSION_STATE The name of the cookie for transmitting the state of the session to cacheable pages.

Fields inherited from class VPage

SHORT_STRING_LENGTH_MAX

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER

Fields inherited from interface org.apache.wicket.IRedirectListener

INTERFACE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VPageHTML() Constructs a VPageHTML, per WebPage().
protected	VPageHTML(PageParameters _pP) Constructs a VPageHTML, per WebPage(_pP).

Method Summary

Methods

Modifier and Type	Method and Description
(package private) static void	addSessionStateCookie(String encodedValue, String contextPath, WebResponse resW) Adds a cookie to convey the user's login state to cacheable pages.
static <C extends Component> C	appendStyleClass(C component, String classIdentifier) Appends a CSS class identifier to the component's 'class' attribute.
(package private) static String	encodeSessionStateCookieValue(VSession.User user) Encodes a value suitable for a session state cookie.
protected Duration	getCacheDuration() The duration for client-side caching, where enabled.
protected String	getPageIcon() The location of the page icon.
static <S extends CharSequence,C extends TextField<S>> C	inputLengthConstrained(C field) Constrains a CharSequence text field to the standard input length.
static <C extends FormComponent<?>> C	invalidStyled(C component) Trains the form component to aquire the style class 'invalid', whenever it fails validation.
protected boolean	isCacheable() Answers whether client-side caching is enabled.
static Label	newLabelNBSP(String id) Constructs a label containing a non-breaking space character (&nbsp;).
static Component	newNullComponentAsLabel(String id) Constructs a label containing a non-breaking space character, for situations that preclude using a proper null component.
static PagingNavigator	newPagingNavigator(String id, DataView<?> dataView) Constructs a paging navigator with a standard configuration.
void	renderHead(IHeaderResponse r)
protected void	setCacheable(boolean is) Sets whether client-side caching is enabled.
protected void	setCacheDuration(Duration d) Sets the duration for client-side caching, where enabled.
protected void	setHeaders(WebResponse r) Sets headers to enable or disable caching.
protected void	setPageIcon(String s) Sets the location of the page icon.

Methods inherited from class VPage

emailAddressValidator, inputLengthValidator, newBodyOnlyFragment, newNullComponent, shortened, shortenedWords, stringNonEmpty, stringRequired, vApplication, vRequestCycle

Methods inherited from class org.apache.wicket.markup.html.WebPage

configureResponse, dirty, getMarkupType, homePageLink, onAfterRender, onRender, renderXmlDecl

Methods inherited from class org.apache.wicket.Page

componentChanged, componentRendered, detachModels, dirty, endComponentRender, getAutoIndex, getId, getPageClass, getPageId, getPageParameters, getPageReference, getRenderCount, getSizeInBytes, getStatelessHint, hierarchyAsString, internalOnModelChanged, internalPrepareForRender, isBookmarkable, isErrorPage, isPageStateless, onBeforeRender, onDetach, onRedirect, renderPage, setFreezePageId, setNumericId, setStatelessHint, setWasCreatedBookmarkable, startComponentRender, toString, wasCreatedBookmarkable, wasRendered

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, contains, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, hasAssociatedMarkup, internalAdd, internalInitialize, iterator, iterator, onAfterRenderChildren, onComponentTagBody, onMarkupAttached, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, swap, toString, visitChildren, visitChildren, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, canCallListenerInterface, canCallListenerInterface, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, debug, detach, detachModel, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessage, getFeedbackMessages, getFlag, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSession, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalRenderComponent, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onComponentTag, onConfigure, onEvent, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setRequestFlag, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, warn, wrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.wicket.request.component.IRequestableComponent

canCallListenerInterface, detach, get, getBehaviorById, getBehaviorId, getPage, getPageRelativePath

Methods inherited from interface org.apache.wicket.page.IManageablePage

detach

Field Detail

COOKIE_SESSION_STATE

static final String COOKIE_SESSION_STATE

The name of the cookie for transmitting the state of the session to cacheable pages.

See Also:

addSessionStateCookie(String,String,WebResponse), Constant Field Values

CACHE_DURATION_YEAR

public static final Duration CACHE_DURATION_YEAR

A duration of roughly one year, which is suitable as a cache duration for pages that have stable content.

See Also:

getCacheDuration()

Constructor Detail

VPageHTML

protected VPageHTML()

Constructs a VPageHTML, per WebPage().

VPageHTML

protected VPageHTML(PageParameters _pP)

Constructs a VPageHTML, per WebPage(_pP).

Method Detail

addSessionStateCookie

static void addSessionStateCookie(String encodedValue,
                         String contextPath,
                         WebResponse resW)

Adds a cookie to convey the user's login state to cacheable pages. Client side script VPageHTML.js compares the value of this cookie against that encoded in the page and automatically reloads the page to correct the rendering when necessary. This applies only to cacheable pages and is employed as a temporary workaround pending the movement of login dependent rendering to the client side.

Parameters:

contextPath - the context path of the request, which will also be used as the cookie path.

See Also:

encodeSessionStateCookieValue(votorola.a.web.wic.VSession.User), COOKIE_SESSION_STATE

appendStyleClass

public static <C extends Component> C appendStyleClass(C component,
                                       String classIdentifier)

Appends a CSS class identifier to the component's 'class' attribute. Uses an AttributeAppender for this purpose. If you wish to remove the identifier later, then use your own AttributeAppender and override its isEnabled() method.

Returns:

the component

encodeSessionStateCookieValue

static String encodeSessionStateCookieValue(VSession.User user)

Encodes a value suitable for a session state cookie.

See Also:

addSessionStateCookie(String,String,WebResponse)

getCacheDuration

protected final Duration getCacheDuration()

The duration for client-side caching, where enabled. The default value of one hour is suitable for pages that contain voting results.

See Also:

isCacheable(), setCacheDuration(Duration)

setCacheDuration

protected final void setCacheDuration(Duration d)

Sets the duration for client-side caching, where enabled.

See Also:

getCacheDuration(), CACHE_DURATION_YEAR

getPageIcon

protected final String getPageIcon()

The location of the page icon.

See Also:

VOWicket.defaultPageIcon()

setPageIcon

protected final void setPageIcon(String s)

Sets the location of the page icon.

inputLengthConstrained

public static <S extends CharSequence,C extends TextField<S>> C inputLengthConstrained(C field)

Constrains a CharSequence text field to the standard input length. Wraps a length limiter around its model, and adds a 'maxLength' attribute to its view. For use only with a field that is backed by a character sequence model. (For others, the associated IConverter should enforce its own constraints at conversion time.)

Returns:

the same field

See Also:

ModelLengthLimiter, VoterInputTable.MAX_INPUT_LENGTH, VPage.inputLengthValidator()

invalidStyled

public static <C extends FormComponent<?>> C invalidStyled(C component)

Trains the form component to aquire the style class 'invalid', whenever it fails validation.

Returns:

the component

isCacheable

protected final boolean isCacheable()

Answers whether client-side caching is enabled. When enabled, the response will allow the client to cache this page privately for the cache duration; otherwise it will forbid caching. The default value is false.

Cacheable pages may depend on the user's login state. A cookie/script mechanism is used to automatically reload cached pages and bypass the cache following any change to login state. The rendering of the page may therefore depend on the identity of the authenticated user, but not on any other crucial variable that might change over the course of the cache duration.

See Also:

setCacheable(boolean), getCacheDuration()

setCacheable

protected final void setCacheable(boolean is)

Sets whether client-side caching is enabled.

See Also:

isCacheable()

newLabelNBSP

public static Label newLabelNBSP(String id)

Constructs a label containing a non-breaking space character (&nbsp;).

newNullComponentAsLabel

public static Component newNullComponentAsLabel(String id)

Constructs a label containing a non-breaking space character, for situations that preclude using a proper null component. One such situation is the end of the page, where a null component somehow causes clipping of the content above (IE7).

newPagingNavigator

public static PagingNavigator newPagingNavigator(String id,
                                 DataView<?> dataView)

Constructs a paging navigator with a standard configuration.

renderHead

public void renderHead(IHeaderResponse r)

Specified by:

renderHead in interface IHeaderContributor

Overrides:

renderHead in class Component

setHeaders

protected final void setHeaders(WebResponse r)

Sets headers to enable or disable caching.

Overrides:

setHeaders in class WebPage

See Also:

isCacheable()