com.premiumminds.webapp.wicket.drawer

Class DrawerManager

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.panel.Panel

com.premiumminds.webapp.wicket.drawer.DrawerManager

All Implemented Interfaces:

Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.feedback.IFeedbackContributor, org.apache.wicket.IConverterLocator, org.apache.wicket.IQueueRegion, org.apache.wicket.markup.html.IHeaderContributor, org.apache.wicket.request.component.IRequestableComponent, org.apache.wicket.util.IHierarchical<org.apache.wicket.Component>, org.apache.wicket.util.io.IClusterable

public class DrawerManager
extends org.apache.wicket.markup.html.panel.Panel

A wicket drawer manager that allows stackable modals and supports AJAX-based opening and closing.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.wicket.markup.html.panel.Panel

PANEL

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_INITIALIZED, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING

Constructor Summary

Constructors

Constructor and Description
DrawerManager(String id)

Method Summary

Modifier and Type	Method and Description
<T extends AbstractDrawer> T	getLast(Class<T> drawerClass)
String	getLastItemRelativePath()
void	pop(AbstractDrawer drawer, org.apache.wicket.ajax.AjaxRequestTarget target) Pops a series of open drawers from the stack and closes them, displaying the one underneath, or the main page.
void	push(AbstractDrawer drawer) Push and display a drawer on the page during page construction.
void	push(AbstractDrawer drawer, org.apache.wicket.ajax.AjaxRequestTarget target) Push and display a drawer on the page during an AJAX request.
void	push(AbstractDrawer drawer, org.apache.wicket.ajax.AjaxRequestTarget target, String cssClass) Push and display a drawer on the page during an AJAX request, and inject an optional CSS class onto the drawer's immediate container.
void	push(AbstractDrawer drawer, String cssClass) Push and display a drawer on the page during page construction, and inject an optional CSS class onto the drawer's immediate container.
void	renderHead(org.apache.wicket.markup.head.IHeaderResponse response)
void	replaceLast(AbstractDrawer newDrawer, org.apache.wicket.ajax.AjaxRequestTarget target) Replaces the topmost open drawer with a new one.

Methods inherited from class org.apache.wicket.markup.html.panel.Panel

getRegionMarkup, newMarkupSourcingStrategy

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

getWebApplication, getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

add, addDequeuedComponent, addOrReplace, autoAdd, canDequeueTag, contains, dequeue, dequeue, dequeuePreamble, findChildComponent, findComponentToDequeue, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onComponentTagBody, onDetach, onInitialize, onRender, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, stream, streamChildren, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, beforeRender, canCallListener, canCallListenerAfterExpiry, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, createConverter, 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, getFeedbackMessages, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, 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, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderPart, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlForListener, urlForListener, visitParents, visitParents, warn, wrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.wicket.IQueueRegion

dequeue, newDequeueContext

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

DrawerManager

public DrawerManager(String id)

Method Detail

push

public void push(AbstractDrawer drawer)

Push and display a drawer on the page during page construction. Do not call this method during an AJAX request. Use push(AbstractDrawer drawer, AjaxRequestTarget target) instead.

Parameters:

drawer - The drawer to be pushed. Cannot be null.

push

public void push(AbstractDrawer drawer,
                 org.apache.wicket.ajax.AjaxRequestTarget target)

Push and display a drawer on the page during an AJAX request.

Parameters:

drawer - The drawer to be pushed. Cannot be null.

target - The current AJAX target.

push

public void push(AbstractDrawer drawer,
                 String cssClass)

Push and display a drawer on the page during page construction, and inject an optional CSS class onto the drawer's immediate container. Do not call this method during an AJAX request. Use push(AbstractDrawer drawer, AjaxRequestTarget target, String cssClass) instead.

Parameters:

drawer - The drawer to be pushed. Cannot be null.

cssClass - The name of the class to be injected.

push

public void push(AbstractDrawer drawer,
                 org.apache.wicket.ajax.AjaxRequestTarget target,
                 String cssClass)

Push and display a drawer on the page during an AJAX request, and inject an optional CSS class onto the drawer's immediate container.

Parameters:

drawer - The drawer to be pushed. Cannot be null.

target - The current AJAX target.

cssClass - The name of the class to be injected.

pop

public void pop(AbstractDrawer drawer,
                org.apache.wicket.ajax.AjaxRequestTarget target)

Pops a series of open drawers from the stack and closes them, displaying the one underneath, or the main page. This method requires an AJAX request. DrawerManager does not support closing drawers during page construction. Note that this code sets each drawer's allow close flag to true. See AbstractDrawer for more information.

Parameters:

drawer - The last drawer to be closed. This drawer and all the ones above it are closed. Open drawers beneath this one are not. If this parameter is null or not in the stack, all the drawers are closed.

target - The current AJAX target. Cannot be null.

replaceLast

public void replaceLast(AbstractDrawer newDrawer,
                        org.apache.wicket.ajax.AjaxRequestTarget target)

Replaces the topmost open drawer with a new one. If there is no open drawer, this method does nothing. This method requires an AJAX request. DrawerManager does not support swapping drawers during page construction.

Parameters:

newDrawer - The new drawer to open. Cannot be null.

target - The current AJAX target. Cannot be null.

getLast

public <T extends AbstractDrawer> T getLast(Class<T> drawerClass)

Type Parameters:

T - drawer type

Parameters:

drawerClass - The expected class of the topmost open drawer.

Returns:

A reference to the topmost open drawer, or null if there isn't one. If the topmost open drawer cannot be cast to the class in the first argument, a runtime class cast exception occurs.

getLastItemRelativePath

public String getLastItemRelativePath()

Returns:

The wicket page relative path of the topmost open drawer, or null if there isn't an open drawer.

renderHead

public void renderHead(org.apache.wicket.markup.head.IHeaderResponse response)

Specified by:

renderHead in interface org.apache.wicket.markup.html.IHeaderContributor

Overrides:

renderHead in class org.apache.wicket.Component