Package com.googlecode.wicket.jquery.ui.form.button

Class SecuredButton

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.form.LabeledWebMarkupContainer

org.apache.wicket.markup.html.form.FormComponent<String>

org.apache.wicket.markup.html.form.Button

com.googlecode.wicket.jquery.ui.form.button.Button

com.googlecode.wicket.jquery.ui.form.button.SecuredButton

All Implemented Interfaces:

com.googlecode.wicket.jquery.core.IJQueryWidget, Serializable, Iterable<Component>, IEventSink, IEventSource, IFeedbackContributor, IConverterLocator, IGenericComponent<String,FormComponent<String>>, IMetadataContext<Serializable,Component>, IFormModelUpdateListener, IFormSubmitter, IFormSubmittingComponent, IFormVisitorParticipant, ILabelProvider<String>, IHeaderContributor, IRequestableComponent, IHierarchical<Component>, IClusterable

public abstract class SecuredButton
extends Button

Provides a jQuery button based on the built-in AjaxButton, protected by roles. Roles are checked against an IJQuerySecurityProvider
Assuming the WebSession is implementing IJQuerySecurityProvider if not provided.

Author:

Sebastien Briquet - sebfz1

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.googlecode.wicket.jquery.core.IJQueryWidget

com.googlecode.wicket.jquery.core.IJQueryWidget.JQueryWidget

Field Summary

Fields inherited from class org.apache.wicket.markup.html.form.FormComponent

FLAG_CONVERT_EMPTY_INPUT_STRING_TO_NULL, VALUE_SEPARATOR

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
SecuredButton(String id, com.googlecode.wicket.jquery.core.IJQuerySecurityProvider provider, String... roles)	Constructor
SecuredButton(String id, String... roles)	Constructor
SecuredButton(String id, IModel<String> model, com.googlecode.wicket.jquery.core.IJQuerySecurityProvider provider, String... roles)	Constructor
SecuredButton(String id, IModel<String> model, String... roles)	Constructor

Method Summary

Modifier and Type	Method	Description
protected String	getIcon()	Gets the icon being displayed in the button
boolean	isLocked()	Indicates whether the button is locked.
protected void	onComponentTag(ComponentTag tag)
protected void	onConfigure()
void	setRoles(String[] roles)	Sets the roles allowed to enable the button

Methods inherited from class com.googlecode.wicket.jquery.ui.form.button.Button

newWidgetBehavior, onBeforeRender, onConfigure, onInitialize

Methods inherited from class org.apache.wicket.markup.html.form.Button

getDefaultFormProcessing, getForm, getOnClickScript, initModel, onAfterSubmit, onComponentTagBody, onError, onSubmit, renderHead, setDefaultFormProcessing, updateModel

Methods inherited from class org.apache.wicket.markup.html.form.FormComponent

add, add, checkRequired, clearInput, convertInput, convertValue, error, getConvertedInput, getDefaultLabel, getDefaultLabel, getInput, getInputAsArray, getInputName, getModelValue, getParameterValues, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputChanged, internalOnModelChanged, invalid, isInputNullable, isMultiPart, isRequired, isValid, newValidatable, newValidationError, onBeforeRender, onDetach, onDisabled, onInvalid, onValid, processChildren, processInput, remove, reportRequiredError, setConvertedInput, setLabel, setModelValue, setRequired, setType, shouldTrimInput, trim, updateAutoLabels, updateAutoLabels, updateCollectionModel, valid, validate, validateRequired, validateValidators, visitComponentsPostOrder, visitFormComponentsPostOrder

Methods inherited from class org.apache.wicket.markup.html.form.LabeledWebMarkupContainer

getLabel

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, getRegionMarkup, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onRender, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, 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, 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, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, 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.markup.html.form.IFormSubmittingComponent

getInputName

Methods inherited from interface org.apache.wicket.IGenericComponent

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

SecuredButton

public SecuredButton(String id,
                     String... roles)

Constructor

Parameters:

id - the markup id

roles - list of roles allowed to enable the button

SecuredButton

public SecuredButton(String id,
                     com.googlecode.wicket.jquery.core.IJQuerySecurityProvider provider,
                     String... roles)

Constructor

Parameters:

id - the markup id

provider - the IJQuerySecurityProvider that will check roles

roles - list of roles allowed to enable the button

SecuredButton

public SecuredButton(String id,
                     IModel<String> model,
                     String... roles)

Constructor

Parameters:

id - the markup id

model - the IModel

roles - list of roles allowed to enable the button

SecuredButton

public SecuredButton(String id,
                     IModel<String> model,
                     com.googlecode.wicket.jquery.core.IJQuerySecurityProvider provider,
                     String... roles)

Constructor

Parameters:

id - the markup id

model - the IModel

provider - the IJQuerySecurityProvider

roles - list of roles allowed to enable the button

Method Detail

setRoles

public void setRoles(String[] roles)

Sets the roles allowed to enable the button

Parameters:

roles - list of roles allowed to enable the button

isLocked

public final boolean isLocked()

Indicates whether the button is locked.

Returns:

the result of IJQuerySecurityProvider.hasRole(String...)

getIcon

protected String getIcon()

Description copied from class: Button

Gets the icon being displayed in the button

Overrides:

getIcon in class Button

Returns:

JQueryIcon.NONE by default

onConfigure

protected void onConfigure()

Overrides:

onConfigure in class Component

onComponentTag

protected void onComponentTag(ComponentTag tag)

Overrides:

onComponentTag in class Button