de.alpharogroup.wicket.js.addon.iscroll.IscrollSettings Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wicket-iscroll Show documentation
There is a newer version: 7.8.0
/**
 * The MIT License
 *
 * Copyright (C) 2015 Asterios Raptis
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
package de.alpharogroup.wicket.js.addon.iscroll;

import java.util.HashSet;
import java.util.Set;

import de.alpharogroup.wicket.js.addon.core.Settings;
import de.alpharogroup.wicket.js.addon.core.StringTextType;
import de.alpharogroup.wicket.js.addon.core.StringTextValue;
import lombok.AccessLevel;
import lombok.Builder;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.ToString;


/**
 * This class encapsulates various settings for the spin js library. See the documentation for the
 * spin js library for further information.
 */
@Getter
@EqualsAndHashCode
@ToString
@NoArgsConstructor(access = AccessLevel.PRIVATE)
@Builder
public class IscrollSettings implements Settings
{

	/**
	 * The serialVersionUID
	 */
	private static final long serialVersionUID = 1L;

	/**
	 * By default the engine uses the transform CSS property. Setting this to false scrolls like we
	 * were in 2007, ie: using the top/left (and thus the scroller needs to be absolutely
	 * positioned).
	 *
	 * This might be useful when scrolling sensitive content such as Flash, iframes and videos, but
	 * be warned: performance loss is huge. 

	 * Default: true
	 */
	private final StringTextValue useTransform = new StringTextValue<>("useTransform",
		true, StringTextType.BOOLEAN);

	/**
	 * iScroll uses CSS transition to perform animations (momentum and bounce). By setting this to
	 * false, requestAnimationFrame is used instead.
	 *
	 * On modern browsers the difference is barely noticeable. On older devices transitions perform
	 * better.
	 *
	 * 

	 * Default: true
	 */
	private final StringTextValue useTransition = new StringTextValue<>("useTransition",
		true, StringTextType.BOOLEAN);

	/**
	 * This option tries to put the scroller on the hardware layer by appending translateZ(0) to the
	 * transform CSS property. This greatly increases performance especially on mobile, but there
	 * are situations where you might want to disable it (notably if you have too many elements and
	 * the hardware can't catch up).
	 *
	 * If unsure leave iScroll decide what's the optimal config. For best performance all the above
	 * options should be set to true (or better leave them undefined as they are set to true
	 * automatically). You may try to play with them in case you encounter hiccups and memory leaks.
	 * 

	 * Default: true
	 */
	private final StringTextValue HWCompositing = new StringTextValue<>("HWCompositing",
		true, StringTextType.BOOLEAN);

	/**
	 * When the scroller meets the boundary it performs a small bounce animation. Disabling bounce
	 * may help reach smoother results on old or slow devices.
	 *
	 * 

	 * Default: true
	 */
	private final StringTextValue bounce = new StringTextValue<>("bounce", true,
		StringTextType.BOOLEAN);

	/**
	 * To override the native scrolling iScroll has to inhibit some default browser behaviors, such
	 * as mouse clicks. If you want your application to respond to the click event you have to
	 * explicitly set this option to true. Please note that it is suggested to use the custom tap
	 * event instead (see below).
	 *
	 * 

	 * Default: false
	 */
	private final StringTextValue click = new StringTextValue<>("click",
		StringTextType.BOOLEAN);

	/**
	 * By default iScroll listens to all pointer events and reacts to the first one that occurs. It
	 * may seem a waste of resources but feature detection has proven quite unreliable and this
	 * listen-to-all approach is our safest bet for wide browser/device compatibility.
	 *
	 * If you have an internal mechanism for device detection or you know in advance where your
	 * script will run on, you may want to disable all event sets you don't need (mouse, pointer or
	 * touch events).
	 *
	 * 

	 * Default: false
	 */
	private final StringTextValue disableMouse = new StringTextValue<>("disableMouse",
		StringTextType.BOOLEAN);

	/**
	 * By default iScroll listens to all pointer events and reacts to the first one that occurs. It
	 * may seem a waste of resources but feature detection has proven quite unreliable and this
	 * listen-to-all approach is our safest bet for wide browser/device compatibility.
	 *
	 * If you have an internal mechanism for device detection or you know in advance where your
	 * script will run on, you may want to disable all event sets you don't need (mouse, pointer or
	 * touch events).
	 *
	 * 

	 * Default: false
	 */
	private final StringTextValue disablePointer = new StringTextValue<>("disablePointer",
		StringTextType.BOOLEAN);

	/**
	 * By default iScroll listens to all pointer events and reacts to the first one that occurs. It
	 * may seem a waste of resources but feature detection has proven quite unreliable and this
	 * listen-to-all approach is our safest bet for wide browser/device compatibility.
	 *
	 * If you have an internal mechanism for device detection or you know in advance where your
	 * script will run on, you may want to disable all event sets you don't need (mouse, pointer or
	 * touch events).
	 *
	 * 

	 * Default: false
	 */
	private final StringTextValue disableTouch = new StringTextValue<>("disableTouch",
		StringTextType.BOOLEAN);

	/**
	 * Listen to the mouse wheel event.
	 *
	 * 

	 * Default: false
	 */
	private final StringTextValue mouseWheel = new StringTextValue<>("mouseWheel",
		StringTextType.BOOLEAN);

	/**
	 * {@inheritDoc}
	 */
	@Override
	public Set> asSet()
	{
		final Set> allSettings = new HashSet<>();
		allSettings.add(getUseTransform());
		allSettings.add(getUseTransition());
		allSettings.add(getHWCompositing());
		allSettings.add(getBounce());
		allSettings.add(getClick());
		allSettings.add(getDisableMouse());
		allSettings.add(getDisablePointer());
		allSettings.add(getDisableTouch());
		allSettings.add(getMouseWheel());
		return allSettings;
	}

}