Development Reference

Here you’ll find reference documentation for Liferay Portal, Liferay Screens, Liferay Faces, and technologies related to you as a third-party developer.

The different types of reference docs you’ll find in this section of the Liferay Developer Network are as follows:

  • Descriptions of Java and JavaScript APIs, CSS, tags and tag libraries, and XML DTDs
  • Write ups on the latest Screenlets for Liferay Screens
  • Breaking changes
  • Cheat sheets and tips on
    • Plugin anatomy
    • Design patterns
    • Tools
    • Adapting to new APIs

Liferay’s reference docs are at your fingertips.

Java APIs

Here you’ll find Javadoc for Liferay Portal CE 7.0 and Liferay Portal apps.

Liferay Portal CE 7.0 Java APIs

This table links you to the Liferay Portal CE 7.0 API modules. Their root location is here. (Opens New Window) The reference doc JAR is available here. (Opens New Window)
Core: com.liferay.portal.kernel (portal-kernel): (Opens New Window)  for developing applications on Liferay Portal
com.liferay.util.bridges (util-bridges): (Opens New Window)  for using various non-proprietary computing languages, frameworks, and utilities on Liferay Portal
com.liferay.util.java (util-java): (Opens New Window)  for using various Java-related frameworks and utilities on Liferay Portal
com.liferay.util.slf4j (util-slf4j): (Opens New Window)  for using the Simple Logging Facade for Java (SLF4J)
com.liferay.portal.impl (portal-impl): (Opens New Window)  refer to this only if you are an advanced Liferay developer that needs a deeper understanding of Liferay Portal CE 7.0's implementation in order to contribute to it

Liferay Portal App Java APIs

This table links you to Liferay Portal application APIs. Their root location is here. (Opens New Window)
Collaboration (Opens New Window)
(JAR) (Opens New Window)
com.liferay.blogs.api
com.liferay.blogs.item.selector.api
com.liferay.bookmarks.api
com.liferay.comment.api
com.liferay.document.library.api
com.liferay.document.library.repository.cmis.api
com.liferay.flags.api
com.liferay.invitation.invite.members.api
com.liferay.item.selector.api
com.liferay.item.selector.criteria.api
com.liferay.mentions.api
com.liferay.message.boards.api
com.liferay.microblogs.api
com.liferay.ratings.api
com.liferay.social.activity.api
com.liferay.social.privatemessaging.api
com.liferay.wiki.api
Forms & Workflow (Opens New Window)
(JAR) (Opens New Window)
com.liferay.calendar.api
com.liferay.dynamic.data.lists.api
com.liferay.dynamic.data.mapping.api
com.liferay.polls.api
com.liferay.portal.reports.engine.api
com.liferay.portal.rules.engine.api
com.liferay.portal.workflow.kaleo.api
com.liferay.portal.workflow.kaleo.definition.api
com.liferay.portal.workflow.kaleo.runtime.api
Foundation (Opens New Window)
(JAR) (Opens New Window)
com.liferay.contacts.api
com.liferay.frontend.image.editor.api
com.liferay.map.api
com.liferay.mobile.device.rules.api
com.liferay.password.policies.admin.api
com.liferay.portal.background.task.api
com.liferay.portal.lock.api
com.liferay.portal.scripting.api
com.liferay.portal.security.audit.api
com.liferay.portal.security.exportimport.api
com.liferay.portal.security.service.access.policy.api
com.liferay.portal.settings.api
com.liferay.roles.admin.api
com.liferay.user.groups.admin.api
com.liferay.users.admin.api
com.liferay.users.admin.demo.data.creator.api
com.liferay.xstream.configurator.api
Web Experience (Opens New Window)
(JAR) (Opens New Window)
com.liferay.application.list.api
com.liferay.exportimport.api
com.liferay.journal.api
com.liferay.journal.item.selector.api
com.liferay.layout.item.selector.api
com.liferay.layout.prototype.api
com.liferay.layout.set.prototype.api
com.liferay.portlet.configuration.icon.locator.api
com.liferay.portlet.configuration.toolbar.contributor.locator.api
com.liferay.product.navigation.control.menu.api
com.liferay.site.api
com.liferay.site.item.selector.api
com.liferay.staging.api

For help finding API modules for specific common classes, see Liferay Portal CE 7.0 API Modules.

For help finding module attributes and configuring dependencies, see Configuring Dependencies.

Taglibs

Here you’ll find tag library documentation for the Liferay Portal CE 7.0, Liferay Portal apps, and Liferay Faces.

Liferay Portal CE 7.0 Taglibs


Util Taglibs (Opens New Window) aui
liferay-portlet
portlet
liferay-security
liferay-theme
liferay-ui
liferay-util

Liferay Portal App Taglibs


Application List: liferay-application-list (Opens New Window)
Assets: liferay-asset (Opens New Window)
liferay-trash (Opens New Window)
Forms: liferay-ddm (Opens New Window)
Foundation: liferay-map (Opens New Window)
liferay-frontend (Opens New Window)
Import, Export, & Staging: liferay-staging (Opens New Window)
Item Selector: liferay-item-selector (Opens New Window)
Product Navigation: liferay-product-navigation (Opens New Window)
Sites: liferay-layout (Opens New Window)
liferay-site-navigation (Opens New Window)
Social: liferay-flags (Opens New Window)

For help finding module attributes and configuring dependencies, see Configuring Dependencies.

Faces Taglibs

Faces 3.2 Taglibs: the latest version of Liferay Faces JSF tag docs in View Declaration Language (VDL) format. VDL docs for all versions of Liferay Faces are available here.

JavaScript and CSS

Lexicon: The Liferay Experience Language is a system for building applications in and outside of Liferay, designed to be fluid and extensible, as well as provide a consistent and documented API.

Bootstrap: The base CSS library onto which Lexicon is added. Liferay uses Bootstrap natively and all of its CSS classes are available within portlets, templates, and themes.

AlloyUI: Liferay includes AlloyUI and all of its JavaScript APIs are available within portlets, templates and themes.

Descriptor Definitions

DTDs: Describes the XML files used in configuring Liferay Portal apps, Liferay Portal plugins, and Liferay Portal CE 7.0.

+2 (2 Votes)