Primefaces CommandLink

Filed Under: JSF

Today we will look into Primefaces CommandLink component. Primefaces CommandLink extends standard JSF commandLink with Ajax capabilities.

Primefaces CommandLink

Below table contains some of the basic information of Primefaces CommandLink component.

Tag commandLink
Component Class org.primefaces.component.commandlink.CommandLink
Component Type org.primefaces.component.CommandLink
Component Family org.primefaces.component
Renderer Type org.primefaces.component.CommandLinkRenderer
Renderer Class org.primefaces.component. commandlink.CommandLinkRenderer

Primefaces CommandLink Attributes

Name Default Type Description
id null String Unique identifier of the component
rendered true Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.
binding null Object An el expression that maps to a server side UIComponent instance in a backing bean
value null String Href value of the rendered anchor.
action null MethodExpr/ String A method expression or a String outcome that’d be processed when link is clicked.
actionListener null MethodExpr An actionlistener that’d be processed when link is clicked.
immediate false Boolean Boolean value that determines the phaseId, when true actions are processed at apply_request_values, when false at invoke_application phase.
async false Boolean When set to true, ajax requests are not queued.
process null String Component(s) to process partially instead of whole view.
ajax true Boolean Specifies the submit mode, when set to true(default), submit would be made with Ajax.
update null String Component(s) to be updated with ajax.
onstart null String Client side callback to execute before ajax request is begins.
oncomplete null String Client side callback to execute when ajax request is completed.
onsuccess null String Client side callback to execute when ajax request succeeds.
onerror null String Client side callback to execute when ajax request fails.
global true Boolean Defines whether to trigger ajaxStatus or not.
delay null String If less than delay milliseconds elapses between calls to request() only the most recent one is sent and all other requests are discarded. If this option is not specified, or if the value of delay is the literal string ‘none’ without the quotes, no delay is used.
partialSubmit false Boolean Enables serialization of values belonging to the partially processed components only.
resetValues false Boolean If true, local values of input components to be updated within the ajax request would be reset.
ignoreAutoUpdate false Boolean If true, components which autoUpdate=”true” will not be updated for this request. If not specified, or the value is false, no such indication is made.
style null String Style to be applied on the anchor element
styleClass null String StyleClass to be applied on the anchor element
onblur null String Client side callback to execute when link loses focus.
onclick null String Client side callback to execute when link is clicked.
ondblclick null String Client side callback to execute when link is double clicked.
onfocus null String Client side callback to execute when link receives focus.
onkeydown null String Client side callback to execute when a key is pressed down over link.
onkeypress null String Client side callback to execute when a key is pressed and released over link.
onkeyup null String Client side callback to execute when a key is released over link.
onmousedown null String Client side callback to execute when a pointer button is pressed down over link.
onmousemove null String Client side callback to execute when a pointer button is moved within link.
onmouseout null String Client side callback to execute when a pointer button is moved away from link.
onmouseover null String Client side callback to execute when a pointer button is moved onto link.
onmouseup null String Client side callback to execute when a pointer button is released over link.
accesskey null String Access key that when pressed transfers focus to the link.
charset null String Character encoding of the resource designated by this hyperlink.
coords null String Position and shape of the hot spot on the screen for client use in image maps.
dir null String Direction indication for text that does not inherit directionality. Valid values are LTR and RTL.
disabled null Boolean Disables the link
hreflang null String Languae code of the resource designated by the link.
rel null String Relationship from the current document to the anchor specified by the link, values are provided by a space-separated list of link types.
rev null String A reverse link from the anchor specified by this link to the current document, values are provided by a space-separated list of link types.
shape null String Shape of hot spot on the screen, valid values are default, rect, circle and poly.
tabindex null Integer Position of the button element in the tabbing order.
target null String Name of a frame where the resource targeted by this link will be displayed.
title null String Advisory tooltip information.
type null String Type of resource referenced by the link.

Primefaces CommandLink Example

Primefaces CommandLink is similar to JSF h:commandLink except that the form is submitted with ajax by default.

simpleCommandLink.xhtml


<html xmlns="http://www.w3.org/1999/xhtml"
	xmlns:ui="http://java.sun.com/jsf/facelets"
	xmlns:h="http://java.sun.com/jsf/html"
	xmlns:f="http://java.sun.com/jsf/core"
	xmlns:p="http://primefaces.org/ui">
<h:head>
	<script name="jquery/jquery.js" library="primefaces"></script>
</h:head>
<h:form>
	<p:commandLink value="Do Action" action="#{commandLinkManagedBean.doSomeAction}"></p:commandLink>
</h:form>
</html>

package com.journaldev.primefaces.beans;

import javax.faces.bean.ManagedBean;
import javax.faces.bean.SessionScoped;

@ManagedBean
@SessionScoped
public class CommandLinkManagedBean {
	public String doSomeAction(){
		System.out.println("CommandLink is used");
		return "";
	}
}

Below image shows the console output when you click on the Primefaces CommandLink link multiple times.

Primefaces CommandLink - Simple CommandLink

That’s all for a quick roundup on Primefaces CommandLink component. You can download the Primefaces CommandLink example project from below link.

Comments

  1. Denis Duval says:

    Hello,
    I’m using Primefaces in a web project.
    If I use p: commandLink (with ajax = false) or h: commandLink to display a next page,
    a blank page appears quickly, and then displays correctly.
    How to remove this blank page ?
    Is there a solution ?
    THANK YOU!

  2. sudhir kumar says:

    Good work

Leave a Reply

Your email address will not be published. Required fields are marked *

close
Generic selectors
Exact matches only
Search in title
Search in content
Search in posts
Search in pages