org.richfaces.component
Interface Draggable

public interface Draggable

Interface for all draggable components. Describe bean properties, implemented by component.

Author:

shura

Method Summary

void	addDragListener(DragListener listener) Append drag listener to component listeners collection
java.lang.String	getDragIndicator() Getter for id of component ( instance of UIDragIndicator ) used for create drag cursor.
javax.faces.el.MethodBinding	getDragListener()
DragListener[]	getDragListeners() Get array of all Drop Listeners
java.lang.String	getDragType() Getter for type of this draggable ( file, mail etc ).
java.lang.Object	getDragValue() Getter for value parameter, used as key for draggable component.
java.lang.String	getGrabbingCursors()
java.lang.String	getGrabCursors()
java.lang.String	getOndragend() Getter for JavaScript event handler; Called when drag operation end.
java.lang.String	getOndragstart() Getter for JavaScript event handler, called before start drag operation.
java.lang.String	getOndropout() Getter for JavaScript event handler; Called when dragged element out the dropzone.
java.lang.String	getOndropover() Getter for JavaScript event handler; Called when dragged element over the dropzone.
java.lang.String	getResolvedDragIndicator(javax.faces.context.FacesContext facesContext) Draggable implementation may wish to resolve drag indicator id to clientId itself
void	removeDragListener(DragListener listener) Remove drop listener from component listeners array.
void	setDragIndicator(java.lang.String dragIndicator)
void	setDragListener(javax.faces.el.MethodBinding binding)
void	setDragType(java.lang.String dragType)
void	setDragValue(java.lang.Object value)
void	setGrabbingCursors(java.lang.String grabbingCursors)
void	setGrabCursors(java.lang.String grabCursors)
void	setOndragend(java.lang.String ondrag)
void	setOndragstart(java.lang.String ondrag)
void	setOndropout(java.lang.String ondropout)
void	setOndropover(java.lang.String ondropover)

Method Detail

getDragValue

java.lang.Object getDragValue()

Getter for value parameter, used as key for draggable component.

Returns:

setDragValue

void setDragValue(java.lang.Object value)

getDragIndicator

java.lang.String getDragIndicator()

Getter for id of component ( instance of UIDragIndicator ) used for create drag cursor.

Returns:

setDragIndicator

void setDragIndicator(java.lang.String dragIndicator)

Parameters:

dragIndicator - - id of cursor component

getResolvedDragIndicator

java.lang.String getResolvedDragIndicator(javax.faces.context.FacesContext facesContext)

Draggable implementation may wish to resolve drag indicator id to clientId itself

Parameters:

facesContext - FacesContext instance

Returns:

resolved indicator client id or null

Since:

3.1

getDragType

java.lang.String getDragType()

Getter for type of this draggable ( file, mail etc ).

Returns:

setDragType

void setDragType(java.lang.String dragType)

Parameters:

dragType -

getOndragstart

java.lang.String getOndragstart()

Getter for JavaScript event handler, called before start drag operation. If this handler return false, drag operation is cancelled.

Returns:

javaScript code of event handler.

setOndragstart

void setOndragstart(java.lang.String ondrag)

Parameters:

dragType -

getOndragend

java.lang.String getOndragend()

Getter for JavaScript event handler; Called when drag operation end.

Returns:

javaScript code of event handler.

setOndragend

void setOndragend(java.lang.String ondrag)

getOndropover

java.lang.String getOndropover()

Getter for JavaScript event handler; Called when dragged element over the dropzone.

Returns:

javaScript code of event handler.

setOndropover

void setOndropover(java.lang.String ondropover)

getOndropout

java.lang.String getOndropout()

Getter for JavaScript event handler; Called when dragged element out the dropzone.

Returns:

javaScript code of event handler.

setOndropout

void setOndropout(java.lang.String ondropout)

addDragListener

void addDragListener(DragListener listener)

Append drag listener to component listeners collection

Parameters:

listener -

getDragListeners

DragListener[] getDragListeners()

Get array of all Drop Listeners

Returns:

removeDragListener

void removeDragListener(DragListener listener)

Remove drop listener from component listeners array.

Parameters:

listener -

setDragListener

void setDragListener(javax.faces.el.MethodBinding binding)

getDragListener

javax.faces.el.MethodBinding getDragListener()

getGrabCursors

java.lang.String getGrabCursors()

setGrabCursors

void setGrabCursors(java.lang.String grabCursors)

getGrabbingCursors

java.lang.String getGrabbingCursors()

setGrabbingCursors

void setGrabbingCursors(java.lang.String grabbingCursors)