com.googlecode.wicket.jquery.ui.interaction.draggable.AbstractDraggableFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wicket-jquery-ui Show documentation

Wicket-jQuery UI

There is a newer version: 10.0.0-M1

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 com.googlecode.wicket.jquery.ui.interaction.draggable;

import org.apache.wicket.util.io.IClusterable;

import com.googlecode.wicket.jquery.ui.interaction.selectable.SelectableDraggableFactory;

/**
 * Provides the ability to create a {@link Draggable} that is related to another component (defined by its selector).

 * 

 * The common use case is to have the ability to drag multiple {@link Draggable} object.

 * To achieve this, the role of the jQuery helper is important (see {@link #getHelper(String)} implementation in {@link SelectableDraggableFactory})

 *
 * @author Sebastien Briquet - sebfz1
 *
 */
public abstract class AbstractDraggableFactory implements IClusterable
{
	private static final long serialVersionUID = 1L;

	/**
	 * Gets the helper that might be used by the {@link Draggable}.

	 * The returned value is supplied to the {@link #create(String, String, String)} method.
	 * @param selector the selector
	 * @return the helper
	 */
	protected abstract String getHelper(String selector);

	/**
	 * Creates the new {@link Draggable} for the given selector
	 * @param id the markup id
	 * @param selector the related component's selector
	 * @return the {@link Draggable} object
	 */
	public final Draggable create(String id, String selector)
	{
		return this.create(id, selector, this.getHelper(selector));
	}

	/**
	 * Creates the new {@link Draggable} by using the selector and/or the helper.

	 * 

	 * A typical implementation is:

	 * 
	 * return new Draggable<String>(id) {
	 *
	 * 	protected void onConfigure(JQueryBehavior behavior)
	 * 	{
	 * 		super.onConfigure(behavior);
	 *
	 * 		behavior.setOption("helper", helper);
	 * 	}
	 * };
	 * 
	 *
	 * @param id the markup id
	 * @param selector the related component's selector
	 * @param helper the jQuery helper
	 *
	 * @return the {@link Draggable} object
	 */
	protected abstract Draggable create(String id, String selector, final String helper);
}