Permalink
Fetching contributors…
Cannot retrieve contributors at this time
1093 lines (1038 sloc) 22.2 KB

Development Reference

Here you'll find reference documentation for @product@, 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 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 @product-ver@ and @product@ apps.

@product-ver@ Java APIs

<style> table, th, td { border: 1px solid black; border-collapse: collapse; } th, td { padding: 5px; text-align: left; } caption { text-align: left; } </style> This table links you to the @product-ver@ API modules. Their root location is here. (Opens New Window) The reference doc Zip is available here. (Opens New Window)
Core: com.liferay.portal.kernel (portal-kernel): (Opens New Window)  for developing applications on @product@
com.liferay.util.bridges (util-bridges): (Opens New Window)  for using various non-proprietary computing languages, frameworks, and utilities on @product@
com.liferay.util.java (util-java): (Opens New Window)  for using various Java-related frameworks and utilities on @product@
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 @product-ver@'s implementation in order to contribute to it

@product@ App Java APIs

<style> table, th, td { border: 1px solid black; border-collapse: collapse; } th, td { padding: 5px; text-align: left; } caption { text-align: left; } </style> This table links you to @product@ application APIs. Their root location is here. (Opens New Window)
Collaboration (Opens New Window)
(JAR) (Opens New Window)
com.liferay.announcements.api
com.liferay.blogs.api
com.liferay.blogs.demo.data.creator.api
com.liferay.blogs.item.selector.api
com.liferay.blogs.recent.bloggers.api
com.liferay.bookmarks.api
com.liferay.comment.api
com.liferay.comment.demo.data.creator.api
com.liferay.document.library.api
com.liferay.document.library.content.api
com.liferay.document.library.file.rank.api
com.liferay.document.library.repository.cmis.api
com.liferay.document.library.sync.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.reading.time.api
com.liferay.social.activities.api
com.liferay.social.activity.api
com.liferay.social.bookmarks.api
com.liferay.social.user.statistics.api
com.liferay.subscription.api
com.liferay.upload.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.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.apio.architect.api
com.liferay.apio.architect.wiring.osgi.api
com.liferay.apio.architect.writer.api
com.liferay.captcha.api
com.liferay.configuration.admin.api
com.liferay.contacts.api
com.liferay.friendly.url.api
com.liferay.frontend.editor.api
com.liferay.frontend.image.editor.api
com.liferay.frontend.js.loader.modules.extender.api
com.liferay.map.api
com.liferay.mobile.device.rules.api
com.liferay.organizations.api
com.liferay.organizations.item.selector.api
com.liferay.password.policies.admin.api
com.liferay.portal.background.task.api
com.liferay.portal.cache.api
com.liferay.portal.configuration.upgrade.api
com.liferay.portal.instances.api
com.liferay.portal.lock.api
com.liferay.portal.remote.soap.extender.api
com.liferay.portal.scripting.api
com.liferay.portal.search.api
com.liferay.portal.search.web.api
com.liferay.portal.security.audit.api
com.liferay.portal.security.sso.cas.api
com.liferay.portal.security.sso.facebook.connect.api
com.liferay.portal.security.sso.google.api
com.liferay.portal.security.sso.ntlm.api
com.liferay.portal.security.sso.openid.api
com.liferay.portal.security.sso.openid.connect.api
com.liferay.portal.security.sso.opensso.api
com.liferay.portal.security.sso.token.api
com.liferay.portal.security.exportimport.api
com.liferay.portal.security.ldap.api
com.liferay.portal.security.service.access.policy.api
com.liferay.portal.settings.api
com.liferay.portal.template.soy.api
com.liferay.portal.url.builder.api
com.liferay.portal.custom.jsp.bag.api
com.liferay.portal.instance.lifecycle.api
com.liferay.portal.jmx.api
com.liferay.portal.output.stream.container.api
com.liferay.portal.spring.extender.api
com.liferay.portal.upgrade.api
com.liferay.roles.admin.api
com.liferay.roles.admin.demo.data.creator.api
com.liferay.roles.item.selector.api
com.liferay.text.localizer.address.api
com.liferay.user.associated.data.api
com.liferay.user.groups.admin.api
com.liferay.user.groups.admin.item.selector.api
com.liferay.users.admin.api
com.liferay.users.admin.demo.data.creator.api
com.liferay.users.admin.item.selector.api
com.liferay.xstream.configurator.api
Web Experience (Opens New Window)
(JAR) (Opens New Window)
com.liferay.application.list.api
com.liferay.asset.api
com.liferay.asset.categories.navigation.api
com.liferay.asset.category.property.api
com.liferay.asset.display.api
com.liferay.asset.display.template.api
com.liferay.asset.entry.rel.api
com.liferay.asset.publisher.api
com.liferay.asset.tag.stats.api
com.liferay.asset.tags.api
com.liferay.asset.tags.navigation.api
com.liferay.exportimport.api
com.liferay.exportimport.changeset.api
com.liferay.fragment.api
com.liferay.fragment.demo.data.creator.api
com.liferay.fragment.item.selector.api
com.liferay.html.preview.api
com.liferay.journal.api
com.liferay.journal.demo.data.creator.api
com.liferay.journal.item.selector.api
com.liferay.layout.admin.api
com.liferay.layout.api
com.liferay.layout.item.selector.api
com.liferay.layout.page.template.api
com.liferay.layout.prototype.api
com.liferay.layout.set.prototype.api
com.liferay.portlet.display.template.api
com.liferay.product.navigation.control.menu.api
com.liferay.product.navigation.product.menu.api
com.liferay.product.navigation.simulation.api
com.liferay.rss.api
com.liferay.site.navigation.admin.api
com.liferay.site.navigation.api
com.liferay.site.navigation.item.selector.api
com.liferay.site.navigation.language.api
com.liferay.site.api
com.liferay.site.demo.data.creator.api
com.liferay.site.item.selector.api
com.liferay.staging.api
com.liferay.trash.api

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

Taglibs

Here you'll find tag library documentation for the @product-ver@, @product@ apps, and Liferay Faces.

@product-ver@ Taglibs

<style> table, th, td { border: 1px solid black; border-collapse: collapse; } th, td { padding: 5px; text-align: left; } caption { text-align: left; } </style>
Util Taglibs (Opens New Window) JSTL core
aui
liferay-portlet
portlet
portlet_1_0
liferay-security
liferay-theme
liferay-ui
liferay-util

@product@ App Taglibs

<style> table, th, td { border: 1px solid black; border-collapse: collapse; } th, td { padding: 5px; text-align: left; } caption { text-align: left; } </style>
Adaptive Media: liferay-application-list (Opens New Window)
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: A system for building applications in and outside of @product@, designed to be fluid and extensible, as well as provide a consistent and documented API.

Clay: The web implementation of Liferay's Lexicon Experience Language.

Bootstrap: The base CSS library onto which Lexicon is built. @product@ uses Bootstrap natively and all of its CSS classes and JavaScript features 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 @product@ apps, @product@ plugins, and @product-ver@.