Package com.googlecode.wicket.jquery.ui.effect

Class JQueryEffectContainer

java.lang.Object
org.apache.wicket.Component
org.apache.wicket.MarkupContainer
org.apache.wicket.markup.html.WebMarkupContainer
com.googlecode.wicket.jquery.ui.effect.JQueryEffectContainer
All Implemented Interfaces:
IEffectListener, 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.IMetadataContext<Serializable,org.apache.wicket.Component>, 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 JQueryEffectContainer extends org.apache.wicket.markup.html.WebMarkupContainer implements IEffectListener
Provides a WebMarkupContainer on which effect can be played
Author:
Sebastien Briquet - sebfz1
See Also:

  • Field Summary

    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
    JQueryEffectContainer(String id)
    Constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    hide(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler)
    Hides the container by playing the 'fadeOut' effect.
    boolean
    isCallbackEnabled()
    Indicates whether the callback should be triggered when the effect completes.
    If true, the IEffectListener.onEffectComplete(AjaxRequestTarget) event will be triggered.
    protected JQueryEffectBehavior
    newEffectBehavior(String selector)
    Gets a new JQueryEffectBehavior
    protected void
    onConfigure(JQueryEffectBehavior behavior)
    Called immediately after the onConfigure method in a behavior.
    void
    onEffectComplete(org.apache.wicket.ajax.AjaxRequestTarget target)
    Triggered when the effects is completed
    protected void
    onInitialize()
     
    void
    play(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler, Effect effect)
    Plays the specified effect.
    void
    play(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler, String effect)
    Plays the specified effect.
    void
    show(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler)
    Shows the container by playing the 'fadeIn' effect.

    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, 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, 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, initModel, internalOnModelChanged, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, 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 java.lang.Iterable

    forEach, spliterator

  • Constructor Details

    • JQueryEffectContainer

      public JQueryEffectContainer(String id)
      Constructor
      Parameters:
      id - the markup id

  • Method Details

    • isCallbackEnabled

      public boolean isCallbackEnabled()
      Description copied from interface: IEffectListener
      Indicates whether the callback should be triggered when the effect completes.
      If true, the IEffectListener.onEffectComplete(AjaxRequestTarget) event will be triggered.
      Specified by:
      isCallbackEnabled in interface IEffectListener
      Returns:
      false by default

    • play

      public void play(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler, Effect effect)
      Plays the specified effect.
      Parameters:
      handler - the IPartialPageRequestHandler
      effect - the effect to be played

    • play

      public void play(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler, String effect)
      Plays the specified effect.
      Parameters:
      handler - the IPartialPageRequestHandler
      effect - the effect to be played

    • show

      public void show(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler)
      Shows the container by playing the 'fadeIn' effect.
      Parameters:
      handler - the IPartialPageRequestHandler

    • hide

      public void hide(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler)
      Hides the container by playing the 'fadeOut' effect.
      Parameters:
      handler - the IPartialPageRequestHandler

    • onInitialize

      protected void onInitialize()
      Overrides:
      onInitialize in class org.apache.wicket.MarkupContainer

    • onConfigure

      protected void onConfigure(JQueryEffectBehavior behavior)
      Called immediately after the onConfigure method in a behavior. Since this is before the rendering cycle has begun, the behavior can modify the configuration of the component (i.e. Options)
      Parameters:
      behavior - the JQueryBehavior

    • onEffectComplete

      public void onEffectComplete(org.apache.wicket.ajax.AjaxRequestTarget target)
      Description copied from interface: IEffectListener
      Triggered when the effects is completed
      Specified by:
      onEffectComplete in interface IEffectListener
      Parameters:
      target - the AjaxRequestTarget
      See Also:

    • newEffectBehavior

      protected JQueryEffectBehavior newEffectBehavior(String selector)
      Gets a new JQueryEffectBehavior
      Parameters:
      selector - the html selector (ie: '#myId')
      Returns:
      the widget behavior