net.dontdrinkandroot.wicket.javascript.JQueryScript Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of wicket.core Show documentation
Show all versions of wicket.core Show documentation
Apache Wicket core extensions
The newest version!
/*
* Copyright (C) 2012-2017 Philip Washington Sorst
* and individual contributors as indicated
* by the @authors tag.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.dontdrinkandroot.wicket.javascript;
import org.apache.wicket.Component;
import org.apache.wicket.util.time.Duration;
import java.util.Iterator;
import java.util.Map.Entry;
import java.util.Properties;
/**
* Utilities to programmatically assemble simple JQuery Scripts.
*
* @author Philip Washington Sorst
*/
public class JQueryScript implements CharSequence
{
public static Duration DEFAULT_ANIMATION_DURATION = Duration.milliseconds(400);
public static EasingFunction DEFAULT_EASING_FUNCTION = JQueryEasingFunction.SWING;
public static String TEMPLATE_ANIMATE = ".animate(%s, %d, '%s', function() {%s})";
public static String TEMPLATE_CHILDREN = ".children(%s)";
public static String TEMPLATE_HIDE = ".hide(%d, '%s', function() {%s})";
public static String TEMPLATE_SHOW = ".show(%d, '%s', function() {%s})";
public static String TEMPLATE_FADEIN = ".fadeIn(%d, '%s', function() {%s})";
public static String TEMPLATE_FADETOGGLE = ".fadeToggle(%d, '%s', function() {%s})";
public static String TEMPLATE_FADEOUT = ".fadeOut(%d, '%s', function() {%s})";
public static String TEMPLATE_TOGGLE = ".toggle(%d, '%s', function() {%s})";
public static String TEMPLATE_SLIDEDOWN = ".slideDown(%d, '%s', function() {%s})";
public static String TEMPLATE_SLIDEUP = ".slideUp(%d, '%s', function() {%s})";
public static String TEMPLATE_SLIDETOGGLE = ".slideToggle(%d, '%s', function() {%s})";
public static String TEMPLATE_KEYPRESS = ".keypress(function(event) {%s})";
public static String TEMPLATE_CLICK = ".click(function(event) {%s})";
protected final StringBuffer scriptBuffer;
/**
* Create a new JQuery Script using this as a selector.
*/
public JQueryScript()
{
this.scriptBuffer = new StringBuffer("jQuery(this)");
}
/**
* Create a new JQuery Script using the components markupid as a selector.
*
* @param component The component to be selected.
*/
public JQueryScript(final Component component)
{
this("#" + component.getMarkupId());
component.setOutputMarkupId(true);
}
/**
* Create a new JQuery Script using the given selector.
*
* @param selector The selector to use.
*/
public JQueryScript(final String selector)
{
this.scriptBuffer = new StringBuffer(String.format("jQuery('%s')", selector));
}
@Override
public String toString()
{
return this.scriptBuffer.toString();
}
@Override
public char charAt(int position)
{
return this.scriptBuffer.charAt(position);
}
@Override
public int length()
{
return this.scriptBuffer.length();
}
@Override
public CharSequence subSequence(int start, int end)
{
return this.scriptBuffer.subSequence(start, end);
}
/**
* Perform a custom animation of a set of CSS properties.
*
* @param properties A map of CSS properties that the animation will move toward.
* @return This script for chaining.
*/
public JQueryScript animate(final Properties properties)
{
return this.animate(properties, null, null, null);
}
/**
* Perform a custom animation of a set of CSS properties.
*
* @param properties A map of CSS properties that the animation will move toward.
* @param duration A number determining how long the animation will run (in milliseconds), defaults to 400.
* @param easingFunction A string indicating which easing function to use for the transition, defaults to "swing".
* @param callbackScript A script to call once the animation is complete, defaults to an empty script.
* @return This script for chaining.
*/
public JQueryScript animate(
final Properties properties,
final Duration duration,
final EasingFunction easingFunction,
final CharSequence callbackScript
)
{
this.scriptBuffer.append(
String.format(
JQueryScript.TEMPLATE_ANIMATE,
this.parseProperties(properties),
this.parseDurationWithDefault(duration),
this.parseEasingFunctionWithDefault(easingFunction),
this.parseScriptWithDefault(callbackScript)
));
return this;
}
/**
* Triggers the focus event on the selected element.
*
* @return This script for chaining.
*/
public JQueryScript focus()
{
this.scriptBuffer.append(".focus()");
return this;
}
/**
* Get the children of each element in the set of matched elements, optionally filtered by a selector.
*
* @param selector The selector to use.
* @return This script for chaining.
*/
public JQueryScript children(final String selector)
{
this.scriptBuffer.append(String.format(JQueryScript.TEMPLATE_CHILDREN, this.nullSafeEscapedString(selector)));
return this;
}
/**
* Display the matched elements by fading them to opaque.
*
* @return This script for chaining.
*/
public JQueryScript fadeIn()
{
this.scriptBuffer.append(".fadeIn()");
return this;
}
/**
* Display the matched elements by fading them to opaque.
*
* @param duration A number determining how long the animation will run (in milliseconds), defaults to 400.
* @param easingFunction A string indicating which easing function to use for the transition, defaults to "swing".
* @param callbackScript A script to call once the animation is complete, defaults to an empty script.
* @return This script for chaining.
*/
public JQueryScript fadeIn(
final Duration duration,
final EasingFunction easingFunction,
final CharSequence callbackScript
)
{
this.scriptBuffer.append(
String.format(
JQueryScript.TEMPLATE_FADEIN,
this.parseDurationWithDefault(duration),
this.parseEasingFunctionWithDefault(easingFunction),
this.parseScriptWithDefault(callbackScript)
));
return this;
}
/**
* Hide the matched elements by fading them to transparent.
*
* @return This script for chaining.
*/
public JQueryScript fadeOut()
{
this.scriptBuffer.append(".fadeOut()");
return this;
}
/**
* Hide the matched elements by fading them to transparent.
*
* @param duration A number determining how long the animation will run (in milliseconds), defaults to 400.
* @param easingFunction A string indicating which easing function to use for the transition, defaults to "swing".
* @param callbackScript A script to call once the animation is complete, defaults to an empty script.
* @return This script for chaining.
*/
public JQueryScript fadeOut(
final Duration duration,
final EasingFunction easingFunction,
final String callbackScript
)
{
this.scriptBuffer.append(
String.format(
JQueryScript.TEMPLATE_FADEOUT,
this.parseDurationWithDefault(duration),
this.parseEasingFunctionWithDefault(easingFunction),
this.parseScriptWithDefault(callbackScript)
));
return this;
}
/**
* Display or hide the matched elements by animating their opacity.
*
* @return This script for chaining.
*/
public JQueryScript fadeToggle()
{
this.scriptBuffer.append(".fadeToggle()");
return this;
}
/**
* Display or hide the matched elements by animating their opacity.
*
* @param duration A number determining how long the animation will run (in milliseconds), defaults to 400.
* @param easingFunction A string indicating which easing function to use for the transition, defaults to "swing".
* @param callbackScript A script to call once the animation is complete, defaults to an empty script.
* @return This script for chaining.
*/
public JQueryScript fadeToggle(
final Duration duration,
final EasingFunction easingFunction,
final String callbackScript
)
{
this.scriptBuffer.append(
String.format(
JQueryScript.TEMPLATE_FADETOGGLE,
this.parseDurationWithDefault(duration),
this.parseEasingFunctionWithDefault(easingFunction),
this.parseScriptWithDefault(callbackScript)
));
return this;
}
/**
* Hide the matched elements.
*
* @return This script for chaining.
*/
public JQueryScript hide()
{
this.scriptBuffer.append(".hide()");
return this;
}
/**
* Hide the matched elements.
*
* @param duration A number determining how long the animation will run (in milliseconds), defaults to 0 (hiding
* immediately).
* @param easingFunction A string indicating which easing function to use for the transition, defaults to "swing".
* @param callbackScript A script to call once the animation is complete, defaults to an empty script.
* @return This script for chaining.
*/
public JQueryScript hide(final Duration duration, final EasingFunction easingFunction, final String callbackScript)
{
this.scriptBuffer
.append(String.format(
JQueryScript.TEMPLATE_HIDE,
this.parseDurationWithDefault(duration, Duration.NONE),
this.parseEasingFunctionWithDefault(easingFunction),
this.parseScriptWithDefault(callbackScript)
));
return this;
}
public JQueryScript click(String callbackScript)
{
this.scriptBuffer.append(String.format(
JQueryScript.TEMPLATE_CLICK,
this.parseScriptWithDefault(callbackScript)
));
return this;
}
/**
* Display the matched elements.
*
* @return This script for chaining.
*/
public JQueryScript show()
{
this.scriptBuffer.append(".show()");
return this;
}
/**
* Display the matched elements.
*
* @param duration A number determining how long the animation will run (in milliseconds), defaults to 0 (showing
* immediately).
* @param easingFunction A string indicating which easing function to use for the transition, defaults to "swing".
* @param callbackScript A script to call once the animation is complete, defaults to an empty script.
* @return This script for chaining.
*/
public JQueryScript show(final Duration duration, final EasingFunction easingFunction, final String callbackScript)
{
this.scriptBuffer
.append(String.format(
JQueryScript.TEMPLATE_SHOW,
this.parseDurationWithDefault(duration, Duration.NONE),
this.parseEasingFunctionWithDefault(easingFunction),
this.parseScriptWithDefault(callbackScript)
));
return this;
}
/**
* Display the matched elements with a sliding motion.
*
* @return This script for chaining.
*/
public JQueryScript slideDown()
{
this.scriptBuffer.append(".slideDown()");
return this;
}
/**
* Display the matched elements with a sliding motion.
*
* @param duration A number determining how long the animation will run (in milliseconds), defaults to 400.
* @param easingFunction A string indicating which easing function to use for the transition, defaults to "swing".
* @param callbackScript A script to call once the animation is complete, defaults to an empty script.
* @return This script for chaining.
*/
public JQueryScript slideDown(
final Duration duration,
final EasingFunction easingFunction,
final String callbackScript
)
{
this.scriptBuffer.append(
String.format(
JQueryScript.TEMPLATE_SLIDEDOWN,
this.parseDurationWithDefault(duration),
this.parseEasingFunctionWithDefault(easingFunction),
this.parseScriptWithDefault(callbackScript)
));
return this;
}
/**
* Hide the matched elements with a sliding motion.
*
* @return This script for chaining.
*/
public JQueryScript slideUp()
{
this.scriptBuffer.append(".slideUp()");
return this;
}
/**
* Hide the matched elements with a sliding motion.
*
* @param duration A number determining how long the animation will run (in milliseconds), defaults to 400.
* @param easingFunction A string indicating which easing function to use for the transition, defaults to "swing".
* @param callbackScript A script to call once the animation is complete, defaults to an empty script.
* @return This script for chaining.
*/
public JQueryScript slideUp(
final Duration duration,
final EasingFunction easingFunction,
final String callbackScript
)
{
this.scriptBuffer.append(
String.format(
JQueryScript.TEMPLATE_SLIDEUP,
this.parseDurationWithDefault(duration),
this.parseEasingFunctionWithDefault(easingFunction),
this.parseScriptWithDefault(callbackScript)
));
return this;
}
/**
* Display or hide the matched elements with a sliding motion.
*
* @return This script for chaining.
*/
public JQueryScript slideToggle()
{
this.scriptBuffer.append(".slideToggle()");
return this;
}
/**
* Display or hide the matched elements with a sliding motion.
*
* @param duration A number determining how long the animation will run (in milliseconds), defaults to 400.
* @param easingFunction A string indicating which easing function to use for the transition, defaults to "swing".
* @param callbackScript A script to call once the animation is complete, defaults to an empty script.
* @return This script for chaining.
*/
public JQueryScript slideToggle(
final Duration duration,
final EasingFunction easingFunction,
final String callbackScript
)
{
this.scriptBuffer.append(
String.format(
JQueryScript.TEMPLATE_SLIDETOGGLE,
this.parseDurationWithDefault(duration),
this.parseEasingFunctionWithDefault(easingFunction),
this.parseScriptWithDefault(callbackScript)
));
return this;
}
/**
* Display or hide the matched elements.
*
* @return This script for chaining.
*/
public JQueryScript toggle()
{
this.scriptBuffer.append(".toggle()");
return this;
}
/**
* Display or hide the matched elements.
*
* @param duration A number determining how long the animation will run (in milliseconds), defaults to 0 (toggling
* immediately).
* @param easingFunction A string indicating which easing function to use for the transition, defaults to "swing".
* @param callbackScript A script to call once the animation is complete, defaults to an empty script.
* @return This script for chaining.
*/
public JQueryScript toggle(
final Duration duration,
final EasingFunction easingFunction,
final String callbackScript
)
{
this.scriptBuffer.append(
String.format(
JQueryScript.TEMPLATE_TOGGLE,
this.parseDurationWithDefault(duration, Duration.NONE),
this.parseEasingFunctionWithDefault(easingFunction),
this.parseScriptWithDefault(callbackScript)
));
return this;
}
private long parseDurationWithDefault(final Duration duration)
{
return this.parseDurationWithDefault(duration, JQueryScript.DEFAULT_ANIMATION_DURATION);
}
private long parseDurationWithDefault(Duration duration, Duration defaultValue)
{
if (null != duration) {
return duration.getMilliseconds();
}
return defaultValue.getMilliseconds();
}
private String parseEasingFunctionWithDefault(final EasingFunction easingFunction)
{
if (null != easingFunction) {
return easingFunction.getName();
}
return JQueryScript.DEFAULT_EASING_FUNCTION.getName();
}
private CharSequence parseScriptWithDefault(final CharSequence callbackScript)
{
if (callbackScript == null) {
return "";
}
return callbackScript;
}
private CharSequence parseProperties(final Properties properties)
{
final StringBuffer sb = new StringBuffer("{");
if (properties != null) {
final Iterator> propIt = properties.entrySet().iterator();
while (propIt.hasNext()) {
final Entry propertyEntry = propIt.next();
sb
.append("'")
.append(propertyEntry.getKey())
.append("'")
.append(": ")
.append("'")
.append(propertyEntry.getValue())
.append("'");
if (propIt.hasNext()) {
sb.append(", ");
}
}
}
sb.append("}");
return sb;
}
private String nullSafeEscapedString(final String s)
{
if (null == s) {
return "";
}
return "'" + s + "'";
}
public JQueryScript siblings(final String selector)
{
this.scriptBuffer.append(".siblings(" + this.nullSafeEscapedString(selector) + ")");
return this;
}
public JQueryScript removeClass(final String string)
{
this.scriptBuffer.append(".removeClass('" + string + "')");
return this;
}
public JQueryScript addClass(final String string)
{
this.scriptBuffer.append(".addClass('" + string + "')");
return this;
}
public JQueryScript append(String script)
{
this.scriptBuffer.append(script);
return this;
}
}