Package org.wicketstuff.wiquery.core.javascript

Class JsQuery

  • All Implemented Interfaces:
    java.io.Serializable, org.apache.wicket.IComponentAwareEventSink, org.apache.wicket.markup.html.IComponentAwareHeaderContributor, org.apache.wicket.util.io.IClusterable
    public class JsQuery
extends org.apache.wicket.behavior.Behavior
implements java.io.Serializable
    $Id: JsQuery.java 1721M 2012-01-17 17:43:37Z (local) $

    JsQuery is the main entry point of WickeXt's JavaScript integration. This class is used to link JavaScript to a component and to render it.

    This class implements the IHeaderContributor interface, so if you want to append the generated JavaScript, just do this: 

            
 JsQuery jsq = new JsQuery(myComponent);
 jsq.$().chain("css", "border", "1px solid red");
 myComponent.add(new HeaderContributor(jsq));

    If you want to generate a statement concerning a component, do it as below:

    new JsQuery(yourComponent).$().chain("css", "border", "1px solid red"));

    Since:
    0.7
    Author:
    Lionel Armanet
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      JsQuery()
      Creates a new JsQuery.
      JsQuery​(org.apache.wicket.Component component)
      Creates a new JsQuery linked to a Component.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      JsStatement $()  
      JsStatement $​(java.lang.String selector)
      Same as $() but with a specified CSS selector.
      void bind​(org.apache.wicket.Component hostComponent)  
      JsStatement document()  
      JsStatement getStatement()  
      protected void onBind()
      Called when the component was bound to it's host component.
      void renderHead​(org.apache.wicket.Component component, org.apache.wicket.markup.head.IHeaderResponse response)  
      void renderHead​(org.apache.wicket.markup.head.IHeaderResponse response, org.apache.wicket.request.IRequestHandler requestHandler)
      FOR FRAMEWORK'S INTERNAL USE ONLY
      void setStatement​(JsStatement jsStatement)
      FOR FRAMEWORK'S INTERNAL USE ONLY

      • Methods inherited from class org.apache.wicket.behavior.Behavior

        afterRender, beforeRender, canCallListener, detach, getStatelessHint, isEnabled, isTemporary, onAttribute, onComponentTag, onConfigure, onEvent, onException, onRemove, onTag, unbind

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • JsQuery

        public JsQuery​(org.apache.wicket.Component component)
        Creates a new JsQuery linked to a Component.

      • JsQuery

        public JsQuery()
        Creates a new JsQuery.

    • Method Detail

      • $

        public JsStatement $​(java.lang.String selector)
        Same as $() but with a specified CSS selector. If this JsQuery is linked to a component, the resulting JavaScript code will be

        $("#yourComponentId cssSelector")

        Parameters:
        selector -

      • document

        public JsStatement document()
        Returns:
        a new JsStatement initialized with the document statement.

      • renderHead

        public void renderHead​(org.apache.wicket.Component component,
                       org.apache.wicket.markup.head.IHeaderResponse response)
        Specified by:
        renderHead in interface org.apache.wicket.markup.html.IComponentAwareHeaderContributor
        Overrides:
        renderHead in class org.apache.wicket.behavior.Behavior

      • bind

        public final void bind​(org.apache.wicket.Component hostComponent)
        Overrides:
        bind in class org.apache.wicket.behavior.Behavior

      • onBind

        protected void onBind()
        Called when the component was bound to it's host component. You can get the bound host component by calling getComponent.

      • getStatement

        public JsStatement getStatement()
        Returns:
        the statement

      • setStatement

        public void setStatement​(JsStatement jsStatement)
        FOR FRAMEWORK'S INTERNAL USE ONLY

      • renderHead

        public void renderHead​(org.apache.wicket.markup.head.IHeaderResponse response,
                       org.apache.wicket.request.IRequestHandler requestHandler)
        FOR FRAMEWORK'S INTERNAL USE ONLY