Primefaces drag and drop

This is an excerpt from Packt Publishing Primefaces cookbook. In these recipes we will show how to use Drag & Drop in your JSF applications.

Drag & Drop with PrimeFaces

Drag-and-drop is an action, meaning grabbing an object and dragging it to a different location. Components capable of being dragged and dropped enrich the Web and make a solid base for modern UI patterns. The drag-and-drop utilities in PrimeFaces allow us to create draggable and droppable user interfaces effi ciently. They make it abstract for developers to deal with the implementation details on a browser level.

In this chapter, we will learn about PrimeFaces' drag-and-drop utilities: Draggable and Droppable. AJAX-enhanced drag-and-drop and a special integration with data iteration components will be explained as well.

A component can be made draggable by using p:draggable. The component ID must match the for attribute of the p:draggable component. If the for attribute is omitted, the parent component will be selected as a draggable target. Let's make some panel components draggable and apply some basic features:

    <p:panel id="pnl" header="Draggable panel with default settings">
            <h:outputText value="Drag me around" />
        <p:draggable for="pnl" />
        <p:panel id="hpnl" header="Draggable panel by handle">
            <h:outputText value="I can be only dragged by my header" />
        <p:draggable for="hpnl" handle=".ui-panel-titlebar" />
        <p:panel id="cpnl" header="Draggable panel with clone">
                value="I display a clone as helper while being dragged" />
        <p:draggable for="cpnl" helper="clone" />
        <p:panel id="rpnl" header="Draggable panel with revert">
                value="I will be returned to my start position when dragging stops" />
        <p:draggable for="rpnl" revert="true" />
        <p:panel id="opnl" header="Draggable panel with opacity">
            <h:outputText value="I use opacity for helper while being dragged" />
        <p:draggable for="opnl" opacity="0.5" />
The following screenshot shows the five panels. The last panel is being dragged. Its opacity has been changed to 0.5 after dragging starts.

jsf drag and drop

How it works

By default, any point in a dragged component can be used as a handle. To restrict the drag-start click to a specified element(s), we can use the handle option, which is a jQuery selector. The second panel is dragged by using its header only.
By default, the actual component is used as a drag indicator. The helper option allows keeping the component at its original location during dragging. This can be achieved with helper set to clone as for the third panel.
If the revert option is set to true, the component will return to its starting position when dragging stops and the draggable component is not dropped onto a matching droppable component. The fourth panel features this behavior.
Opacity for helper while it is being dragged is another useful option to give the user a visual feedback. The opacity of the fifth panel is reduced when dragging.

Defining droppable targets

Any component can be enhanced with a droppable behaviour. Droppable components are targets for draggable ones. To enable droppable functionality on any PrimeFaces component, we always need a component called Droppable. In this recipe, we will see how to defi ne droppable targets and learn a client-side callback onDrop.

How to do it

A component can be made droppable by using p:droppable. The component ID must match the for attribute of p:droppable. If the for attribute is omitted, the parent component will be selected as a droppable target. We will take two h:panelGroup components and make them droppable and draggable respectively. In addition, we will define a client-side callback that gets invoked when a draggable component is dropped. This can be accomplished by the onDrop attribute, which points to a JavaScript function.

    <h:panelGroup id="drop" layout="block" styleClass="ui-widget-content"
        <p class="ui-widget-header" style="margin: 0; padding: 5px;">Drop
        <p:droppable onDrop="handleDrop" />
    <br />
    <h:panelGroup id="drag" layout="block"
        <p>Drag me to my target</p>
    <p:draggable for="drag" />
The client-side callback highlights the droppable h:panelGroup component and adds the text Dropped! to the paragraph tag p when invoked.
function handleDrop(event, ui) {


jsf drag and drop tutorial


jsf drag and drop tutorial

How it works

The onDrop callback gets two parameters: event and ui, which are objects holding information about the drag-and-drop event. The droppable target is accessible by event.We use this fact to add the style class ui-state-highlight to the target. This class is defined by jQuery ThemeRoller. The event parameter is the original browser event, and ui is a prepared object with the following properties:
  • ui.draggable: This is the current draggable element,an jQuery object
  • ui.helper: This is the current draggable helper,an jQuery object
  • ui.position: This is the current position of the draggable helper { top: , left: }
  • ui.offset: This is the current absolute position of the draggable helper { top: , left: }

primefaces drag and dropRead more about it on PrimeFaces Cookbook.

  • Learn basic concepts to be able to work with PrimeFaces.
  • Delve deep into 100+ rich UI components with all the required details
  • Get solutions to typical and advanced use cases
  • Use the best practices, avoid pitfalls, and get performance tips when working with the component suite
  • Gain know-how of writing custom components on basis of the PrimeFaces' core functionality
  • Meet additional components from the PrimeFaces Extensions


Follow us on Twitter