Module wicket.bootstrap.core

Package de.agilecoders.wicket.core.markup.html.bootstrap.dialog

Class Alert

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<String>

de.agilecoders.wicket.core.markup.html.bootstrap.dialog.Alert

All Implemented Interfaces:

Serializable, Iterable<Component>, IEventSink, IEventSource, IFeedbackContributor, IConverterLocator, IGenericComponent<String,GenericPanel<String>>, IMetadataContext<Serializable,Component>, IQueueRegion, IHeaderContributor, IRequestableComponent, IHierarchical<Component>, IClusterable

Direct Known Subclasses:

NotificationAlert

public class Alert
extends GenericPanel<String>

A bootstrap styled panel for success, warning, and error messages usage:

     add(new Alert("id", Model.of("message text")));
 

Author:

miha

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Alert.Type	The Type enum defines all possible alert types.

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, RFLAG_CONTAINER_HAS_REMOVALS

Constructor Summary

Constructors

Constructor	Description
Alert(String id, IModel<String> message)	Constructor.
Alert(String id, IModel<String> message, IModel<String> header)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected Component	createMessage(String markupId, IModel<String> message)	creates a new message component.
protected void	detachModel()
protected final Component	getMessage()
Alert	hideAfter(Duration duration)	hides the alert box after given duration.
protected void	onComponentTag(ComponentTag tag)
protected void	onConfigure()
protected void	onInitialize()
void	renderHead(IHeaderResponse response)
Alert	setCloseButtonVisible(boolean visible)	Sets whether the close button is visible.
Alert	type(Alert.Type type)	Sets the alert type.
Alert	useInlineHeader(boolean useInlineHeader)	Whether to use an inline or block header.
Alert	withHeader(IModel<String> header)	Sets the header message.
Alert	withMessage(IModel<String> message)	Sets the message.

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, 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, 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, getMarkupTag, 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, 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.IGenericComponent

getDefaultModel, getDefaultModelObject, getModel, getModelObject, setDefaultModel, setDefaultModelObject, setModel, setModelObject

Methods inherited from interface org.apache.wicket.IQueueRegion

dequeue, newDequeueContext

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

Alert

public Alert(String id,
 IModel<String> message)

Constructor.

Parameters:

id - the wicket component id.

message - the alert message

Alert

public Alert(String id,
 IModel<String> message,
 IModel<String> header)

Constructor.

Parameters:

id - the wicket component id.

message - the alert message

header - the title of the alert message

Method Details

getMessage

protected final Component getMessage()

onInitialize

protected void onInitialize()

Overrides:

onInitialize in class MarkupContainer

onComponentTag

protected void onComponentTag(ComponentTag tag)

Overrides:

onComponentTag in class Component

createMessage

protected Component createMessage(String markupId,
 IModel<String> message)

creates a new message component.

Parameters:

markupId - The component id

message - The message as IModel

Returns:

new message component

setCloseButtonVisible

public Alert setCloseButtonVisible(boolean visible)

Sets whether the close button is visible.

Parameters:

visible - True if the close button is visible.

Returns:

This

renderHead

public void renderHead(IHeaderResponse response)

Specified by:

renderHead in interface IHeaderContributor

Overrides:

renderHead in class Component

withMessage

public Alert withMessage(IModel<String> message)

Sets the message.

Parameters:

message - The message.

Returns:

This instance for chaining.

withHeader

public Alert withHeader(IModel<String> header)

Sets the header message.

Parameters:

header - The header message.

Returns:

This instance for chaining.

type

public Alert type(Alert.Type type)

Sets the alert type.

Parameters:

type - to use.

Returns:

This.

hideAfter

public Alert hideAfter(Duration duration)

hides the alert box after given duration.

Parameters:

duration - the duration to use for closing the alert box

Returns:

this.

useInlineHeader

public Alert useInlineHeader(boolean useInlineHeader)

Whether to use an inline or block header.

Parameters:

useInlineHeader - true to use inline header

Returns:

This

onConfigure

protected void onConfigure()

Overrides:

onConfigure in class Component

detachModel

protected void detachModel()

Overrides:

detachModel in class Component