wicket.markup.html.panel
Class Fragment

java.lang.Object
  wicket.Component
      wicket.MarkupContainer
          wicket.markup.html.WebMarkupContainer
              wicket.markup.html.panel.Fragment

All Implemented Interfaces:

java.io.Serializable

public class Fragment
extends WebMarkupContainer

Usually you either have a markup file or a xml tag with wicket:id="myComponent" to associate markup with a component. However in some rare cases, especially when working with small panels it is a bit awkward to maintain tiny pieces of markup in plenty of panel markup files. Use cases are for example list views where list items are different depending on a state.

Fragments provide a means to maintain the panels tiny piece of markup in the parents markup file.

             <span wicket:id="myPanel">Example input (will be removed)</span>
            
             <wicket:fragment wicket:id="frag1">panel 1</wicket:fragment>
             <wicket:fragment wicket:id="frag2">panel 2</wicket:fragment>
 

             add(new Fragment("myPanel1", "frag1");
 

Author:

Juergen Donnerstag

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class wicket.Component

Component.ComponentModelChange, Component.EnabledChange, Component.IVisitor, Component.VisibilityChange

Field Summary

Fields inherited from class wicket.Component

ENABLE, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PATH_SEPARATOR, RENDER

Constructor Summary

Fragment(java.lang.String id, java.lang.String markupId)
Constructor.

Fragment(java.lang.String id, java.lang.String markupId, IModel model)
Constructor.

Fragment(java.lang.String id, java.lang.String markupId, MarkupContainer markupProvider)
Constructor.

Fragment(java.lang.String id, java.lang.String markupId, MarkupContainer markupProvider, IModel model)
Constructor.

Method Summary

protected MarkupStream	chooseMarkupStream(MarkupStream markupStream) Get the markup stream which shall be used to search for the fragment
protected void	onComponentTag(ComponentTag tag) Make sure we open up open-close tags to open-body-close
protected void	onComponentTagBody(MarkupStream markupStream, ComponentTag openTag) Handle the container's body.
void	setMarkupTagReferenceId(java.lang.String markupId) The associated markup fragment can be modified

Methods inherited from class wicket.markup.html.WebMarkupContainer

getMarkupType, getWebPage

Methods inherited from class wicket.MarkupContainer

add, autoAdd, contains, findMarkupStream, get, getAssociatedMarkupStream, getMarkupStream, internalAdd, internalAttach, internalDetach, isTransparentResolver, iterator, iterator, newMarkupResourceStream, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, replace, setMarkupStream, setModel, size, toString, toString, visitChildren, visitChildren

Methods inherited from class wicket.Component

add, addStateChange, checkComponentTag, checkComponentTagAttribute, continueToOriginalDestination, debug, detachBehaviors, detachModel, detachModels, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getApplicationPages, getApplicationSettings, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMetaData, getModel, getModelComparator, getModelObject, getModelObjectAsString, getOutputMarkupId, getPage, getPageFactory, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getString, getString, getString, getStyle, getVariation, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnAttach, internalOnDetach, internalOnModelChanged, isActionAuthorized, isAncestorOf, isBehaviorAccepted, isEnableAllowed, isEnabled, isHeadRendered, isIgnoreAttributeModifier, isRenderAllowed, isVersioned, isVisible, isVisibleInHierarchy, modelChanged, modelChanging, newPage, newPage, onAfterRender, onAttach, onBeforeRender, onBeginRequest, onDetach, onEndRequest, onModelChanged, onModelChanging, onRender, redirectToInterceptPage, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderedBehaviors, renderHead, replaceComponentTagBody, replaceWith, resetHeadRendered, sameRootModel, sameRootModel, setAuto, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMetaData, setModelObject, setOutputMarkupId, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisible, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, warn

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Fragment

public Fragment(java.lang.String id,
                java.lang.String markupId)

Constructor.

Parameters:

id - The component id

markupId - The associated id of the associated markup fragment

See Also:

Component.Component(String)

Fragment

public Fragment(java.lang.String id,
                java.lang.String markupId,
                IModel model)

Constructor.

Parameters:

id - The component id

markupId - The associated id of the associated markup fragment

model - The model for this fragment

See Also:

Component.Component(String)

Fragment

public Fragment(java.lang.String id,
                java.lang.String markupId,
                MarkupContainer markupProvider)

Constructor.

Parameters:

id - The component id

markupId - The associated id of the associated markup fragment

markupProvider - The component whose markup contains the fragment's markup

See Also:

Component.Component(String)

Fragment

public Fragment(java.lang.String id,
                java.lang.String markupId,
                MarkupContainer markupProvider,
                IModel model)

Constructor.

Parameters:

id - The component id

markupId - The associated id of the associated markup fragment

markupProvider - The component whose markup contains the fragment's markup

model - The model for this fragment

See Also:

Component.Component(String)

Method Detail

setMarkupTagReferenceId

public final void setMarkupTagReferenceId(java.lang.String markupId)

The associated markup fragment can be modified

Parameters:

markupId -

onComponentTag

protected void onComponentTag(ComponentTag tag)

Make sure we open up open-close tags to open-body-close

Overrides:

onComponentTag in class Component

Parameters:

tag - Tag to modify

See Also:

Component.onComponentTag(wicket.markup.ComponentTag)

onComponentTagBody

protected void onComponentTagBody(MarkupStream markupStream,
                                  ComponentTag openTag)

Description copied from class: MarkupContainer

Handle the container's body. If your override of this method does not advance the markup stream to the close tag for the openTag, a runtime exception will be thrown by the framework.

Overrides:

onComponentTagBody in class MarkupContainer

Parameters:

markupStream - The markup stream

openTag - The open tag for the body

See Also:

Component.onComponentTagBody(wicket.markup.MarkupStream, wicket.markup.ComponentTag)

chooseMarkupStream

protected MarkupStream chooseMarkupStream(MarkupStream markupStream)

Get the markup stream which shall be used to search for the fragment

Parameters:

markupStream - The markup stream is associated with the component (not the fragment)

Returns:

The markup stream to be used to find the fragment markup