com.neurosys.modules.wicket.components

Class ScriptableFacetMetaAjaxButton<T extends FacetMeta>

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

org.apache.wicket.ajax.markup.html.form.AjaxButton

org.apache.wicket.extensions.ajax.markup.html.IndicatingAjaxButton

com.neurosys.site.wicket.components.ScriptableAjaxButton

com.neurosys.modules.wicket.components.ScriptableFacetMetaAjaxButton<T>

Type Parameters:

T - as FacetMeta

All Implemented Interfaces:

Serializable, org.apache.wicket.ajax.IAjaxIndicatorAware, org.apache.wicket.IClusterable, org.apache.wicket.IConverterLocator, org.apache.wicket.markup.html.form.IFormModelUpdateListener, org.apache.wicket.markup.html.form.IFormSubmittingComponent, org.apache.wicket.markup.html.form.IFormVisitorParticipant, org.apache.wicket.markup.html.form.ILabelProvider<String>

public abstract class ScriptableFacetMetaAjaxButton<T extends FacetMeta>
extends ScriptableAjaxButton

An Ajax Button that can be created from Configuration with details in FacetMeta
The following settings can be assigned

• FacetMeta.getDisplayName() - Display Name of Button
• FacetMeta.getAttributes().DESCRIPTION - Tool Tip that adds a title attribute as description + a class help-text
• FacetMeta.getAttributes().pre-action - ChangeListener invoked before anything else is called. The ChangeListener is passed the Object[]{FacetMeta.getAttribute(String).pre-action:event-name, model}
• FacetMeta.getSubmitTransformer() - The core Action to take on Click of the button. The Component.getDefaultModel() is passed to the Transformer
• FacetMeta.getDisplayTransformer() - TIf specified and the display Transformer returns null then only it iwll Hide the button
• FacetMeta.getAttributes().after-action - ChangeListener invoked after everything else is called (if no Exception occured). The ChangeListener is passed the Object[]{FacetMeta.getAttribute(String).after-action:event-name, model}

Example Configuration:

                
                        
                                
                                
                                
                                #{T(com.neurosys.content.domain.ContentType).BUTTON}{@code 
                                ...
                                
                                        
                
                        
                        
 }

Author:

Arjun Dhar

See Also:

ATTRIB_ defintiions for the attributyes this Button recognizes in {@link FacetMeta#getAttribute(String)}, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wicket.markup.html.form.FormComponent

org.apache.wicket.markup.html.form.FormComponent.AbstractVisitor, org.apache.wicket.markup.html.form.FormComponent.IVisitor

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

org.apache.wicket.Component.ComponentModelChange, org.apache.wicket.Component.EnabledChange, org.apache.wicket.Component.VisibilityChange

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIB_AFTER_ACTION_LISTENER ChangeListener invoked after everything else is called (if no Exception occured).
static String	ATTRIB_DESCRIPTION Help / Tilte details describing the Button Action to the user
static String	ATTRIB_PRE_ACTION_LISTENER ChangeListener invoked before anything else is called.

Fields inherited from class com.neurosys.site.wicket.components.ScriptableAjaxButton

MARKUP_ATTRIB_ACTION, MARKUP_ATTRIB_PRE_ACTION, proxyActionSuppliedScript, proxyPreActionSuppliedScript

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_CONFIGURED, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PATH_SEPARATOR, RENDER

Constructor Summary

Constructors

Constructor and Description
ScriptableFacetMetaAjaxButton(String id, org.apache.wicket.model.IModel model, org.apache.wicket.markup.html.form.Form form, T facetMeta)
ScriptableFacetMetaAjaxButton(String id, org.apache.wicket.model.IModel model, T facetMeta)

Method Summary

Modifier and Type	Method and Description
protected org.apache.wicket.ajax.IAjaxCallDecorator	getAjaxCallDecorator()
T	getFacetMeta()
protected abstract void	onFail(org.apache.wicket.ajax.AjaxRequestTarget target, Exception e)
void	onInitialize()
protected void	onSubmit(org.apache.wicket.ajax.AjaxRequestTarget target, org.apache.wicket.markup.html.form.Form<?> form)
protected abstract void	onSuccess(Object out, org.apache.wicket.ajax.AjaxRequestTarget target)
void	setFacetMeta(T facetMeta)

Methods inherited from class com.neurosys.site.wicket.components.ScriptableAjaxButton

defineAjaxCallDecorator, onComponentTag

Methods inherited from class org.apache.wicket.extensions.ajax.markup.html.IndicatingAjaxButton

getAjaxIndicatorMarkupId

Methods inherited from class org.apache.wicket.ajax.markup.html.form.AjaxButton

getForm, onError

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

getDefaultFormProcessing, getOnClickScript, initModel, onSubmit, setDefaultFormProcessing, updateModel

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

add, add, checkRequired, clearInput, convertInput, convertValue, error, getConvertedInput, getInput, getInputAsArray, getInputName, getModel, getModelObject, getModelValue, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputChanged, internalOnModelChanged, invalid, isInputNullable, isMultiPart, isPersistent, isRequired, isValid, newValidatable, onDetach, onDisabled, onInvalid, onValid, processChildren, processInput, setConvertedInput, setLabel, setModel, setModelObject, setModelValue, setModelValue, setPersistent, setRequired, setType, shouldTrimInput, supportsPersistence, trim, valid, validate, validateRequired, validateValidators, visitComponentsPostOrder, visitFormComponentsPostOrder

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

getLabel, setLabelInternal

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, isTransparentResolver, iterator, iterator, newMarkupResourceStream, onComponentTagBody, 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, 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, internalAttach, internalDetach, internalOnAttach, internalOnDetach, isActionAuthorized, isAncestorOf, isAttached, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, onAfterRender, onAttach, onBeforeRender, onBeginRequest, onConfigure, onEndRequest, 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

Methods inherited from interface org.apache.wicket.markup.html.form.IFormSubmittingComponent

getInputName

Field Detail

ATTRIB_DESCRIPTION

public static final String ATTRIB_DESCRIPTION

Help / Tilte details describing the Button Action to the user

See Also:

Constant Field Values

ATTRIB_PRE_ACTION_LISTENER

public static final String ATTRIB_PRE_ACTION_LISTENER

ChangeListener invoked before anything else is called. The ChangeListener is passed the Object[]{FacetMeta.getAttribute(String).pre-action:event-name, model}

See Also:

Constant Field Values

ATTRIB_AFTER_ACTION_LISTENER

public static final String ATTRIB_AFTER_ACTION_LISTENER

ChangeListener invoked after everything else is called (if no Exception occured). The ChangeListener is passed the Object[]{FacetMeta.getAttribute(String).after-action:event-name, model}

See Also:

Constant Field Values

Constructor Detail

ScriptableFacetMetaAjaxButton

public ScriptableFacetMetaAjaxButton(String id,
                                     org.apache.wicket.model.IModel model,
                                     T facetMeta)

ScriptableFacetMetaAjaxButton

public ScriptableFacetMetaAjaxButton(String id,
                                     org.apache.wicket.model.IModel model,
                                     org.apache.wicket.markup.html.form.Form form,
                                     T facetMeta)

Method Detail

onInitialize

public void onInitialize()

Overrides:

onInitialize in class org.apache.wicket.Component

onSuccess

protected abstract void onSuccess(Object out,
                                  org.apache.wicket.ajax.AjaxRequestTarget target)

onFail

protected abstract void onFail(org.apache.wicket.ajax.AjaxRequestTarget target,
                               Exception e)

onSubmit

protected void onSubmit(org.apache.wicket.ajax.AjaxRequestTarget target,
                        org.apache.wicket.markup.html.form.Form<?> form)

Specified by:

onSubmit in class org.apache.wicket.ajax.markup.html.form.AjaxButton

getAjaxCallDecorator

protected org.apache.wicket.ajax.IAjaxCallDecorator getAjaxCallDecorator()

Overrides:

getAjaxCallDecorator in class ScriptableAjaxButton

getFacetMeta

public T getFacetMeta()

setFacetMeta

public void setFacetMeta(T facetMeta)