Class AbstractPageBodyMiddleComponent

  • All Implemented Interfaces:
    Serializable, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.feedback.IFeedbackContributor, org.apache.wicket.IConverterLocator, org.apache.wicket.IMetadataContext<Serializable,​org.apache.wicket.Component>, org.apache.wicket.markup.html.IHeaderContributor, org.apache.wicket.request.component.IRequestableComponent, org.apache.wicket.util.IHierarchical<org.apache.wicket.Component>, org.apache.wicket.util.io.IClusterable
    Direct Known Subclasses:
    PageBodyMiddleTableComponent, PageBodyMiddleTablelessComponent, PortalStudioBodyMiddleComponent, XsltResultPageBodyMiddleComponent

    public abstract class AbstractPageBodyMiddleComponent
    extends HTMLFragmentComponent
    Abstract page component used as base implementation for other components.
    Since:
    6.0.0
    Version:
    $Revision: 22220 $ $Date: 2018-12-20 16:43:41 -0200 (Thu, 20 Dec 2018) $
    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
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      protected boolean columnsHavePercentWidths​(Node[] columns)
      Returns the columns width of the wished columns collection.
      protected Document generatePageLayout()
      Returns the page layout.
      protected String generateSpan​(ServiceInterfaceInstanceConfig serviceInterfaceInstConfig)
      Generates the Colspans and Rowspans of the component.
      protected String generateStyles​(ServiceInterfaceInstanceConfig serviceInterfaceInstConfig)
      Generates the style of the component.
      protected abstract CharSequence getHTMLFragment​(org.apache.wicket.markup.MarkupStream markupStream, org.apache.wicket.markup.ComponentTag openTag)
      Returns the HTML code fragment to be output by this component.
      protected Document getPageLayout()
      Returns the layout of the current Page.
      protected ServiceInterfaceInstanceConfig getServiceInterfaceInstanceConfigForRendering​(String serviceInterfaceInstanceId, ITransaction transaction)
      Returns the Interface instance config to be rendered.
      • Methods inherited from class org.apache.wicket.markup.html.WebComponent

        getWebApplication, getWebPage, getWebRequest, getWebResponse, getWebSession, onRender
      • Methods inherited from class org.apache.wicket.Component

        add, addStateChange, beforeRender, canCallListener, canCallListenerAfterExpiry, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, createConverter, debug, detach, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, get, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessages, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, getMarkupTag, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalInitialize, internalOnModelChanged, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onBeforeRender, onConfigure, onDetach, onEvent, onInitialize, onModelChanged, onModelChanging, onReAdd, onRemove, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderPart, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModel, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, toString, toString, urlFor, urlFor, urlFor, urlForListener, urlForListener, visitParents, visitParents, warn, wrap
    • Constructor Detail

      • AbstractPageBodyMiddleComponent

        public AbstractPageBodyMiddleComponent​(String id)
        Constructor for the class.
        Parameters:
        id - Component identifier
        Since:
        6.0.0
    • Method Detail

      • getHTMLFragment

        protected abstract CharSequence getHTMLFragment​(org.apache.wicket.markup.MarkupStream markupStream,
                                                        org.apache.wicket.markup.ComponentTag openTag)
        Description copied from class: HTMLFragmentComponent
        Returns the HTML code fragment to be output by this component. Called during HTMLFragmentComponent.onComponentTagBody(MarkupStream, ComponentTag).

        A return type of AppendingStringBuffer prevents the allocation of another HTML fragment string instance.

        Specified by:
        getHTMLFragment in class HTMLFragmentComponent
        Parameters:
        markupStream - the markup stream.
        openTag - the open tag for the body.
        Returns:
        the HTML code fragment. A null return value will leave the body empty.
      • getPageLayout

        protected final Document getPageLayout()
                                        throws PortalException
        Returns the layout of the current Page.
        Returns:
        the layout of the current Page.
        Throws:
        PortalException
        Since:
        6.0.0
      • generateStyles

        protected String generateStyles​(ServiceInterfaceInstanceConfig serviceInterfaceInstConfig)
                                 throws PortalException
        Generates the style of the component.
        Parameters:
        serviceInterfaceInstConfig - The instance interface configuration the component currently is.
        Returns:
        The component Style Sheet.
        Throws:
        PortalException
        Since:
        6.0.0
      • generateSpan

        protected String generateSpan​(ServiceInterfaceInstanceConfig serviceInterfaceInstConfig)
                               throws PortalException
        Generates the Colspans and Rowspans of the component.
        Parameters:
        serviceInterfaceInstConfig - The instance interface configuration the component currently is.
        Returns:
        the Colspans and Rowspans of the component.
        Throws:
        PortalException
        Since:
        6.0.0
      • columnsHavePercentWidths

        protected boolean columnsHavePercentWidths​(Node[] columns)
                                            throws PortalException
        Returns the columns width of the wished columns collection.
        Parameters:
        columns - the columns.
        Returns:
        the Columns width.
        Throws:
        PortalException
        Since:
        6.0.0
      • getServiceInterfaceInstanceConfigForRendering

        protected ServiceInterfaceInstanceConfig getServiceInterfaceInstanceConfigForRendering​(String serviceInterfaceInstanceId,
                                                                                               ITransaction transaction)
                                                                                        throws PortalException
        Returns the Interface instance config to be rendered.
        Parameters:
        serviceInterfaceInstanceId - The service interface identifier.
        transaction - the current transaction.
        Returns:
        the Interface instance config to be rendered.
        Throws:
        PortalException
        Since:
        6.0.0