All Downloads are FREE. Search and download functionalities are using the official Maven repository.

META-INF.liferay-ui.tld Maven / Gradle / Ivy

There is a newer version: 25.3.0
Show newest version



	Provides the Liferay UI component tags, prefixed with liferay-ui:]]>.
	1.0
	liferay-ui
	http://liferay.com/tld/ui
	
		csp
		com.liferay.taglib.ui.CSPTag
		JSP
		
			recursive
			false
			true
			boolean
		
	
	
		Deprecated as of 7.4.0, replaced by the liferay-frontend:logo-selector]]> tag.
		empty-result-message
		com.liferay.taglib.ui.EmptyResultMessageTag
		JSP
		
			Whether to use only the empty results message and text styling, and not use the large smiley face animation. The default value is false]]>.
			compact
			false
			true
			boolean
		
		
			cssClass
			false
			true
		
		
			message
			true
			true
		
		
			search
			false
			true
		
	
	
		Creates an error message to display to the user.
		error
		com.liferay.taglib.ui.ErrorTag
		com.liferay.taglib.ui.ErrorTei
		JSP
		
			embed
			false
			true
			boolean
		
		
			A class for the exception.
			exception
			false
			true
		
		
			The name of a field on which to focus the error message.
			focusField
			false
			true
		
		
			A key to place in the SessionErrors]]> object to trigger the error message.
			key
			false
			true
		
		
			Explicit message text or a language key name from which to derive text for the message.
			message
			false
			true
		
		
			rowBreak
			false
			true
		
		
			targetNode
			false
			true
		
		
			Whether to translate the message into the user's language. The default value is true]]>.
			translateMessage
			false
			true
			boolean
		
	
	
		Creates a liferay-ui:header]]> with a back button; it's for displaying above an error message.
		error-header
		com.liferay.taglib.ui.ErrorHeaderTag
		JSP
	
	
		error-marker
		com.liferay.taglib.ui.ErrorMarkerTag
		JSP
		
			key
			false
			true
		
		
			value
			false
			true
		
	
	
		Creates an authorization failure error message to display to the user.
		error-principal
		com.liferay.taglib.ui.ErrorPrincipalTag
		JSP
	
	
		Creates a header that displays its text above a horizontal rule accompanied by a configurable back URL button.
		header
		com.liferay.taglib.ui.HeaderTag
		JSP
		
			Text to display on mouse over of the back URL. The default value is Back]]>.
			backLabel
			false
			true
		
		
			A URL for navigating back to.
			backURL
			false
			true
		
		
			A CSS class for styling the component.
			cssClass
			false
			true
		
		
			Whether to escape the header's XML tags. The default value is true]]>.
			escapeXml
			false
			true
			boolean
		
		
			Whether to translate the header's title]]> into the localized language. The default value is true]]>.
			localizeTitle
			false
			true
			boolean
		
		
			Whether to display the back URL. The default value is true]]>.
			showBackURL
			false
			true
			boolean
		
		
			A title to display as the header text.
			title
			true
			true
		
	
	
		Creates a fully configurable icon that provides access to current Liferay theme icons.
		icon
		com.liferay.taglib.ui.IconTag
		JSP
		
			A value for the alt]]> attribute of the embedded img]]> tag.
			alt
			false
			true
		
		
			A role for assistive technologies to interpret for HTML elements that have been used for something other than their intended purpose. For example, the <p>]]> tag could be used for something other than a paragraph.
			ariaRole
			false
			true
		
		
			A CSS class for styling the component.
			cssClass
			false
			true
		
		
			Miscellaneous data to be stored via a map. This data is not shared with the browser. The map holds key value pairs of type <String, Object>]]>.
			data
			false
			true
			java.util.Map
		
		
			icon
			false
			true
		
		
			An icon from a Bootstrap icon CSS Class. Note that any image for the image]]> attribute takes precedence. Icon CSS classes to specify for this attribute can be found at http://marcoceppi.github.io/bootstrap-glyphicons/]]>.
			iconCssClass
			false
			true
		
		
			An ID for the component instance.
			id
			false
			true
		
		
			An image for the icon, from the current theme. The value can be the filename prefix of any image file in the theme's common]]> image folder. This image takes precedence over any icon value set via the iconCssClass]]> attribute.
			image
			false
			true
		
		
			An icon to display on mouse over of the component. The icon image comes from the current theme. The value can be the filename prefix of any image file in the theme's common]]> image folder.
			imageHover
			false
			true
		
		
			Whether to display the message]]> attribute's value as the icon's label.
			label
			false
			true
			boolean
		
		
			A language to associate with the icon, to assist search engines and web browsers in finding and rendering the icon appropriately.
			lang
			false
			true
		
		
			A CSS class for styling the icon's URL.
			linkCssClass
			false
			true
		
		
			Whether to translate the icon's message]]> into the user's language.
			localizeMessage
			false
			true
			boolean
		
		
			Deprecated as of 7.4.0, with no direct replacement.
			markupView
			false
			true
		
		
			Text to be displayed for the icon on mouse over.
			message
			false
			true
		
		
			An HTTP request method. Possible values are get]]> and post]]>.
			method
			false
			true
		
		
			A function to be called on a user clicking the icon.
			onClick
			false
			true
		
		
			The location of an image file to use in the icon.
			src
			false
			true
		
		
			The location of an image file to use on mouse over of the icon. This value takes precedence over the imageHover]]> attribute. This image takes precedence over icons set with the imageHover]]> attribute.
			srcHover
			false
			true
		
		
			A target window in which to open the URL. The default value is self]]>. Possible values are blank]]>, self]]>, parent]]>, top]]>, and a unique frame's name.
			target
			false
			true
		
		
			Whether to use a tooltip. The default value is true]]>.
			toolTip
			false
			true
			boolean
		
		
			A URL to navigate to when the icon is clicked.
			url
			false
			true
		
		
			Whether to open the URL in a dialog window. The default value is false]]>.
			useDialog
			false
			true
			boolean
		
	
	
		Creates an icon to associate with deactivating an item.
		icon-deactivate
		com.liferay.taglib.ui.IconDeactivateTag
		JSP
		
			Whether to display a message on the icon's label on mouse over of the icon. The default value is false]]>.
			label
			false
			true
			boolean
		
		
			A URL navigated to when the icon is clicked.
			url
			true
			true
		
	
	
		Creates a configurable icon to associate with deleting or removing an item.
		icon-delete
		com.liferay.taglib.ui.IconDeleteTag
		JSP
		
			Text to use in place of the text from the default deletion confirmation message language key are-you-sure-you-want-to-delete-this]]>. If the trash]]> attribute is set to true]]>, no confirmation message is shown.
			confirmation
			false
			true
		
		
			A CSS class for styling the component.
			cssClass
			false
			true
		
		
			icon
			false
			true
		
		
			An ID for the component instance.
			id
			false
			true
		
		
			An image for the icon, from the current theme. The value can be the filename prefix of any image file in the theme's common]]> image folder. The image takes precedence over any default icon images.
			image
			false
			true
		
		
			Whether to display the message]]> attribute's value as the icon's label. The default value is false]]>.
			label
			false
			true
			boolean
		
		
			A CSS class for styling the icon's URL.
			linkCssClass
			false
			true
		
		
			Text to display on mouse over of the icon.
			message
			false
			true
		
		
			An HTTP request method to invoke. Possible values are get]]> and post]]>.
			method
			false
			true
		
		
			showIcon
			false
			true
		
		
			Whether to use the trash icon instead of the remove icon. The default value is false]]>.
			trash
			false
			true
			boolean
		
		
			A URL navigated to when the icon is clicked.
			url
			true
			true
		
	
	
		Creates a help icon that displays a custom message as a tooltip on mouse over of the help icon.
		icon-help
		com.liferay.taglib.ui.IconHelpTag
		JSP
		
			Text to be displayed on mouse over of the icon.
			message
			true
			true
		
	
	
		Creates a list of icons from a list of child components.
		icon-list
		com.liferay.taglib.ui.IconListTag
		JSP
		
			Whether to render the icon list when there is only one child component. The default value is false]]>.
			showWhenSingleIcon
			false
			true
			boolean
		
	
	
		Creates an icon menu from a list of child components.
		icon-menu
		com.liferay.taglib.ui.IconMenuTag
		JSP
		
			A CSS class for styling the component.
			cssClass
			false
			true
		
		
			data
			false
			true
		
		
			A position from which to pop up the icon menu dialog in relation to the trigger. The default direction is left]]>. Possible values are up]]>, down]]>, left]]> or right]]>.
			direction
			false
			true
		
		
			Whether to disable the icon menu.
			disabled
			false
			true
			boolean
		
		
			A CSS class for styling the dropdown.
			dropdownCssClass
			false
			true
		
		
			Whether to extend the icon menu trigger by wrapping it in a button. The default value is true]]>.
			extended
			false
			true
			boolean
		
		
			The location of an image file to use in the icon.
			icon
			false
			true
		
		
			An ID for the component instance.
			id
			false
			true
		
		
			Whether to translate the message to the user's language. The default value is true]]>.
			localizeMessage
			false
			true
			boolean
		
		
			Deprecated as of 7.4.0, with no direct replacement.
			markupView
			false
			true
		
		
			The number of items to show in the icon menu before scrolling. The default value is 15]]>.
			maxDisplayItems
			false
			true
			int
		
		
			Text to display next to the icon menu trigger. The default value is actions]]>.
			message
			false
			true
		
		
			scroll
			false
			true
			boolean
		
		
			Whether to add the select]]> CSS class to the icon menu. If set to true]]>, the selected icon is added to the icon menu's trigger when the icon is selected. The default value is false]]>.
			select
			false
			true
			boolean
		
		
			Whether to show an arrow, indicating a popup dialog, next to the icon menu's trigger icon. The default value is true]]>.
			showArrow
			false
			true
			boolean
		
		
			Whether to extend the icon menu by default. The default value is false]]>.
			showExpanded
			false
			true
			boolean
		
		
			Whether to show the icon menu when there is only one icon. The default value is false]]>.
			showWhenSingleIcon
			false
			true
			boolean
		
		
			triggerAriaLabel
			false
			true
		
		
			A CSS class for styling the trigger for the icon menu. The default value is btn btn-secondary]]>.
			triggerCssClass
			false
			true
		
		
			
			triggerLabel
			false
			true
		
		
			
			triggerType
			false
			true
		
		
			Whether the icon menu drop-down caret points to the direction set by the direction]]> attribute.
			useIconCaret
			false
			true
			boolean
		
	
	
		Creates a configurable input checkbox.
		input-checkbox
		com.liferay.taglib.ui.InputCheckBoxTag
		JSP
		
			autoComplete
			false
			true
		
		
			A CSS class for styling the component.
			cssClass
			false
			true
		
		
			Whether the checkbox is selected by default.
			defaultValue
			false
			true
			boolean
		
		
			Whether the checkbox is disabled.
			disabled
			false
			true
			boolean
		
		
			A name for the checkbox's form.
			formName
			false
			true
		
		
			An ID for the component instance.
			id
			false
			true
		
		
			A function to be called on a user clicking the checkbox.
			onClick
			false
			true
		
		
			A variable name for the component.
			param
			true
			true
		
	
	
		Creates a date input field that displays a calendar for date selection.
		input-date
		com.liferay.taglib.ui.InputDateTag
		JSP
		
			autoComplete
			false
			true
		
		
			Whether the date field gets focus by default. The default value is false]]>.
			autoFocus
			false
			true
			boolean
		
		
			A CSS class for styling the component.
			cssClass
			false
			true
		
		
			A label for the checkbox that enables and disables the date input. The default value is Disable]]>.
			dateTogglerCheckboxLabel
			false
			true
		
		
			A variable name to refer to the day of the component.
			dayParam
			false
			true
		
		
			A day value to display in the input field.
			dayValue
			false
			true
			int
		
		
			Whether to disable the input field. The default value is false]]>.
			disabled
			false
			true
			boolean
		
		
			Deprecated as of 7.4.0, replaced by the attribute useNamespace]]>.
			disableNamespace
			false
			true
			boolean
		
		
			A day to set as the first day of the week. The default value is Calendar.SUNDAY - 2]]>.
			firstDayOfWeek
			false
			true
			int
		
		
			A date to set as the first selectable date in the datepicker.
			firstEnabledDate
			false
			true
		
		
			A name for the date input's form.
			formName
			false
			true
		
		
			A date to set as the latest selectable date in the datepicker.
			lastEnabledDate
			false
			true
		
		
			A variable name to refer to the combined month and year of the component.
			monthAndYearParam
			false
			true
		
		
			A variable name to refer to the month of the component.
			monthParam
			false
			true
		
		
			The numerical value for a month to display in the input field. Integer values for the month start with 0]]>.
			monthValue
			false
			true
			int
		
		
			A name for the date input.
			name
			false
			true
		
		
			Whether the component's values can be set to null.
			nullable
			false
			true
		
		
			Whether to mark the date input as required.
			required
			false
			true
			boolean
		
		
			Whether to display the checkbox that disables the input field.
			showDisableCheckbox
			false
			true
		
		
			Whether to use a namespace in the tag. The default value is true]]>.
			useNamespace
			false
			true
			boolean
		
		
			A variable name to refer to the year of the component.
			yearParam
			false
			true
		
		
			A year value to display in the input field.
			yearValue
			false
			true
			int
		
	
	
		Deprecated as of 7.1.0, replaced by the liferay-editor:editor]]> tag.
		input-editor
		com.liferay.taglib.ui.InputEditorTag
		JSP
		
			allowBrowseDocuments
			false
			true
		
		
			autoCreate
			false
			true
		
		
			configKey
			false
			true
		
		
			A map of configuration parameters. The map holds key value pairs of type <String, String>]]>.
			configParams
			false
			true
			java.util.Map
		
		
			contents
			false
			true
		
		
			The ID of a language for the input editor's text.
			contentsLanguageId
			false
			true
		
		
			A CSS class for styling the component.
			cssClass
			false
			true
		
		
			data
			false
			true
		
		
			Deprecated as of 7.0.0, replaced by the attribute editorName]]>.
			editorImpl
			false
			true
		
		
			editorName
			false
			true
		
		
			A map of configuration parameters. The map holds key value pairs of <String, String>]]>.
			fileBrowserParams
			false
			true
			java.util.Map
		
		
			height
			false
			true
		
		
			Deprecated as of 7.0.0, replaced by the attribute contents]]>.
			initMethod
			false
			true
		
		
			inlineEdit
			false
			true
		
		
			inlineEditSaveURL
			false
			true
		
		
			A name for the input editor. The default value is editor]]>.
			name
			false
			true
		
		
			A function to be called when the input editor loses focus.
			onBlurMethod
			false
			true
		
		
			A function to be called on a change in the input editor.
			onChangeMethod
			false
			true
		
		
			A function to be called when the input editor gets focus.
			onFocusMethod
			false
			true
		
		
			A function to be called when the input editor initializes.
			onInitMethod
			false
			true
		
		
			Placeholder text to display in the input editor.
			placeholder
			false
			true
		
		
			Whether the field for the input editor is required. The default value is false]]>.
			required
			false
			true
			boolean
		
		
			Whether the field for the input editor is resizable. The default value is true]]>.
			resizable
			false
			true
			boolean
		
		
			Whether to enable editing the HTML source code of the content. The default value is true]]>.
			showSource
			false
			true
		
		
			Whether to skip loading resources necessary for the CKEditor. The default value is false]]>.
			skipEditorLoading
			false
			true
			boolean
		
		
			A toolbar for the input editor. The default value is liferay]]>. Possible values are bbcode]]>, creole]]>, editInPlace]]>, email]]>, liferay]]>, liferayArticle]]>, phone]]>, simple]]>, and tablet]]>.
			toolbarSet
			false
			true
		
		
			width
			false
			true
		
	
	
		input-field
		com.liferay.taglib.ui.InputFieldTag
		JSP
		
			activeLanguageIds
			false
			true
		
		
			adminMode
			false
			true
		
		
			autoComplete
			false
			true
		
		
			autoFocus
			false
			true
		
		
			autoSize
			false
			true
		
		
			bean
			false
			true
		
		
			cssClass
			false
			true
		
		
			dateTogglerCheckboxLabel
			false
			true
		
		
			defaultLanguageId
			false
			true
		
		
			defaultValue
			false
			true
		
		
			disabled
			false
			true
		
		
			field
			true
			true
		
		
			fieldParam
			false
			true
		
		
			format
			false
			true
		
		
			formName
			false
			true
		
		
			id
			false
			true
		
		
			ignoreRequestValue
			false
			true
		
		
			languageId
			false
			true
		
		
			model
			true
			true
		
		
			placeholder
			false
			true
		
		true
	
	
		input-localized
		com.liferay.taglib.ui.InputLocalizedTag
		JSP
		
			activeLanguageIds
			false
			true
		
		
			adminMode
			false
			true
		
		
			autoFocus
			false
			true
		
		
			autoSize
			false
			true
		
		
			availableLocales
			false
			true
		
		
			cssClass
			false
			true
		
		
			defaultLanguageId
			false
			true
		
		
			disabled
			false
			true
		
		
			displayWidth
			false
			true
		
		
			editorName
			false
			true
		
		
			fieldPrefix
			false
			true
		
		
			fieldPrefixSeparator
			false
			true
		
		
			formName
			false
			true
		
		
			
			helpMessage
			false
			true
		
		
			id
			false
			true
		
		
			ignoreRequestValue
			false
			true
		
		
			inputAddon
			false
			true
		
		
			languageId
			false
			true
		
		
			languagesDropdownDirection
			false
			true
		
		
			languagesDropdownVisible
			false
			true
		
		
			maxLength
			false
			true
		
		
			name
			true
			true
		
		
			placeholder
			false
			true
		
		
			selectedLanguageId
			false
			true
		
		
			toolbarSet
			false
			true
		
		
			type
			false
			true
		
		
			xml
			true
			true
		
		true
	
	
		Creates an input move boxes component comprised of two columns of key value pairs that can be rearranged.
		input-move-boxes
		com.liferay.taglib.ui.InputMoveBoxesTag
		JSP
		
			A CSS class for styling the component.
			cssClass
			false
			true
		
		
			Sets the maximum number of items for the left box. The default value null]]> represents an unlimited number of items.
			leftBoxMaxItems
			false
			true
			int
		
		
			A name for the left box.
			leftBoxName
			true
			true
		
		
			A list of key value pairs for the left box.
			leftList
			true
			true
			java.util.List
		
		
			A function to be called on a change in selection in the left list.
			leftOnChange
			false
			true
		
		
			Whether the left list can be reordered. The default value is false]]>.
			leftReorder
			false
			true
			boolean
		
		
			A title to display at the top of the left box.
			leftTitle
			true
			true
		
		
			Sets the maximum number of items for the right box. The default value null]]> represents an unlimited number of items.
			rightBoxMaxItems
			false
			true
			int
		
		
			A name for the right box.
			rightBoxName
			true
			true
		
		
			A list of key value pairs for the right box.
			rightList
			true
			true
			java.util.List
		
		
			A function to be called on a change in selection in the right list.
			rightOnChange
			false
			true
		
		
			Whether the right list can be reordered. The default value is false]]>.
			rightReorder
			false
			true
			boolean
		
		
			A title to display at the top of the right box.
			rightTitle
			true
			true
		
	
	
		input-permissions
		com.liferay.taglib.ui.InputPermissionsTag
		JSP
		
			formName
			false
			true
		
		
			modelName
			true
			true
		
		
			reverse
			false
			true
			boolean
		
		
			showAllRoles
			false
			true
			boolean
		
	
	
		input-permissions-params
		com.liferay.taglib.ui.InputPermissionsParamsTag
		JSP
		
			modelName
			true
			true
		
	
	
		Creates an input field for selecting resources such as folders.
		input-resource
		com.liferay.taglib.ui.InputResourceTag
		JSP
		
			A CSS class for styling the component.
			cssClass
			false
			true
		
		
			An ID for the component.
			id
			false
			true
		
		
			A title for the input.
			title
			false
			true
		
		
			A URL for the specified resource.
			url
			true
			true
		
	
	
		Creates a configurable search box.
		input-search
		com.liferay.taglib.ui.InputSearchTag
		JSP
		
			Whether the search field gets focus by default. The default value is false]]>.
			autoFocus
			false
			true
			boolean
		
		
			A text value for the search button's label. The default value is Search]]>.
			buttonLabel
			false
			true
		
		
			A CSS class for styling the component.
			cssClass
			false
			true
		
		
			An ID for the component instance. The default value is displayTerms.KEYWORDS]]>.
			id
			false
			true
		
		
			Deprecated as of 7.4.0, with no direct replacement.
			markupView
			false
			true
		
		
			A name for the search box. The default value is displayTerms.KEYWORDS]]>.
			name
			false
			true
		
		
			Placeholder text for the search field. The default value is the value of the buttonLabel]]> attribute.
			placeholder
			false
			true
		
		
			Whether to show the search button. The default value is true]]>.
			showButton
			false
			true
			boolean
		
		
			A title for the search box.
			title
			false
			true
		
		
			Whether to use a namespace with the search button. The default value is true]]>.
			useNamespace
			false
			true
			boolean
		
	
	
		Creates a time input field that provides a scrollable dropdown list of hours, in intervals designated by the minuteInterval]]> attribute.
		input-time
		com.liferay.taglib.ui.InputTimeTag
		JSP
		
			The name of the AM/PM parameter for the time input. An acceptable value is ampm]]>.
			amPmParam
			true
			true
		
		
			A time to AM or PM. Acceptable values are 0]]> for AM and 1]]> for PM. The default value is 0]]>.
			amPmValue
			false
			true
			int
		
		
			autoComplete
			false
			true
		
		
			A CSS class for styling the component.
			cssClass
			false
			true
		
		
			A date parameter for the time input. An acceptable value is date]]>.
			dateParam
			false
			true
		
		
			A date to associate with the time displayed.
			dateValue
			false
			true
			java.util.Date
		
		
			Whether the input field is disabled.
			disabled
			false
			true
			boolean
		
		
			The name of the hour parameter for the component. An acceptable value is hour]]>.
			hourParam
			true
			true
		
		
			An hour value for the time displayed. The default value is 12]]>.
			hourValue
			false
			true
			int
		
		
			Deprecated as of 7.4.0, with no direct replacement.
			minuteInterval
			false
			true
			int
		
		
			The name of the minute parameter for the component. An acceptable value is minute]]>.
			minuteParam
			true
			true
		
		
			A minute value for the time displayed. The default value is 00]]>.
			minuteValue
			false
			true
			int
		
		
			A name for the time input.
			name
			false
			true
		
		
			The time format for the time displayed. Acceptable values include 24-hour]]> for 24 hour format (i.e., 13:00 for 1:00 PM) , am-pm]]> for 12 hour format (i.e., 1:00 PM and 1:00 AM), and locale]]> for the locale's default time format.
			timeFormat
			false
			true
		
		
			Whether to use a namespace in the tag. The default value is true]]>.
			useNamespace
			false
			true
			boolean
		
	
	
		Creates a configurable timezone drop-down menu.
		input-time-zone
		com.liferay.taglib.ui.InputTimeZoneTag
		JSP
		
			Whether the field gets focus by default.
			autoFocus
			false
			true
			boolean
		
		
			A CSS class for styling the component.
			cssClass
			false
			true
		
		
			Whether to consider daylight savings for the times. The default value is true]]>.
			daylight
			false
			true
			boolean
		
		
			Whether the field is disabled.
			disabled
			false
			true
			boolean
		
		
			A style number corresponding to the time zone. A value of 0]]> displays the time zone's abbreviated name and a value of 1]]> displays its full name, e.g. "Pacific Standard Time." The default value is 0]]>.
			displayStyle
			false
			true
			int
		
		
			A name for the component.
			name
			true
			true
		
		
			Whether the times can be null.
			nullable
			false
			true
			boolean
		
		
			The ID of a time zone to associate with the component. For example, setting the value to PST]]> associates the component with the Pacific Standard Time zone.
			value
			false
			true
		
	
	
		Deprecated as of 7.4.0, replaced by the liferay-site-navigation:language]]> tag.
		language
		com.liferay.taglib.ui.LanguageTag
		JSP
		
			ddmTemplateGroupId
			false
			true
		
		
			ddmTemplateKey
			false
			true
		
		
			displayCurrentLocale
			false
			true
		
		
			formAction
			false
			true
		
		
			formName
			false
			true
		
		
			languageId
			false
			true
		
		
			languageIds
			false
			true
		
		
			name
			false
			true
		
		
			Whether to use a namespace in the tag. The default value is true]]>.
			useNamespace
			false
			true
			boolean
		
	
	
		Deprecated as of 7.4.0, with no direct replacement.
		menu
		com.liferay.taglib.ui.MenuTag
		JSP
		
			menu
			true
			true
		
	
	
		Deprecated as of 7.4.0, with no direct replacement.
		menu-item
		com.liferay.taglib.ui.MenuItemTag
		JSP
		
			menuItem
			true
			true
		
	
	
		Creates a message to display to the user.
		message
		com.liferay.taglib.ui.MessageTag
		JSP
		
			Arguments for the language key, if the language key is configured to recieve arguments.
			arguments
			false
			true
		
		
			Whether to escape the language key value so that it is safe to use in HTML.
			escape
			false
			true
			boolean
		
		
			escapeAttribute
			false
			true
			boolean
		
		
			The name of a language key from which to derive the message to be displayed.
			key
			true
			true
		
		
			Whether to translate the language key value into the user's language. The default value is true]]>.
			localizeKey
			false
			true
			boolean
		
		
			Whether to translate the arguments into the user's language. The default value is true]]>.
			translateArguments
			false
			true
			boolean
		
		
			unicode
			false
			true
			boolean
		
	
	
		Creates a page iterator for paginating through lists of items.
		page-iterator
		com.liferay.taglib.ui.PageIteratorTag
		JSP
		
			Which page of items to display (e.g., first, second, third, etc.).
			cur
			true
			true
			int
		
		
			A variable name to refer to the cur]]> value of the component.
			curParam
			true
			true
		
		
			The number of items to display per page.
			delta
			false
			true
			int
		
		
			Whether the user can choose the number of items displayed per page. The default value is false]]>.
			deltaConfigurable
			false
			true
			boolean
		
		
			A variable name to refer to the delta value of the component.
			deltaParam
			false
			true
		
		
			forcePost
			false
			true
			boolean
		
		
			A name for the form.
			formName
			false
			true
		
		
			An ID for the component instance.
			id
			false
			true
		
		
			JavaScript to be called when the first]]>, previous]]>, next]]>, or last]]> links are clicked if the URL property is not set.
			jsCall
			false
			true
		
		
			Deprecated as of 7.4.0, with no direct replacement.
			markupView
			false
			true
		
		
			A maximum number of pages to iterate through.
			maxPages
			false
			true
			int
		
		
			portletURL
			false
			true
		
		
			A target for the first]]>, previous]]>, next]]>, and last]]> link buttons.
			target
			false
			true
		
		
			The total number of items in the iterator.
			total
			true
			true
			int
		
		
			A type of iterator to display. Options are approximate]]>, article]]>, more]]>, and regular]]>.
			type
			false
			true
		
	
	
		Creates a collapsible panel for housing content. Deprecated as of 7.4.0, replaced by the clay:panel]]> tag.
		panel
		com.liferay.taglib.ui.PanelTag
		JSP
		
			Whether the panel can be collapsed. The default value is true]]>.
			collapsible
			false
			true
			boolean
		
		
			A CSS class for styling the component.
			cssClass
			false
			true
		
		
			A default state for the component. Possible values are open]]> and any string other than open. Any string other than open]]> collapses the panel. The default value is open]]>.
			defaultState
			false
			true
		
		
			Whether the panel is extended. The default value is false]]>.
			extended
			false
			true
			boolean
		
		
			Text to display as a help tool tip on mouse over of the panel's help icon.
			helpMessage
			false
			true
		
		
			An icon to display next to the panel's title. The icon can be specified using the name of one of the Bootstrap icon CSS classes found at http://marcoceppi.github.io/bootstrap-glyphicons/]]>.
			iconCssClass
			false
			true
		
		
			An ID for the component instance.
			id
			false
			true
		
		
			Deprecated as of 7.4.0, with no direct replacement.
			markupView
			false
			true
		
		
			The ID of the component that contains the panel. If a liferay-ui:panel-container]]> is used as the container for the panel, its ID is used as the value for the parentID]]>.
			parentId
			false
			true
		
		
			Whether to remember the component's state and persist it to the database. The default value is false]]>.
			persistState
			false
			true
			boolean
		
		
			A state for the component. Possible values are open]]> and any string other than open. Any string other than open]]> collapses the panel.
			state
			false
			true
		
		
			A title to display at the top of the panel.
			title
			true
			true
		
	
	
		Creates a collapsible container to house liferay-ui:panel]]> components. Deprecated as of 7.4.0, replaced by the clay:panel-group]]> tag.
		panel-container
		com.liferay.taglib.ui.PanelContainerTag
		JSP
		
			Whether only one panel can be shown at a time. As one panel is opened, the others close, creating an accordian effect. The default value is false]]>.
			accordion
			false
			true
			boolean
		
		
			A CSS class for styling the component.
			cssClass
			false
			true
		
		
			Whether to extend the interface with additional styling. The default value is false]]>.
			extended
			false
			true
			boolean
		
		
			An ID for the component instance.
			id
			false
			true
		
		
			Deprecated as of 7.4.0, with no direct replacement.
			markupView
			false
			true
		
		
			Whether to remember the component's state and persist it to the database. The default value is false]]>.
			persistState
			false
			true
			boolean
		
	
	
		param
		com.liferay.taglib.util.ParamTag
		JSP
		
			name
			true
			true
		
		
			value
			true
			true
		
	
	
		quick-access
		com.liferay.taglib.ui.QuickAccessTag
		JSP
		
			contentId
			false
			true
		
	
	
		quick-access-entry
		com.liferay.taglib.ui.QuickAccessEntryTag
		JSP
		
			label
			false
			true
		
		
			onClick
			false
			true
		
		
			url
			false
			true
		
	
	
		Creates a grid for displaying a list of objects and their properties.
		search-container
		com.liferay.taglib.ui.SearchContainerTag
		com.liferay.taglib.ui.SearchContainerTei
		JSP
		
			Whether to use only the empty results message and text styling, and not use the large smiley face animation. The default value is false]]>.
			compactEmptyResultsMessage
			false
			true
			boolean
		
		
			A CSS class for styling the component.
			cssClass
			false
			true
		
		
			A variable for the search container's pagination. Different pagination variables ensure independent pagination when multiple search containers are on a JSP.
			curParam
			false
			true
		
		
			The number of items to show on each search container page.
			delta
			false
			true
			int
		
		
			The delta]]> attribute as configurable by users.
			deltaConfigurable
			false
			true
		
		
			deltaParam
			false
			true
		
		
			displayTerms
			false
			true
		
		
			A message displayed when the search container is empty.
			emptyResultsMessage
			false
			true
		
		
			emptyResultsMessageCssClass
			false
			true
		
		
			headerNames
			false
			true
		
		
			id
			false
			true
		
		
			iteratorURL
			false
			true
		
		
			orderByCol
			false
			true
		
		
			orderByColParam
			false
			true
		
		
			orderByComparator
			false
			true
		
		
			An order type for the columns, either ascending or descending. Values are asc]]> or desc]]>.
			orderByType
			false
			true
		
		
			orderByTypeParam
			false
			true
		
		
			Inserts a checkbox column in the search container. Value must be a RowChecker]]> object.
			rowChecker
			false
			true
		
		
			searchContainer
			false
			true
		
		
			searchTerms
			false
			true
		
		
			summary
			false
			true
		
		
			The total number of objects in the search container.
			total
			false
			true
			int
		
		
			A variable name for the results of the total]]> attribute. The default value is total]]>.
			totalVar
			false
			true
		
		
			A variable name for the SearchContainer]]> object. The default value is searchContainer]]>.
			var
			false
			true
		
		
			
			
			
			
			
			
			
			
			
		
	
	
		Creates a date column in a search container.
		search-container-column-date
		com.liferay.taglib.ui.SearchContainerColumnDateTag
		JSP
		
			A horizontal alignment for the column contents. The default value is left]]>.
			align
			false
			true
		
		
			The number of columns to span. The default value is 1]]>.
			colspan
			false
			true
			int
		
		
			A CSS class for styling the component.
			cssClass
			false
			true
		
		
			A URL for the items in the column.
			href
			false
			true
		
		
			index
			false
			true
		
		
			A name for the column.
			name
			false
			true
		
		
			Whether to set the column as sortable. The default value is false]]>.
			orderable
			false
			true
			boolean
		
		
			An object's property by which to sort the column.
			orderableProperty
			false
			true
		
		
			A property to request from the row object.
			property
			false
			true
		
		
			A user name to be displayed alongside with the time description.
			userName
			false
			true
		
		
			A vertical alignment for the column contents. The default value is middle]]>.
			valign
			false
			true
		
		
			A value for the column.
			value
			false
			true
		
	
	
		Creates a column in a search container for displaying an icon.
		search-container-column-icon
		com.liferay.taglib.ui.SearchContainerColumnIconTag
		JSP
		
			A horizontal alignment for the column contents. The default value is left]]>.
			align
			false
			true
		
		
			The number of columns to span. The default value is 1]]>.
			colspan
			false
			true
			int
		
		
			A CSS class for styling the component.
			cssClass
			false
			true
		
		
			A URL for the items in the column.
			href
			false
			true
		
		
			A workflow status for the item.
			icon
			true
			true
		
		
			index
			false
			true
		
		
			name
			false
			true
		
		
			Whether to automatically check the checkbox for the row when the column is clicked.
			toggleRowChecker
			false
			true
			boolean
		
		
			A vertical alignment for the column contents. The default value is middle]]>.
			valign
			false
			true
		
	
	
		Creates a column in a search container for displaying an image.
		search-container-column-image
		com.liferay.taglib.ui.SearchContainerColumnImageTag
		JSP
		
			A horizontal alignment for the column contents. The default value is left]]>.
			align
			false
			true
		
		
			The number of columns to span. The default value is 1]]>.
			colspan
			false
			true
			int
		
		
			A CSS class for styling the component.
			cssClass
			false
			true
		
		
			A URL for the items in the column.
			href
			false
			true
		
		
			index
			false
			true
		
		
			name
			false
			true
		
		
			The path of the image.
			src
			true
			true
		
		
			Whether to automatically check the checkbox for the row when the column is clicked.
			toggleRowChecker
			false
			true
			boolean
		
		
			A vertical alignment for the column contents. The default value is middle]]>.
			valign
			false
			true
		
	
	
		Creates a column in a search container with the contents of a JSP file.
		search-container-column-jsp
		com.liferay.taglib.ui.SearchContainerColumnJSPTag
		JSP
		
			A horizontal alignment for the column contents. The default value is left]]>.
			align
			false
			true
		
		
			The number of columns to span. The default value is 1]]>.
			colspan
			false
			true
			int
		
		
			A CSS class for styling the component.
			cssClass
			false
			true
		
		
			href
			false
			true
		
		
			index
			false
			true
		
		
			name
			false
			true
		
		
			The JSP file's location.
			path
			true
			true
		
		
			truncate
			false
			true
			boolean
		
		
			A vertical alignment for the column contents. The default value is middle]]>.
			valign
			false
			true
		
	
	
		Creates a column in a search container for the workflow status.
		search-container-column-status
		com.liferay.taglib.ui.SearchContainerColumnStatusTag
		JSP
		
			A horizontal alignment for the column contents. The default value is left]]>.
			align
			false
			true
		
		
			The number of columns to span. The default value is 1]]>.
			colspan
			false
			true
			int
		
		
			A CSS class for styling the component.
			cssClass
			false
			true
		
		
			A URL for the items in the column.
			href
			false
			true
		
		
			index
			false
			true
		
		
			name
			false
			true
		
		
			Whether to set the column as sortable. The default value is false]]>.
			orderable
			false
			true
			boolean
		
		
			An object's property by which to sort the column.
			orderableProperty
			false
			true
		
		
			An object's property to use for the column.
			property
			false
			true
		
		
			A workflow status for the item.
			status
			false
			true
		
		
			statusByUserId
			false
			true
		
		
			statusDate
			false
			true
		
		
			A vertical alignment for the column contents. The default value is middle]]>.
			valign
			false
			true
		
	
	
		Creates a text column in a search container.
		search-container-column-text
		com.liferay.taglib.ui.SearchContainerColumnTextTag
		com.liferay.taglib.ui.SearchContainerColumnTextTei
		JSP
		
			A horizontal alignment for the column contents.
			align
			false
			true
		
		
			A string buffer variable for constructing a URL in a scriptlet.
			buffer
			false
			true
		
		
			The number of columns to span. The default value is 1]]>.
			colspan
			false
			true
			int
		
		
			A CSS class for styling the component.
			cssClass
			false
			true
		
		
			
			helpMessage
			false
			true
		
		
			href
			false
			true
		
		
			index
			false
			true
		
		
			name
			false
			true
		
		
			Whether to set the column as sortable. The default value is false]]>.
			orderable
			false
			true
			boolean
		
		
			An object's property by which to sort the column.
			orderableProperty
			false
			true
		
		
			property
			false
			true
		
		
			target
			false
			true
		
		
			title
			false
			true
		
		
			Whether to automatically translate values. The default value is false]]>.
			translate
			false
			true
			boolean
		
		
			truncate
			false
			true
			boolean
		
		
			A vertical alignment for the column contents. The default value is middle]]>.
			valign
			false
			true
		
		
			value
			false
			true
		
	
	
		search-container-column-user
		com.liferay.taglib.ui.SearchContainerColumnUserTag
		JSP
		
			align
			false
			true
		
		
			colspan
			false
			true
		
		
			cssClass
			false
			true
		
		
			date
			false
			true
		
		
			href
			false
			true
		
		
			index
			false
			true
		
		
			name
			false
			true
		
		
			orderable
			false
			true
		
		
			orderableProperty
			false
			true
		
		
			property
			false
			true
		
		
			showDetails
			false
			true
		
		
			userId
			false
			true
		
		
			valign
			false
			true
		
	
	
		The list of objects to display in the search container.
		search-container-results
		com.liferay.taglib.ui.SearchContainerResultsTag
		com.liferay.taglib.ui.SearchContainerResultsTei
		JSP
		
			calculateStartAndEnd
			false
			true
			boolean
		
		
			A list of objects to display in the search container.
			results
			false
			true
		
		
			A variable to use for the results.
			resultsVar
			false
			true
		
	
	
		Creates rows in the search container for each object returned by liferay-ui:search-container-results]]>.
		search-container-row
		com.liferay.taglib.ui.SearchContainerRowTag
		com.liferay.taglib.ui.SearchContainerRowTei
		JSP
		
			ariaLabel
			false
			true
		
		
			bold
			false
			true
		
		
			The class name of the objects to display in rows.
			className
			true
			true
		
		
			A CSS class for styling the component.
			cssClass
			false
			true
		
		
			The returned model instances as HTML escaped.
			escapedModel
			false
			true
		
		
			A variable name to use for the rows' index.
			indexVar
			false
			true
		
		
			A property to use as the primary key for the object type in the className]]> attribute.
			keyProperty
			false
			true
		
		
			A variable name to use for each object as the search container iterates through the objects returned by liferay-ui:search-container-results]]>.
			modelVar
			false
			true
		
		
			A model property to use as the row ID.
			rowIdProperty
			false
			true
		
		
			A variable name to use for the rows.
			rowVar
			false
			true
		
		
			servletContext
			false
			true
		
		
			A state for the component. Possible values are success]]>, warning]]>, info]]>, default]]>, primary]]>, or danger]]>.
			state
			false
			true
		
		
			stringKey
			false
			true
		
		
			tabIndex
			false
			true
		
	
	
		Creates parameters for rows in the search container. The liferay-ui:search-container-row]]> tag is required.
		search-container-row-parameter
		com.liferay.taglib.ui.SearchContainerRowParameterTag
		JSP
		
			A name for the row parameter.
			name
			true
			true
		
		
			A value for the row parameter.
			value
			true
			true
		
	
	
		search-form
		com.liferay.taglib.ui.SearchFormTag
		JSP
		
			page
			true
			true
		
		
			searchContainer
			false
			true
		
		
			Deprecated as of 7.2.0, with no direct replacement.
			servletContext
			false
			true
		
		
			showAddButton
			false
			true
		
	
	
		Creates a search results page iterator with an optional paginator.
		search-iterator
		com.liferay.taglib.ui.SearchIteratorTag
		JSP
		
			The display style for the component. Options are table]]>, descriptive]]>, or icon]]>.
			displayStyle
			false
			true
		
		
			Whether to fix the table header to the top of page when scrolling. The default value is false]]>.
			fixedHeader
			false
			true
		
		
			Deprecated as of 7.4.0, with no direct replacement.
			markupView
			false
			true
		
		
			Whether to add a liferay-ui:search-paginator]]> to the search container. The default value is true]]>.
			paginate
			false
			true
			boolean
		
		
			resultRowSplitter
			false
			true
		
		
			All configurable properties of the search container, such as cur]]> and curParam]]>. These properties are set with searchContainer.getCur()]]> and searchContainer.getCurParam()]]> respectively.
			searchContainer
			false
			true
		
		
			A CSS class for styling the component.
			searchResultCssClass
			false
			true
		
		
			A type of iterator to display. Options are approximate]]>, article]]>, more]]>, and regular]]>.
			type
			false
			true
		
	
	
		Creates a page iterator to paginate through search results.
		search-paginator
		com.liferay.taglib.ui.SearchPaginatorTag
		JSP
		
			An ID for the component instance.
			id
			false
			true
		
		
			Deprecated as of 7.4.0, with no direct replacement.
			markupView
			false
			true
		
		
			All configurable porperties of the search container, such as cur]]> and curParam]]>. These properties are set with searchContainer.getCur()]]> and searchContainer.getCurParam()]]> respectively.
			searchContainer
			true
			true
		
		
			A type of iterator to display. Options are approximate]]>, article]]>, more]]>, and regular]]>.
			type
			false
			true
		
	
	
		Creates a search instance that can be toggled between basic and advanced search.
		search-toggle
		com.liferay.taglib.ui.SearchToggleTag
		JSP
		
			Whether the search input field is automatically focused. The default value is false]]>.
			autoFocus
			false
			true
			boolean
		
		
			A label for the search button such as Search]]> or Go]]>.
			buttonLabel
			false
			true
		
		
			Terms to be used and displayed through the search instance. Term examples include keywords]]>, advancedSearch]]>, and description]]>.
			displayTerms
			true
			true
		
		
			An ID for the component instance.
			id
			true
			true
		
		
			Deprecated as of 7.4.0, with no direct replacement.
			markupView
			false
			true
		
	
	
		Deprecated as of 7.4.0, replaced by the clay:tabs-panel]]> tag.
		section
		com.liferay.taglib.ui.SectionTag
		com.liferay.taglib.ui.SectionTei
		JSP
		
			data
			false
			true
		
	
	
		Creates a success message to display to the user.
		success
		com.liferay.taglib.ui.SuccessTag
		JSP
		
			embed
			false
			true
			boolean
		
		
			A key to be placed in the SessionMessages]]> object to trigger the success message.
			key
			true
			true
		
		
			Explicit message text or the name of a language key from which to derive the message text.
			message
			false
			true
		
		
			targetNode
			false
			true
		
		
			timeout
			false
			true
		
		
			Whether to translate the success message into the user's language. The default value is true]]>.
			translateMessage
			false
			true
			boolean
		
	
	
		Creates a tabbed UI of section dividers that each house their own content.
Example:
]]>. Deprecated as of 7.4.0, replaced by the clay:tabs]]> tag.
tabs com.liferay.taglib.ui.TabsTag JSP A label for the back URL. backLabel false true A URL for navigating back to. backURL false true A CSS class for styling the component. cssClass false true A name for the tab's form. formName false true The names of the tabs. Each name must be separated by a comma with no spaces. names true true A function to be called on a user clicking any of the tabs. onClick false true A variable for the component. param false true A URL to refer to the portlet that contains the component. portletURL false true Whether the page refreshes when a tab is clicked. refresh false true boolean Tab values that must follow the same order as the names]]> attribute. Each value must be separated by a comma with no spaces. tabsValues false true A design type for the tabs. Possible values are tabs]]>, underline]]>, stacked]]>, justified]]>, dropdown]]> and pills]]>. type false true A URL to which all the tabs are linked when clicked. You can also set each tab's URL individually using url[number]]]> attribute. url false true urls false true An active tab from the value given in the attribute tabsValues]]>. No matter which tab a user selects, the tab given for this value always remains active. value false true
Deprecated as of 7.4.0, replaced by the liferay-user:user-display]]> tag. user-display com.liferay.taglib.ui.UserDisplayTag com.liferay.taglib.ui.UserDisplayTei JSP author false true displayStyle false true imageCssClass false true Deprecated as of 7.4.0, with no direct replacement. markupView false true showLink false true showUserDetails false true showUserName false true url false true userIconCssClass false true userId true true userName false true Deprecated as of 7.4.0, replaced by the liferay-user:user-name-fields]]> tag. user-name-fields com.liferay.taglib.ui.UserNameFieldsTag JSP bean false true contact false true user false true Deprecated as of 7.4.0, replaced by the liferay-user:user-portrait]]> tag. user-portrait com.liferay.taglib.ui.UserPortraitTag JSP cssClass false true imageCssClass false true size false true user false true userId false true userName false true




© 2015 - 2025 Weber Informatics LLC | Privacy Policy