Enables a user to drag a user interface control.
If the move property is set to true, and if the target control is successfully dragged and dropped, and the target's Handle Drop behavior sets the CAF.Draggable.current.result flag to move, the target control's HTML content is removed from the current page. Otherwise, dragging and dropping has no effect on the target control.
The Allow Drag handler is invoked every time a user tries to drag the control with the Custom Drag behavior. The handler is passed two arguments, draggable and event. The draggable argument is the target control's CAF.Draggable object. The event argument is the browser mouse event that precipitates the drag. The handler should return true if the target control is draggable and false if control is not draggable.
| Info | Value |
|---|---|
| Component Type | com.webmethods.caf.faces.behavior.CustomDrag |
| Handler Class | None |
| Renderer Type | com.webmethods.caf.faces.behavior.CustomDrag |
| Description | Allows user to drag a control |
| Palette Location | CAF Html/Control/Behaviors/Custom Drag |
| Name | Required | Type | Description |
|---|---|---|---|
allowDrag | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Custom JavaScript allowDrag event handler |
cursor | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| CSS cursor property to use for drag target (ex "move") |
for | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| ID of control to which to apply this behavior |
id | false | java.lang.String | Control identifier |
move | false | javax.el.ValueExpression
(must evaluate to boolean)
|
True to remove original drag target after successful drop
If not specified, the default value is "false". |
propagateEvent | false | javax.el.ValueExpression
(must evaluate to boolean)
|
True to allow drag-start mouse click event to propagate
If not specified, the default value is "false". |
rendered | false | javax.el.ValueExpression
(must evaluate to boolean)
|
True to render control; false to ignore it
If not specified, the default value is "true". |
Output generated by Vdldoc View Declaration Language Documentation Generator.