Class OutComponent

  • All Implemented Interfaces:
    Serializable, org.apache.wicket.IClusterable, org.apache.wicket.IConverterLocator

    public class OutComponent
    extends HTMLFragmentComponent
    Component used to output a EL expression in the HTML body. Usage is equivalent of the JSTL core out element. The following attributes in the HTML element are used:
    • value: contains the value to be evaluated. It may contain EL expression inside the ${ ... } area.
    • escapeXml: indicates if the evaluated value should be escaped. This attribute is optional and default is true
    • default: the value to be used if the value evaluates to null or an empty string. If not specified, the default is an empty string.

    The attributes will have any HTML entity in their value decoded.

    Examples:

    Layout File CodeOutput (HTML source code)
    <el:out value="${1+1}&quot;">Example HTML</el:out> 2&quot;
    <el:out value="${1+1}&quot;" escapeXml="false">Example HTML</el:out> 2"
    <el:out value="${null}" default="&quot;">Example HTML</el:out> &quot;
    <el:out value="${null}" escapeXml="false" default="&quot;">Example HTML</el:out> "
    Since:
    6.0.0
    Version:
    $Revision: 13093 $ $Date: 2011-05-28 18:40:18 -0300 (Sat, 28 May 2011) $
    See Also:
    Serialized Form
    • Nested Class Summary

      • Nested classes/interfaces inherited from class org.apache.wicket.Component

        org.apache.wicket.Component.ComponentModelChange, org.apache.wicket.Component.EnabledChange, org.apache.wicket.Component.IVisitor<T extends org.apache.wicket.Component>, org.apache.wicket.Component.VisibilityChange
    • Field Summary

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

        ENABLE, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PATH_SEPARATOR, RENDER
    • Constructor Summary

      Constructors 
      Constructor Description
      OutComponent​(String id, boolean autoRenderBodyOnly)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected 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.
      • Methods inherited from class org.apache.wicket.markup.html.WebComponent

        onRender
      • Methods inherited from class org.apache.wicket.Component

        add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, continueToOriginalDestination, debug, detach, detachBehaviors, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getBehaviors, getBehaviors, getBehaviorsRawList, getClassRelativePath, getComponentBorder, getConverter, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdImpl, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalAttach, internalDetach, internalOnAttach, internalOnDetach, internalOnModelChanged, isActionAuthorized, isAncestorOf, isAttached, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, onAfterRender, onAttach, onBeforeRender, onBeginRequest, onDetach, onEndRequest, onModelChanged, onModelChanging, onRemove, prepareForRender, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setDefaultModel, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMarkupIdImpl, setMarkupStream, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, toString, toString, urlFor, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, warn, wrap
    • Constructor Detail

      • OutComponent

        public OutComponent​(String id,
                            boolean autoRenderBodyOnly)
    • Method Detail

      • getHTMLFragment

        protected 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.