de.alpharogroup.wicket.js.addon.popupoverlay

Class PopupoverlayPanel<T>

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

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

org.apache.wicket.markup.html.panel.GenericPanel<T>

de.alpharogroup.wicket.js.addon.popupoverlay.PopupoverlayPanel<T>

Type Parameters:

T - the generic type of the model.

All Implemented Interfaces:

Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.IConverterLocator, org.apache.wicket.IGenericComponent<T>, 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 abstract class PopupoverlayPanel<T>
extends org.apache.wicket.markup.html.panel.GenericPanel<T>

The Class PopupoverlayPanel is production ready and is also an example how to use the PopupoverlayBehavior.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLOSE_OVERLAY_SUFFIX
static String	OPEN_OVERLAY_SUFFIX

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

PANEL

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

Constructors

Constructor and Description
PopupoverlayPanel(String id, org.apache.wicket.model.IModel<T> model) Instantiates a new popupoverlay panel.

Method Summary

Modifier and Type	Method and Description
protected org.apache.wicket.markup.html.form.Button	newOpenButton(String id) Factory method for create the Button.
protected abstract org.apache.wicket.MarkupContainer	newOverlayReference(String id, org.apache.wicket.model.IModel<T> model) Abstract factory method for create the new overlay reference MarkupContainer.
protected PopupoverlayBehavior	newPopupoverlayBehavior() Factory method for create the PopupoverlayBehavior.
protected PopupoverlaySettings	newPopupoverlaySettings() Factory method for create the PopupoverlaySettings.
void	onBeforeRender()

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

getModel, getModelObject, setModel, setModelObject

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

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, addOrReplace, autoAdd, contains, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, onAfterRenderChildren, onComponentTagBody, 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, clearOriginalDestination, 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, 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, internalPrepareForRender, internalRenderComponent, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onComponentTag, onConfigure, onDetach, onEvent, onInitialize, onModelChanged, onModelChanging, onReAdd, 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, visitParents, warn, wrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

OPEN_OVERLAY_SUFFIX

public static final String OPEN_OVERLAY_SUFFIX

See Also:

Constant Field Values

CLOSE_OVERLAY_SUFFIX

public static final String CLOSE_OVERLAY_SUFFIX

See Also:

Constant Field Values

Constructor Detail

PopupoverlayPanel

public PopupoverlayPanel(String id,
                         org.apache.wicket.model.IModel<T> model)

Instantiates a new popupoverlay panel.

Parameters:

id - the id

model - the model

Method Detail

newOpenButton

protected org.apache.wicket.markup.html.form.Button newOpenButton(String id)

Factory method for create the Button. This method is invoked in the method Component.onBeforeRender() from the derived classes and can be overridden so users can provide their own version of a Button.

Parameters:

id - the wicket id

Returns:

the Button

newOverlayReference

protected abstract org.apache.wicket.MarkupContainer newOverlayReference(String id,
                                                                         org.apache.wicket.model.IModel<T> model)

Abstract factory method for create the new overlay reference MarkupContainer. This method is invoked in the method Component.onBeforeRender() from the derived classes and must be overridden so users can provide their own version of the overlay component. Note: If you have in your settings the attribute 'blur' set to false than you have to provide a close component. As from the documentation of the popupoverlay plugin this component have to provide the class attribute with the value 'overlayReference.getMarkupId() + "_close"'. For instance:

 Button button = new Button("button");
 getOverlayReference().add(button);
 // add class attributte with the markup id from the overlay with the
 // suffix '_close' that indicates that the overlay shell close...
 button.add(new AttributeModifier("class", getOverlayReference().getMarkupId() + "_close"));
 

Parameters:

id - the id

model - the model

Returns:

the markup container

newPopupoverlayBehavior

protected PopupoverlayBehavior newPopupoverlayBehavior()

Factory method for create the PopupoverlayBehavior. This method is invoked in the method Component.onBeforeRender() from the derived classes and can be overridden so users can provide their own version of the PopupoverlayBehavior.

Returns:

the popupoverlay behavior

newPopupoverlaySettings

protected PopupoverlaySettings newPopupoverlaySettings()

Factory method for create the PopupoverlaySettings. This method is invoked in the method newPopupoverlayBehavior() from the derived classes and can be overridden so users can provide their own version of the PopupoverlaySettings.

Returns:

the PopupoverlaySettings.

onBeforeRender

public void onBeforeRender()

Overrides:

onBeforeRender in class org.apache.wicket.Component