org.apache.wicket.markup.html.internal
Class InlineEnclosure

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.internal.Enclosure
                  extended by org.apache.wicket.markup.html.internal.InlineEnclosure
All Implemented Interfaces:
java.io.Serializable, java.lang.Iterable<Component>, IEventSink, IEventSource, IClusterable, IConverterLocator, IHeaderContributor, IComponentResolver, IRequestableComponent, IHierarchical<Component>

public class InlineEnclosure
extends Enclosure

An InlineEnclosure are automatically created by Wicket. Do not create it yourself. An InlineEnclosure container is created when <tr wicket:enclosure="controllingChildId"> (any html tag which can contain other html tags can be used in place of <tr>) is found in the markup. The child component (it's id defined as the value of the attribute, in the example, 'controllingChildId') controls the visibility of the whole enclosure and it's children. This also works in Ajax calls without extra markup or java code.

Author:
Joonas Hamalainen, Juergen Donnerstag
See Also:
EnclosureResolver, InlineEnclosureHandler, Serialized Form

Field Summary
 
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
 
Constructor Summary
InlineEnclosure(java.lang.String id, java.lang.String childId)
          Construct.
 
Method Summary
 IMarkupFragment getMarkup()
          InlineEnclosures keep their own cache of their markup because Component#markup is detached and later during Ajax request it is hard to re-lookup InlineEnclosure's markup from its parent.
protected  void onComponentTag(ComponentTag tag)
          Processes the component tag.
 boolean updateVisibility()
          Update the visibility of this In-line enclosure with that of the controlling child.
 
Methods inherited from class org.apache.wicket.markup.html.internal.Enclosure
getChild, getChildId, getEnclosureParent, isVisible, onInitialize, resolve
 
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, getAssociatedMarkupStream, getMarkup, getMarkupType, hasAssociatedMarkup, internalAdd, internalInitialize, iterator, iterator, onAfterRenderChildren, onComponentTagBody, onMarkupAttached, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, swap, toString, toString, visitChildren, visitChildren, visitChildren, visitChildren
 
Methods inherited from class org.apache.wicket.Component
add, addStateChange, afterRender, beforeRender, canCallListenerInterface, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, debug, detach, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessage, getFeedbackMessages, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, 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, internalOnModelChanged, internalPrepareForRender, internalRenderComponent, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisibleInHierarchy, locateMarkupStream, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onBeforeRender, onConfigure, onDetach, onEvent, onModelChanged, onModelChanging, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, 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, warn, wrap
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

InlineEnclosure

public InlineEnclosure(java.lang.String id,
                       java.lang.String childId)
Construct.

Parameters:
id -
childId -
isInlineEnclosure -
Method Detail

onComponentTag

protected void onComponentTag(ComponentTag tag)
Description copied from class: Component
Processes the component tag. Overrides of this method most likely should call the super implementation.

Overrides:
onComponentTag in class Component
Parameters:
tag - Tag to modify

updateVisibility

public boolean updateVisibility()
Update the visibility of this In-line enclosure with that of the controlling child.

Returns:
the new visibility setting.

getMarkup

public IMarkupFragment getMarkup()
InlineEnclosures keep their own cache of their markup because Component#markup is detached and later during Ajax request it is hard to re-lookup InlineEnclosure's markup from its parent.

Overrides:
getMarkup in class Component
Returns:
The markup fragment
See Also:
Component.getMarkup()


Copyright © 2006-2011 Apache Software Foundation. All Rights Reserved.