org.apache.wicket.markup.html.panel
Class Fragment

java.lang.Object
  extended by org.apache.wicket.Component
      extended by org.apache.wicket.MarkupContainer
          extended by org.apache.wicket.markup.html.WebMarkupContainer
              extended by org.apache.wicket.markup.html.WebMarkupContainerWithAssociatedMarkup
                  extended by org.apache.wicket.markup.html.panel.Fragment
All Implemented Interfaces:
java.io.Serializable, java.lang.Iterable<Component>, IClusterable, IConverterLocator, IRequestableComponent

public class Fragment
extends WebMarkupContainerWithAssociatedMarkup

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. Since it can be anywhere, the component whose markup contains the fragment's markup must be provided (markup provider).

  <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", myPage);
 

Author:
Juergen Donnerstag
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.apache.wicket.Component
ENABLE, FLAG_CONFIGURED, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PATH_SEPARATOR, RENDER
 
Constructor Summary
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
 MarkupStream getAssociatedMarkupStream(boolean throwException)
          Gets a fresh markup stream that contains the (immutable) markup resource for this class.
 IMarkupFragment getMarkup(Component child)
          Get the childs markup
 MarkupContainer getMarkupProvider()
          Returns markup provider associated with this fragment
 boolean hasAssociatedMarkup()
           
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 org.apache.wicket.markup.html.WebMarkupContainerWithAssociatedMarkup
findMarkupInAssociatedFileHeader, renderHead, renderHeadFromAssociatedMarkupFile
 
Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer
getWebPage, getWebRequest
 
Methods inherited from class org.apache.wicket.MarkupContainer
add, addOrReplace, autoAdd, contains, get, get, getAssociatedMarkup, getMarkupStream, getMarkupType, internalAdd, iterator, iterator, onMarkupAttached, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, setMarkupStream, size, swap, toString, toString, visitChildren, visitChildren
 
Methods inherited from class org.apache.wicket.Component
add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, canCallListenerInterface, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, debug, detach, detachBehaviors, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getBehaviors, getBehaviors, getBehaviorsRawList, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, 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, internalOnModelChanged, isActionAuthorized, isAttached, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onConfigure, onDetach, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponent, renderComponentTag, rendered, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, warn, wrap
 
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,
                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(org.apache.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(org.apache.wicket.markup.MarkupStream, org.apache.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

hasAssociatedMarkup

public boolean hasAssociatedMarkup()
Overrides:
hasAssociatedMarkup in class MarkupContainer
Returns:
True if this markup container has associated markup
See Also:
MarkupContainer.hasAssociatedMarkup()

getAssociatedMarkupStream

public MarkupStream getAssociatedMarkupStream(boolean throwException)
Description copied from class: MarkupContainer
Gets a fresh markup stream that contains the (immutable) markup resource for this class.

Overrides:
getAssociatedMarkupStream in class MarkupContainer
Parameters:
throwException - If true, throw an exception, if markup could not be found
Returns:
A stream of MarkupElement elements
See Also:
MarkupContainer.getAssociatedMarkupStream(boolean)

getMarkupProvider

public final MarkupContainer getMarkupProvider()
Returns markup provider associated with this fragment

Returns:
markup provider

getMarkup

public IMarkupFragment getMarkup(Component child)
Description copied from class: MarkupContainer
Get the childs markup

Overrides:
getMarkup in class MarkupContainer
Parameters:
child - The child component. If null, the container's markup will be returned. See Border, Panel or Enclosure where getMarkup(null) != getMarkup().
Returns:
The childs markup
See Also:
MarkupContainer.getMarkup(org.apache.wicket.Component)


Copyright © 2004-2010 Apache Software Foundation. All Rights Reserved.