Package com.inductiveautomation.ignition.gateway.web.pages

Class BasePage

  • 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.IConverterLocator, org.apache.wicket.IRedirectListener, org.apache.wicket.IRequestListener, org.apache.wicket.markup.html.IHeaderContributor, 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
    Direct Known Subclasses:
    AuthenticatedPage, InterstitialPage
    public abstract class BasePage
extends org.apache.wicket.markup.html.WebPage
    BasePage is the base of all the wicket pages except for the context loading page.
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  BasePage.Category  

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static org.apache.wicket.request.resource.ResourceReference IGNITION_LIB  

      • 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 
      Constructor Description
      BasePage()  
      BasePage​(org.apache.wicket.request.mapper.parameter.PageParameters pageParameters)  

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      protected java.lang.String getHeaderLogoCssClass()  
      protected abstract NavLocation getNavLocation()  
      protected java.net.URI getReturnTo()  
      static com.google.common.collect.ImmutableCollection<java.lang.String> getSecurityZones​(GatewayContext context, javax.servlet.http.HttpServletRequest request)  
      protected org.apache.wicket.Component getSidebarComponent()
      A secondary component that will be displayed 'next to' primary page content.
      protected LoggerEx log()  
      protected void onBeforeRender()  
      void renderHead​(org.apache.wicket.markup.head.IHeaderResponse response)  
      void setLocale​(java.util.Locale value)  

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

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

      • 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, onDetach, onInitialize, 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, internalAdd, internalInitialize, iterator, iterator, onAfterRenderChildren, onComponentTagBody, 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, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, 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, 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, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onComponentTag, onConfigure, onEvent, onModelChanged, onModelChanging, onReAdd, 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, 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.request.component.IRequestableComponent

        detach, get, getBehaviorById, getBehaviorId, getPage, getPageRelativePath

      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator

    • Field Detail

      • IGNITION_LIB

        public static final org.apache.wicket.request.resource.ResourceReference IGNITION_LIB

    • Constructor Detail

      • BasePage

        public BasePage()

      • BasePage

        public BasePage​(@Nullable
                org.apache.wicket.request.mapper.parameter.PageParameters pageParameters)

    • Method Detail

      • getSecurityZones

        public static com.google.common.collect.ImmutableCollection<java.lang.String> getSecurityZones​(GatewayContext context,
                                                                                               javax.servlet.http.HttpServletRequest request)

      • getReturnTo

        protected java.net.URI getReturnTo()

      • getHeaderLogoCssClass

        protected java.lang.String getHeaderLogoCssClass()

      • getNavLocation

        protected abstract NavLocation getNavLocation()

      • setLocale

        public void setLocale​(java.util.Locale value)

      • renderHead

        public void renderHead​(org.apache.wicket.markup.head.IHeaderResponse response)
        Specified by:
        renderHead in interface org.apache.wicket.markup.html.IHeaderContributor
        Overrides:
        renderHead in class org.apache.wicket.Component

      • onBeforeRender

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

      • getSidebarComponent

        protected org.apache.wicket.Component getSidebarComponent()
        A secondary component that will be displayed 'next to' primary page content. Empty by default. This component must have a markupId of sidebarPanel.