org.wicketstuff.jwicket.ui.dragdrop

Class DraggablesAcceptedByDroppable

java.lang.Object

org.wicketstuff.jwicket.ui.dragdrop.DraggablesAcceptedByDroppable

All Implemented Interfaces:

Serializable

public class DraggablesAcceptedByDroppable
extends Object
implements Serializable

If you have a droppable element you sometimes want this droppable only to accept a well defined set of draggable elements to be dropped onto this element. For this reason you can give each draggable a name and tell a dropable the name of all the draggables that you want it to accept. Multiple draggable can share the same name. This class collects all the names of draggable elements for one or more droppable elements

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DRAG_NAME_IDENTIFIER

Constructor Summary

Constructors

Constructor and Description
DraggablesAcceptedByDroppable(String... names) Create a DraggablesAcceptedByDroppable object

Method Summary

Methods

Modifier and Type	Method and Description
void	addName(String name) Add a name to the current names
boolean	equals(Object other)
String	getId() Each collection of names has a unique id.
String	getJsAcceptCheckerFunctionName() A Javascript function is used to check the names of accepted droppables against the name of a certain draggable.
void	removeName(String name) Remove a name.
void	renderJsDropAcceptFunction(org.apache.wicket.markup.head.IHeaderResponse response) Create a JavaScript function that checks the names against the name of the function's argument.
int	size() How many names are currently accepted

Methods inherited from class java.lang.Object

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

Field Detail

DRAG_NAME_IDENTIFIER

public static final String DRAG_NAME_IDENTIFIER

See Also:

Constant Field Values

Constructor Detail

DraggablesAcceptedByDroppable

public DraggablesAcceptedByDroppable(String... names)

Create a DraggablesAcceptedByDroppable object

Parameters:

names - An Array of names of droppable objects. Duplicate names are eliminated null values are ignored.

Method Detail

addName

public void addName(String name)

Add a name to the current names

Parameters:

name - The name of a droppable object. Duplicate types are eliminated null values are ignored.

removeName

public void removeName(String name)

Remove a name.

Parameters:

name - The name to be removed

size

public int size()

How many names are currently accepted

Returns:

The numer of currently accepted names

getId

public String getId()

Each collection of names has a unique id. It is used e.g. to construct a unique JavaScript function name

Returns:

Tne id of this set od names

equals

public boolean equals(Object other)

Overrides:

equals in class Object

getJsAcceptCheckerFunctionName

public String getJsAcceptCheckerFunctionName()

A Javascript function is used to check the names of accepted droppables against the name of a certain draggable.

Returns:

The name of the JavaScript function

renderJsDropAcceptFunction

public void renderJsDropAcceptFunction(org.apache.wicket.markup.head.IHeaderResponse response)

Create a JavaScript function that checks the names against the name of the function's argument. If the name of the function's argument matches on name in the list of names the function returns true. This method renders the JavaScript function for name checking into the page header. The JavaScript function has the form

 var someFunctionName = function(candidate) {
     var accepted = ['droppableA','droppableB'];
     for (var i = 0; i < accepted.length; i++)
         if (accepted[i] == jQuery(candidate).attr('dragClass')
             return true;
     return false;
 }
 

Parameters:

response -