Skip to content

Commit

Permalink
LRDOCS-1686 - Add documentation for liferay-ui:app-view-entry taglib
Browse files Browse the repository at this point in the history
  • Loading branch information
@brianchandotcom
westonhancock authored and brianchandotcom committed May 2, 2015
1 parent ff8eabf commit 2374be8
Showing 1 changed file with 47 additions and 5 deletions.
52 changes: 47 additions & 5 deletions util-taglib/src/META-INF/liferay-ui.tld
View file
Expand Up @@ -42,180 +42,222 @@
</attribute>
</tag>
<tag>
<description>Creates a UI component for displaying entry items such as images, documents, folders, etc. in a concise but informative manner. Items are displayed in a similar fashion to entries in the file system of most operating systems.</description>
<name>app-view-entry</name>
<tag-class>com.liferay.taglib.ui.AppViewEntryTag</tag-class>
<body-content>empty</body-content>
<attribute>
<description>The path for the action JSP page.</description>
<name>actionJsp</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
<attribute>
<description>The Service Context for the action JSP page.</description>
<name>actionJspServletContext</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
<attribute>
<description>The Java Class Name for any categories added to the entry.</description>
<name>assetCategoryClassName</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
<attribute>
<description>The Java Class Primary Key for any categories added to the entry. This number is a Java long.</description>
<name>assetCategoryClassPK</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
<attribute>
<description>The Java Class Name for any tags added to the entry.</description>
<name>assetTagClassName</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
<attribute>
<description>The Java Class Primary Key for any tags added to the entry. This number is a Java long.</description>
<name>assetTagClassPK</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
<attribute>
<description>The name of the author of the entry.</description>
<name>author</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
<attribute>
<description>The name of the entry type. This is displayed in descriptive view as <![CDATA[<code>Type: classTypeName</code>]]>.</description>
<name>classTypeName</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
<attribute>
<description>The date the entry was first created.</description>
<name>createDate</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
<attribute>
<description>A CSS class for styling this component.</description>
<name>cssClass</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
<attribute>
<description>The data attributes and values to be applied to the component wrapper div.</description>
<name>data</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<type>java.util.Map</type>
</attribute>
<attribute>
<description>A description of the entry.</description>
<name>description</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
<attribute>
<description>The date to display the entry.</description>
<name>displayDate</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
<attribute>
<description>The display style of the component. Options are <![CDATA[<code>list</code>]]>, <![CDATA[<code>icon</code>]]>, and <![CDATA[<code>descriptive</code>]]>.</description>
<name>displayStyle</name>
<required>true</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
<attribute>
<description>The date the entry will expire and be automatically deleted.</description>
<name>expirationDate</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
<attribute>
<description>Whether the entry is a folder or not. The default is <![CDATA[<code>false</code>]]>.</description>
<name>folder</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<type>boolean</type>
</attribute>
<attribute>
<description>The group id number of the entry. This is a Java long.</description>
<name>groupId</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
<attribute>
<description>The class that sets the icon to be displayed next to the entry title. The icon also acts as a link to view the entry.</description>
<name>iconCssClass</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
<attribute>
<description>The version number of the most recently published copy of the entry.</description>
<name>latestApprovedVersion</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
<attribute>
<description>The author of the most recently published version of the entry.</description>
<name>latestApprovedVersionAuthor</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
<attribute>
<description>Whether the entry is locked. The default value is <![CDATA[<code>false</code>]]>.</description>
<name>locked</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
<attribute>
<description>The date of the most recent modification to the entry.</description>
<name>modifiedDate</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
<attribute>
<description>The date the entry was reviewed.</description>
<name>reviewDate</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
<attribute>
<description>The checkbox input ID to be used for the entry row checker. This number is a Java long.</description>
<name>rowCheckerId</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
<attribute>
<description>The name to be used as for entry row checker.</description>
<name>rowCheckerName</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
<attribute>
<description>Whether to show a shortcut icon link to the entry.</description>
<name>shortcut</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<type>boolean</type>
</attribute>
<attribute>
<description>Whether the entry is selectable or not. An actual checkbox is used when the display style is <![CDATA[<code>icon</code>]]> or <![CDATA[<code>descriptive</code>]]>.</description>
<name>showCheckbox</name>
<required>true</required>
<rtexprvalue>true</rtexprvalue>
<type>boolean</type>
</attribute>
<attribute>
<description>Whether to show the Link Title. The default value is <![CDATA[<code>true</code>]]>.</description>
<name>showLinkTitle</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<type>boolean</type>
</attribute>
<attribute>
<description>The current status of the entry as represented by an integer. Options are <![CDATA[<code>-1: STATUS_ANY</code>]]>, <![CDATA[<code>0: STATUS_APPROVED</code>]]>, <![CDATA[<code>1: ACTION_PUBLISH</code>]]>, <![CDATA[<code>2: STATUS_DRAFT</code>]]>, and <![CDATA[<code>4: STATUS_DENIED</code>]]>.</description>
<name>status</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
<type>int</type>
</attribute>
<attribute>
<description>CSS styles to be applied to the div containing the thumbnail for the entry.</description>
<name>thumbnailDivStyle</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
<attribute>
<description>The source url for the entry thumbnail image.</description>
<name>thumbnailSrc</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
<attribute>
<description>CSS styles to be applied to the thumbnail for the entry.</description>
<name>thumbnailStyle</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
<attribute>
<description>The title of the entry.</description>
<name>title</name>
<required>true</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
<attribute>
<name>classTypeName</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
<attribute>
<description>The URL used to view the full entry.</description>
<name>url</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
<attribute>
<description>The current version of the entry.</description>
<name>version</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
Expand Down

0 comments on commit 2374be8

Please sign in to comment.