LiferayFaces

As an abbreviation for the word "internationalization", the i18n EL variable enables page authors to declaratively specify message keys that are provided by one of the following:

The Liferay Language Utility is typically accessed by portlet developers by calling static Java methods found in the LanguageUtil class. The utility operates by reading the locale-specific version of the portal's Language.properties file, which contains thousands of keys and internationalized messages.

Portlet developers can extend the Liferay Language Utility by creating a file within the portlet WAR named WEB-INF/liferay-hook.xml that points to locale-specific resource bundles that are in the runtime classpath of the portlet.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE hook PUBLIC "-//Liferay//DTD Hook 6.0.0//EN" "http://www.liferay.com/dtd/liferay-hook_6_0_0.dtd">
<hook>
	<language-properties>Language_en_US.properties</language-properties>
</hook>

add-new-entry=Add New Entry
save-entry=Save Entry 

<h:outputLabel value="#{i18n['first-name']}" />

When using JBoss EL, page authors can take advantage of the i18n.replace() method in order to substitute values into the text of the message.

<!--
Note: The US English translation of the x-has-x-friends key would look like the following:
x-has-x-friends={0} has {1} friends.
-->
<h:outputText value="#{i18n.replace('x-has-x-friends', liferay.groupUser.fullName, friendsModel.dataModel.rowCount)}" />

This is a utility managed-bean that is designed to be kept in request scope. Its purpose is to introduce some Liferay-specific variables into the JSF EL. The reason why this is implemented as a managed-bean (and not as an ELResolver) is because it needs to kept in JSF 2 ViewScope.

The Liferay companyId primary key value associated with the community/organization portal page that the current portlet is placed upon.

<h:outputText value="#{liferay.companyId} is the companyId associated with this set of Liferay Portal pages." />

The absolute URL for the Liferay Document Library Struts action path prefix. The most common use case is to append the /get_file suffix and some additional request parameters in order to provide a hyperlink to a document in the Liferay Document Library. See the Liferay struts-config.xml file for a complete list of available suffixes.

<h:dataTable id="documents" value="#{documentModelBean.dataModel}" var="dlFileEntry">
	<h:column>
		<f:facet name="head">
			<h:outputText value="#{i18n['file-name']}" />
		</f:facet>
		<h:outputLink
			target="_blank"
			value="#{liferay.documentLibraryURL}/get_file?p_l_id=#{liferay.themeDisplay.plid}&folderId=#{dlFileEntry.folderId}&name=#{dlFileEntry.name}">
			<h:outputText value="#{dlFileEntry.title}" />
		</h:outputLink>
	</h:column>
</h:dataTable>

The Liferay User that owns the Liferay community/organization portal page that the current portlet is placed upon.

<h:outputText
	value="The user named #{liferay.groupUser.fullName} owns this set of Liferay Portal pages." />

The absolute URL for the Liferay Image Gallery Struts action path prefix. See the Liferay struts-config.xml file for a complete list of available suffixes.

The absolute URL for the Liferay Image Servlet. Although this can be used to construct a URL that points a Liferay user's portrait/photo, for performance reasons, it is better to use the portraitURL EL variable instead.

The Liferay Layout associated with the community/organization portal page that the current portlet is placed upon.

<h:outputText
	value="The name of this portal page is #{liferay.layout.name}" />

The Liferay PermissionChecker associated with the current request and Liferay User.

<h:commandButton actionListener="#{backingBean.save}" rendered="#{liferay.permissionChecker.companyAdmin}" value="#{i18n['save']}" />

The absolute URL for the portal. For example: http://localhost:8080

The containing Liferay Portlet associated with the PortletRequest.

<h:outputText
	value="The name of this portlet is #{liferay.portlet.displayName}" />

Designed to be called from the EL by passing a Liferay User or userId as an array index, returns the absolute URL to the user's portrait.

<h:graphicImage value="#{liferay.portraitURL[liferay.group.user]}" />

The Liferay Theme associated with the Liferay Layout.

<h:outputText value="The name of the Liferay theme applied to this portal page is #{liferay.theme.name}" />

The Liferay ThemeDisplay associated with the PortletRequest. Perhaps it is easier to think of the Liferay ThemeDisplay as a "display context" which provides access to a wealth of information including the current Company, User, Layout, Theme, PermissionChecker, and more.

<link href="#{liferay.themeDisplay.uRLSignIn}">#{i18n['sign-in']}</link>

Designed to be called from the EL by passing a relative path to a theme image as an array index, returns the absolute URL to the theme image.

<h:graphicImage value="#{liferay.themeImageURL['/common/delete.png']}" />

Returns the absolute URL for the image path associated with the current Liferay Theme. For example: http://localhost:8080/image/image_gallery.

<h:graphicImage value="#{liferay.themeImagesURL}/common/delete.png" />

the Liferay User associated with the PortletRequest.

<h:outputText value="#{i18n['welcome']}, #{liferay.user.firstName}" />

Designed to be called from the EL by passing an action-key as an array index, returns a Boolean indicating whether or not the Liferay User associated with the PortletRequest has permission to execute the specified action-key on the current portlet. The action-key is typically defined in a Liferay resource-action-mapping XML file that defines the <portlet-resource/> and <model-resource/> permissions associated with a Liferay portlet. Please refer to the portal-impl/classes/resource-actions/messageboards.xml file in the Liferay Portal source code distribution for an example of how to write a Liferay resource-action-mapping XML file.

<h:dataTable
	rendered="#{liferay.userHasPortletPermission['VIEW']}"
	value="#{modelManagedBean.users}"
	var="user">
</h:dataTable>

The liferay-ui:input-editor tag renders a text area that provides the ability to enter rich text such as bold, italic, and underline. The renderer relies on the CKEditor^TM to provide the rich text editing area. Since Liferay bundles the CKEditor^TM JavaScript and related images with the portal, the portlet developer does not need to include it with the portlet.

<context-param>
    <param-name>org.portletfaces.liferay.faces.inlineInputEditor</param-name>
    <param-value>true</param-value>
</context-param>
				

<listener>
    <listener-class>org.portletfaces.liferay.faces.listener.StartupListener</listener-class>
</listener>
				

<h:panelGroup id="feedback">
    <h:messages globalOnly="true" layout="table" />
</h:panelGroup>
<h:panelGroup id="editor">
    <liferay-ui:input-editor value="#{modelBean.text}" />
</h:panelGroup>
<h:commandButton>
    <f:ajax execute="@form" render="feedback" />
</h:commandButton>
				

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<f:view xmlns:f="http://java.sun.com/jsf/core"
	xmlns:h="http://java.sun.com/jsf/html"
	xmlns:pf="http://portletfaces.org/facelets">

	<h:form>
		<liferay-ui:input-editor id="comments" value="#{modelManagedBean.comments}" />
	</h:form>

</f:view>

The liferay-security:permissionsURL tag renders an HTML anchor tag (hyperlink) that the user can click on in order to see the Liferay Permissions screen for the associated resource.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<f:view xmlns:f="http://java.sun.com/jsf/core"
	xmlns:h="http://java.sun.com/jsf/html"
	xmlns:pf="http://portletfaces.org/facelets">

	<h:form>
		<liferay-security:permissionsURL
			modelResource="org.portletfaces.myproject.model.Book"
			modelResourceDescription="Book"
			resourcePrimKey="#{modelManagedBean.book.bookId} />
	</h:form>

</f:view>

The liferay-ui:ice-info-data-paginator encapsulates an ICEfaces ice:dataPaginator tag that renders pagination information for an associated ice:dataTable. The navigation information will match the internationalized Liferay "showing-x-x-of-x-results" message.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<f:view xmlns:f="http://java.sun.com/jsf/core"
	xmlns:ice="http://www.icesoft.com/icefaces/component"
	xmlns:pf="http://portletfaces.org/facelets">

	<liferay-ui:ice-info-data-paginator for="dataTable1" />
	<ice:dataTable id="dataTable1" value="#{modelManagedBean.rows}" var="row">
		...
	</ice:dataTable>

</f:view>

The liferay-ui:ice-info-data-paginator encapsulates an ICEfaces ice:dataPaginator tag that renders navigation controls for an associated ice:dataTable. The icons will match the current Liferay theme.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<f:view xmlns:f="http://java.sun.com/jsf/core"
	xmlns:ice="http://www.icesoft.com/icefaces/component"
	xmlns:pf="http://portletfaces.org/facelets">

	<liferay-ui:ice-nav-data-paginator for="dataTable1" />
	<ice:dataTable id="dataTable1" value="#{modelManagedBean.rows}" var="row">
		...
	</ice:dataTable>

</f:view>

The liferay-ui:icon tag encapsulates an HTML img tag whose src attribute contains a fully qualified URL to an icon image in the current Liferay theme.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<f:view xmlns:f="http://java.sun.com/jsf/core"
	xmlns:ice="http://www.icesoft.com/icefaces/component"
	xmlns:pf="http://portletfaces.org/facelets">

	<liferay-ui:icon alt="#{i18n['delete']}" image="delete" />

</f:view>

LiferayFaces provides the LiferayFacesContext.getThemeDisplay() method at the Java level and also the liferay.themeDisplay EL variable for getting access to the Liferay ThemeDisplay object.

LiferayFaces provides the liferay-ui:icon Facelet composite component tag that encapsulates an HTML img tag whose src attribute contains a fully qualified URL to an icon image in the current Liferay theme. Additionally, LiferayFaces provides the liferay.themeImagesURL and liferay.themeImageURL Facelet composite component tags for gaining access to theme image icons.

Most of the standard JSF HTML component tags render themselves as HTML markup such as <label />, <input />, <span />, etc. and assume the current Liferay theme thanks to the power of CSS. However, the h:messages and h:message tag will not assume the current Liferay theme unless the following JSR 286 standard CSS class names are applied:

<h:messages errorClass="portlet-msg-error" fatalClass="portlet-msg-error"
	infoClass="portlet-msg-info" warnClass="portlet-msg-warn" />
			

As a convenience, LiferayFaces provides the liferay-ui:messages and liferay-ui:message Facelet composite component tags that encapsulate the h:messages and h:message tags respectively, and automatically apply the JSR 286 standard class names as shown above.