@ThreadRestricted(value="wicket") public abstract class VPageHTML extends VPage
Name | Value |
---|---|
voc.pageJClass | The class name of the specific Java type that implements this page. The name is fully qualified. |
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.
|
SHORT_STRING_LENGTH_MAX
ENABLE, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER
INTERFACE
Modifier | Constructor and Description |
---|---|
protected |
VPageHTML()
Constructs a VPageHTML, per WebPage().
|
protected |
VPageHTML(PageParameters _pP)
Constructs a VPageHTML, per WebPage(_pP).
|
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> |
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>> |
inputLengthConstrained(C field)
Constrains a CharSequence text field to the standard input length.
|
static <C extends FormComponent<?>> |
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 ( ).
|
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.
|
emailAddressValidator, inputLengthValidator, newBodyOnlyFragment, newNullComponent, shortened, shortenedWords, stringNonEmpty, stringRequired, vApplication, vRequestCycle
configureResponse, dirty, getMarkupType, homePageLink, onAfterRender, onRender, renderXmlDecl
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
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
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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
canCallListenerInterface, detach, get, getBehaviorById, getBehaviorId, getPage, getPageRelativePath
detach
static final String COOKIE_SESSION_STATE
public static final Duration CACHE_DURATION_YEAR
getCacheDuration()
protected VPageHTML(PageParameters _pP)
static void addSessionStateCookie(String encodedValue, String contextPath, WebResponse resW)
contextPath
- the context path of the request, which will also be used as
the cookie path.encodeSessionStateCookieValue(votorola.a.web.wic.VSession.User)
,
COOKIE_SESSION_STATE
public static <C extends Component> C appendStyleClass(C component, String classIdentifier)
static String encodeSessionStateCookieValue(VSession.User user)
protected final Duration getCacheDuration()
isCacheable()
,
setCacheDuration(Duration)
protected final void setCacheDuration(Duration d)
getCacheDuration()
,
CACHE_DURATION_YEAR
protected final String getPageIcon()
VOWicket.defaultPageIcon()
protected final void setPageIcon(String s)
public static <S extends CharSequence,C extends TextField<S>> C inputLengthConstrained(C field)
ModelLengthLimiter
,
VoterInputTable.MAX_INPUT_LENGTH
,
VPage.inputLengthValidator()
public static <C extends FormComponent<?>> C invalidStyled(C component)
protected final boolean isCacheable()
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.
setCacheable(boolean)
,
getCacheDuration()
protected final void setCacheable(boolean is)
isCacheable()
public static Label newLabelNBSP(String id)
public static Component newNullComponentAsLabel(String id)
public static PagingNavigator newPagingNavigator(String id, DataView<?> dataView)
public void renderHead(IHeaderResponse r)
renderHead
in interface IHeaderContributor
renderHead
in class Component
protected final void setHeaders(WebResponse r)
setHeaders
in class WebPage
isCacheable()