Class LayoutFilePage

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.feedback.IFeedbackContributor, org.apache.wicket.IConverterLocator, org.apache.wicket.IMetadataContext<java.io.Serializable,​org.apache.wicket.Component>, org.apache.wicket.IQueueRegion, org.apache.wicket.markup.html.IHeaderContributor, org.apache.wicket.markup.IMarkupCacheKeyProvider, org.apache.wicket.markup.IMarkupResourceStreamProvider, org.apache.wicket.page.IManageablePage, org.apache.wicket.request.component.IRequestableComponent, org.apache.wicket.request.component.IRequestablePage, org.apache.wicket.util.IHierarchical<org.apache.wicket.Component>, org.apache.wicket.util.io.IClusterable

    public class LayoutFilePage
    extends org.apache.wicket.markup.html.WebPage
    implements org.apache.wicket.markup.IMarkupResourceStreamProvider, org.apache.wicket.markup.IMarkupCacheKeyProvider
    The Wicket page used for processing a layout file.
    Since:
    6.0.0
    Version:
    $Revision$ $Date$
    See Also:
    Serialized Form
    • Field Summary

      • Fields inherited from class org.apache.wicket.Component

        ENABLE, FLAG_INITIALIZED, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING, RFLAG_CONTAINER_HAS_REMOVALS
    • Constructor Summary

      Constructors 
      Constructor Description
      LayoutFilePage()  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getCacheKey​(org.apache.wicket.MarkupContainer container, java.lang.Class<?> containerClass)  
      PresentationControllerHtml.DataPreviewMode getDataPreviewMode()  
      java.lang.String getExecutedProcessActionServiceInterfaceInstanceId()  
      java.lang.String getGeneratorPageCacheId()  
      java.lang.String getHighlightInterfaceInst()  
      javax.servlet.http.HttpServletResponse getHttpServletResponse()
      Returns the HTTP servlet response, either stored during the Component.beforeRender() or available through the current page's WebResponse.
      java.net.URL getLayoutFilePath()  
      java.util.Locale getLocale()  
      org.apache.wicket.util.resource.IResourceStream getMarkupResourceStream​(org.apache.wicket.MarkupContainer container, java.lang.Class<?> containerClass)  
      java.util.Map<java.lang.String,​java.lang.String[]> getMultiPartFormParameters()  
      java.lang.String getMultiPartFormServiceInterfaceInstance()  
      PageDocType getPageDocType()  
      IPageRenderer getPageRenderer()
      Returns the page renderer for this page.
      PageWebResource getPageWebResource()
      Returns the PageWebResource for this page.
      PortalRequestParameters getParameters()  
      java.util.List<java.lang.String> getParentChannelIds()  
      IPortalMode getPortalMode()  
      java.lang.String getPreviousParametersXmlString()  
      java.lang.String getRootChannelId()  
      static java.lang.String getRootChannelId​(PageConfig page)
      Returns the root channel id of the current page.
      boolean isForSelenium()  
      boolean isPrinting()  
      boolean isSafeMode()  
      protected void onBeforeRender()  
      protected void onDetach()  
      protected void setHeaders​(org.apache.wicket.request.http.WebResponse response)  
      • Methods inherited from class org.apache.wicket.markup.html.WebPage

        configureResponse, dirty, getMarkupType, homePageLink, onAfterRender, onRender, renderXmlDecl, reportMissingHead
      • Methods inherited from class org.apache.wicket.Page

        componentChanged, componentRendered, detachModels, dirty, getAutoIndex, getId, getPageClass, getPageId, getPageParameters, getPageReference, getRenderCount, getSizeInBytes, getStatelessHint, hierarchyAsString, internalOnModelChanged, isBookmarkable, isErrorPage, isPageStateless, onConfigure, onInitialize, renderPage, setFreezePageId, setNumericId, setStatelessHint, setWasCreatedBookmarkable, toString, wasCreatedBookmarkable, wasRendered
      • Methods inherited from class org.apache.wicket.MarkupContainer

        add, addDequeuedComponent, addOrReplace, autoAdd, canDequeueTag, contains, dequeue, dequeue, dequeuePreamble, findChildComponent, findComponentToDequeue, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getRegionMarkup, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onComponentTagBody, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, stream, streamChildren, toString, visitChildren, visitChildren
      • Methods inherited from class org.apache.wicket.Component

        add, addStateChange, beforeRender, canCallListener, canCallListenerAfterExpiry, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, createConverter, debug, detach, detachModel, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessages, getFlag, getInnermostModel, getInnermostModel, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, getMarkupTag, 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, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onComponentTag, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderPart, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlForListener, urlForListener, visitParents, 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.page.IManageablePage

        detach
      • Methods inherited from interface org.apache.wicket.IQueueRegion

        dequeue, getRegionMarkup, newDequeueContext
      • Methods inherited from interface org.apache.wicket.request.component.IRequestableComponent

        canCallListenerAfterExpiry, detach, get, getBehaviorById, getBehaviorId, getPage, getPageRelativePath
      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator
    • Constructor Detail

      • LayoutFilePage

        public LayoutFilePage()
    • Method Detail

      • getMarkupResourceStream

        public org.apache.wicket.util.resource.IResourceStream getMarkupResourceStream​(org.apache.wicket.MarkupContainer container,
                                                                                       java.lang.Class<?> containerClass)
        Specified by:
        getMarkupResourceStream in interface org.apache.wicket.markup.IMarkupResourceStreamProvider
      • getCacheKey

        public java.lang.String getCacheKey​(org.apache.wicket.MarkupContainer container,
                                            java.lang.Class<?> containerClass)
        Specified by:
        getCacheKey in interface org.apache.wicket.markup.IMarkupCacheKeyProvider
      • onBeforeRender

        protected void onBeforeRender()
        Overrides:
        onBeforeRender in class org.apache.wicket.Page
      • onDetach

        protected void onDetach()
        Overrides:
        onDetach in class org.apache.wicket.Page
      • getLocale

        public java.util.Locale getLocale()
        Overrides:
        getLocale in class org.apache.wicket.Component
      • setHeaders

        protected void setHeaders​(org.apache.wicket.request.http.WebResponse response)
        Overrides:
        setHeaders in class org.apache.wicket.markup.html.WebPage
      • isForSelenium

        public boolean isForSelenium()
      • getRootChannelId

        public java.lang.String getRootChannelId()
      • getParentChannelIds

        public java.util.List<java.lang.String> getParentChannelIds()
      • isSafeMode

        public boolean isSafeMode()
      • getHighlightInterfaceInst

        public java.lang.String getHighlightInterfaceInst()
      • getLayoutFilePath

        public java.net.URL getLayoutFilePath()
      • getExecutedProcessActionServiceInterfaceInstanceId

        public java.lang.String getExecutedProcessActionServiceInterfaceInstanceId()
      • getMultiPartFormParameters

        public java.util.Map<java.lang.String,​java.lang.String[]> getMultiPartFormParameters()
      • getMultiPartFormServiceInterfaceInstance

        public java.lang.String getMultiPartFormServiceInterfaceInstance()
      • getGeneratorPageCacheId

        public java.lang.String getGeneratorPageCacheId()
      • getPreviousParametersXmlString

        public java.lang.String getPreviousParametersXmlString()
      • isPrinting

        public boolean isPrinting()
      • getPageWebResource

        public PageWebResource getPageWebResource()
        Returns the PageWebResource for this page.
        Returns:
        the pageWebResource.
        Since:
        6.0.0
      • getPageRenderer

        public IPageRenderer getPageRenderer()
        Returns the page renderer for this page.
        Returns:
        the page renderer.
        Since:
        6.0.0
      • getRootChannelId

        public static java.lang.String getRootChannelId​(PageConfig page)
        Returns the root channel id of the current page.
        Parameters:
        page - the page config.
        Returns:
        the root channel id.
        Since:
        6.0.0
      • getHttpServletResponse

        public javax.servlet.http.HttpServletResponse getHttpServletResponse()
        Returns the HTTP servlet response, either stored during the Component.beforeRender() or available through the current page's WebResponse.

        The current page's WebResponse may not be available during <head> processing (as of Wicket 1.4). The response stored during the Component.beforeRender() is exactly to try to workaround this.

        Returns:
        the HTTP servlet response.
        Throws:
        java.lang.IllegalStateException - if no HTTP servlet response object could be obtained to be provided.
        Since:
        6.2.0
        See Also:
        WebResponse#getHttpServletResponse(), Component.beforeRender()