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

java.lang.Object
  org.apache.wicket.Component
      org.apache.wicket.MarkupContainer
          org.apache.wicket.markup.html.WebMarkupContainer
              org.apache.wicket.markup.html.internal.Enclosure
                  org.apache.wicket.markup.html.internal.InlineEnclosure

All Implemented Interfaces:

Serializable, IClusterable, IConverterLocator

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

See Also:

EnclosureResolver, InlineEnclosureHandler, Serialized Form

Nested Class Summary

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

Component.ComponentModelChange, Component.EnabledChange, Component.IVisitor<T extends Component>, Component.VisibilityChange

Field Summary

Fields inherited from class org.apache.wicket.markup.html.internal.Enclosure

childId

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_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER

Constructor Summary

InlineEnclosure(String id, String childId)
Construct.

Method Summary

String	getChildId() Returns the controlling child's Id
boolean	isVisible() Gets whether this component and any children are visible.
protected void	onAfterRenderChildren()
protected void	onComponentTagBody(MarkupStream markupStream, ComponentTag enclosureOpenTag) Handle the container's body.
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

getEnclosureParent, isTransparentResolver, onDetach

Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer

getMarkupType, getWebPage, getWebRequest

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, autoAdd, contains, findMarkupStream, get, get, getAssociatedMarkupStream, getMarkupStream, hasAssociatedMarkup, internalAdd, iterator, iterator, newMarkupResourceStream, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, renderNext, replace, setDefaultModel, setMarkupStream, size, swap, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, debug, detach, detachBehaviors, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, 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, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, onAfterRender, onAttach, onBeforeRender, onBeginRequest, onComponentTag, onConfigure, onEndRequest, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, urlFor, 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(String id,
                       String childId)

Construct.

Parameters:

id -

childId -

isInlineEnclosure -

Method Detail

isVisible

public boolean isVisible()

Description copied from class: Component

Gets whether this component and any children are visible.

WARNING: this method can be called multiple times during a request. If you override this method, it is a good idea to keep it cheap in terms of processing. Alternatively, you can call Component.setVisible(boolean).

Overrides:

isVisible in class Component

Returns:

True if component and any children are visible

onAfterRenderChildren

protected void onAfterRenderChildren()

Overrides:

onAfterRenderChildren in class MarkupContainer

See Also:

Component.onAfterRenderChildren()

updateVisibility

public boolean updateVisibility()

Update the visibility of this In-line enclosure with that of the controlling child.

Returns:

the new visibility setting.

onComponentTagBody

protected void onComponentTagBody(MarkupStream markupStream,
                                  ComponentTag enclosureOpenTag)

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 Enclosure

Parameters:

markupStream - The markup stream

enclosureOpenTag - The open tag for the body

See Also:

MarkupContainer.onComponentTagBody(org.apache.wicket.markup.MarkupStream, org.apache.wicket.markup.ComponentTag)

getChildId

public String getChildId()

Returns the controlling child's Id

Returns:

the id of the child component