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

META-INF.displaytag-el-12.tld Maven / Gradle / Ivy

Go to download

The display tag library is an open source suite of custom tags that provide high-level web presentation patterns which will work in an MVC model. The library provides a significant amount of functionality while still being easy to use.

The newest version!



    1.0
    1.2
    display-el
    http://displaytag.sf.net/el
    Display *: Tag Library (EL)
    
        The display tag library is an open source suite of custom tags that provide high level web presentation patterns
        which will work in a MVC model, and provide a significant amount of functionality while still being simple and
        straight-forward to use. The primary tag in the library is the Table tag.
    
    
        table
        org.displaytag.tags.el.ELTableTag
        JSP
        table
        
            Displays a list in an html table, formatting each item in the list according to the Column tags nested
            inside of this tag. Use the list attribute to indicate the Collection of data, in some scope, that the tag
            should operate on. Supports the export of the list data to alternative formats such as CSV, Excel, and XML.
            The contents of the list can be sorted, and the list can be broken into individual pages for display. If you
            use this tag in Struts, or in some other framework where the page is included via a jsp:include, you should
            use the requestURI attribute to indicate where tag generated links should point.
        
        
            name
            false
            true
            
                reference to the object used as source for the table. Can be an expression like
                requestScope.object.property. In the EL version of the taglibrary this must be an EL expression which
                points to the source object.
            
        
        
            length
            false
            true
            number of records to be shown
        
        
            offset
            false
            true
            index of the first record to be shown
        
        
            pagesize
            false
            true
            number of records in a page
        
        
            decorator
            false
            true
            
                Fully qualified class name for a TableDecorator. Use a TableDecorator to provide custom operations
                against the whole list, such as computing totals. Must extend org.displaytag.decorator.TableDecorator.
            
        
        
            requestURI
            false
            true
            
                When the present, links for sorting, exports, and paging are formed by adding any tag generated
                parameters to the value of requestURI attribute.
            
        
        
            jScriptName
            false
            true
            
                When the present, links for sorting, exports, and paging are formed by adding javascript: jScriptName() and then,
                by calling a jscript function instead of directly request an URI. Useful to manage request or by submit action form.
            
        
        
            useSubmitButton
            false
            true
            
                If set to true, all link except for export function act as submit button. The name of each link
     			contain a special name that begin with button.submit followed by the action method name plus additional
     			parameter to post (ex. button.submit.paging?order=1&page=3).
     			Useful when paging and sorting require form submission and javascript are not permitted.
            
        
        
            requestURIcontext
            false
            true
            
                Enable/disable prepending of application context to generated links. Default is true, you can set it to
                false in order to generate cross-context links.
            
        
        
            excludedParams
            false
            true
            java.lang.String
            
                Whitespace separated list containg the name of parameters which should NOT be forwarded during paging or
                sorting. You can use excludedParams="*" to match (exclude) any parameter.
            
        
        
            width
            false
            true
            
                @deprecated html attribute. Use "style" or "class" to set presentational attributes using css.
            
        
        
            style
            false
            true
            html pass through attribute
        
        
            class
            false
            true
            html pass through attribute
        
        
            styleClass
            false
            true
            @deprecated: use "class"
        
        
            border
            false
            true
            @deprecated html pass through attribute. Use css "border"
        
        
            cellspacing
            false
            true
            html pass through attribute
        
        
            cellpadding
            false
            true
            
                html pass through attribute. Better using "padding" css attribute in style or class
            
        
        
            align
            false
            true
            
                @deprecated html attribute. Use "style" or "class" to set presentational attributes using css.
            
        
        
            background
            false
            true
            
                @deprecated html attribute. Use "style" or "class" to set presentational attributes using css.
            
        
        
            bgcolor
            false
            true
            
                @deprecated html attribute. Use "style" or "class" to set presentational attributes using css.
            
        
        
            frame
            false
            true
            html pass through attribute.
        
        
            height
            false
            true
            
                @deprecated html attribute. Use "style" or "class" to set presentational attributes using css.
            
        
        
            hspace
            false
            true
            
                @deprecated html attribute. Use "style" or "class" to set presentational attributes using css.
            
        
        
            rules
            false
            true
            html pass through attribute.
        
        
            summary
            false
            true
            html pass through attribute
        
        
            htmlId
            false
            true
            html "id" pass through attribute
        
        
            vspace
            false
            true
            
                @deprecated html attribute. Use "style" or "class" to set presentational attributes using css.
            
        
        
            export
            false
            true
            enable/disable export. Valid values are true or false
        
        
            id
            false
            true
            See "uid".
        
        
            uid
            false
            true
            
                Unique id used to identify this table. The object representing the current row is also added to the
                pageContext under this name, so that you can refer to it in column bodies using ${uid}. You can also use
                uid_rowNum to refer to the current row number. Two tables in the same page can't have the same id
                (paging and sorting will affect both). If no "htmlId" is specified the same value will be used for the
                html id of the generated table.
            
        
        
            sort
            false
            true
            
                Use 'page' if you want to sort only visible records, or 'list' if you want to sort the full list
            
        
        
            defaultsort
            false
            true
            
            
                The index of the column that will be used by default for sorting (starting from 1)
            
        
        
            defaultorder
            false
            true
            
                The default order for the sorted column. Valid values are "ascending" (default) or "descending"
            
        
        
            headerTitle
            false
            true
            
                title html attribute to be added for each column header of the table.
            
        
        
            headerTitleKey
            false
            true
            
                title html attribute resource key to be added for each column header of the table.
            
        
	    
	        configurable
	        false
	        true
	    
        
            requestHelper
            false
            true
        
        
            escapeXml
            false
            true
        
        
            
  <display:column sortable="true" title="ID"> <c:out value="${row.id}"/> </display:column>
  <display:column property="email" autolink="true"/>
  <display:column property="description" title="Comments"/>
</display:table>
]]>
        
    
    
        column
        org.displaytag.tags.el.ELColumnTag
        JSP
        column
        
            Displays a property of a row object inside a table. MUST be nested inside of a Table tag. The value
            displayed will be the results of a decorator (if any); else the property named by the 'property' attribute;
            or if the 'property' attribute is null, then the results of evaluating the JSP body of the tag.
        
        
            property
            false
            true
            
                name of the property in the bean specified in the parent table tag (via the "name" attribute) mapped to
                this column
            
        
        
            sortProperty
            false
            true
            
                name of the property in the bean specified in the parent table tag (via the "name" attribute) which will
                be used to sort values in the column. This can be used when the column body is filled or a decorator is
                used and column should sort on undeorated values.
            
        
        
            title
            false
            true
            title of the column (text for the th cell)
        
        
            titleKey
            false
            true
            
                Resource key used to lookup the title value. Only works if "title" is not defined. Works together with a
                configured I18nResourceProvider, specified via the displaytag.properties file. By default, if JSTL is
                available, the JSTL provider is used, which makes this attribute work the same as fmt:message's key
                property.
            
        
        
            nulls
            false
            true
            
                By default, null values don't appear in the list. By setting 'nulls' to 'true', then null values will
                appear as "null" in the list (mostly useful for debugging). Defaults to 'false'.
            
        
        
            sort
            false
            true
            @deprecated: use "sortable"
        
        
            sortable
            false
            true
            Set to 'true' to make the column sortable. Defaults to 'false'.
        
        
            autolink
            false
            true
            
                Automatically hyperlink URLs and email addresses that appear in the column. Defaults to 'false'.
            
        
        
            media
            false
            true
            
                Render the column for the media type(s). The column won't be added to the table if the current request
                media is not supported. Can be any space separated combination of 'html', 'csv', 'xml', 'all', or
                'excel'. Defaults to 'all'.
            
        
        
            href
            false
            true
            
                The base URL used to construct the dynamic link. If this attribute is provided, then the data that is
                shown for this column is wrapped inside a <a href> tag with the url provided through this
                attribute. Typically you would use this attribute along with one of the struts-like param attributes
                (param*) to create a dynamic link so that each row creates a different URL based on the data that is
                being viewed. An empty href value will generate a link to the current page, preserving parameters just
                like for paging links.
            
        
        
            url
            false
            true
            
                The base URL used to construct the dynamic link. This attribute has the same functionality as the href
                attribute, but it pre-pends the contextPath.
            
        
        
            paramId
            false
            true
            
                The name of the request parameter that will be dynamically added to the generated href URL. The
                corresponding value is defined by the perty and (optional) paramName attributes, optionally scoped by
                the paramScope attribute.
            
        
        
            paramName
            false
            true
            
                The name of a JSP bean that is a String containing the value for the request parameter named by paramId
                (if paramProperty is not specified), or a JSP bean whose property getter is called to return a String
                (if paramProperty is specified). The JSP bean is constrained to the bean scope specified by the
                paramScope property, if it is specified. If paramName is omitted, then it is assumed that the current
                object being iterated on is the target bean.
            
        
        
            paramProperty
            false
            true
            
                The name of a property of the current object being iterated on, whose return value will be used as the
                value of the parameter (named by the paramId attribute) that will be dynamically added to this href URL.
                If paramName is also specified the property will not be fetched from the object being iterated on, but
                from the bean specified by paramName. The support of paramProperty in conjunction with paramName will be
                probably removed in future: use paramProperty only if you need a property in the iterated object,
                elsewhere use only paramName (you can select a property using an expression name.property).
            
        
        
            paramScope
            false
            true
            
                @deprecated - use Expressions in paramName. The scope within which to search for the bean specified by
                the paramName attribute. If not specified, all scopes are searched. If paramName is not provided, then
                the current object being iterated on is assumed to be the target bean.
            
        
        
            maxLength
            false
            true
            
                If this attribute is provided, then the column's displayed is limited to this number of characters. An
                elipse (...) is appended to the end if this column is linked, and the user can mouseover the elipse to
                get the full text. Be careful on using this attribute for String which can contain html tags or
                entities, or together with the autolink attribute turned on: displaytag will do its best trying to avoid
                leaving unclosed tags or broken entities in the output, but a complex or bad input could lead to
                unattended results.
            
        
        
            maxWords
            false
            true
            
                If this attribute is provided, then the column's displayed is limited to this number of words. An elipse
                (...) is appended to the end if this column is linked, and the user can mouseover the elipse to get the
                full text. Be careful on using this attribute for String which can contain html tags or entities, or
                together with the autolink attribute turned on: displaytag will do its best trying to avoid leaving
                unclosed tags or broken entities in the output, but a complex or bad input could lead to unattended
                results.
            
        
        
            width
            false
            true
            
                @deprecated; html attribute. Use "style" or "class" to set presentational attributes using css.
            
        
        
            class
            false
            true
            
                html pass through attribute; use this instead of directly coding presentational atttributes.
            
        
        
            styleClass
            false
            true
            @deprecated: use "class"
        
        
            headerClass
            false
            true
            "class" html attribute added only for header cells.
        
        
            headerStyleClass
            false
            true
            @deprecated: use "headerClass"
        
        
            style
            false
            true
            html pass through attribute.
        
        
            align
            false
            true
            
                @deprecated html attribute. Use "style" or "class" to set presentational attributes using css.
            
        
        
            background
            false
            true
            
                @deprecated html attribute. Use "style" or "class" to set presentational attributes using css.
            
        
        
            bgcolor
            false
            true
            
                @deprecated html attribute. Use "style" or "class" to set presentational attributes using css.
            
        
        
            height
            false
            true
            
                @deprecated html attribute. Use "style" or "class" to set presentational attributes using css.
            
        
        
            nowrap
            false
            true
            
                @deprecated html attribute. Use "style" or "class" to set presentational attributes using css.
            
        
        
            valign
            false
            true
            
                @deprecated html attribute. Use "style" or "class" to set presentational attributes using css.
            
        
        
            group
            false
            true
            
                The grouping level (starting at 1 and incrementing) of this column (indicates if successive contain the
                same values, then they should not be displayed). The level indicates that if a lower level no longer
                matches, then the matching for this higher level should start over as well. If this attribute is not
                included, then no grouping is performed.
            
        
        
            decorator
            false
            true
            
                The fully qualified class name of a class that should be used to "decorate" the underlying object being
                displayed. The class should implement org.displaytag.decorator.ColumnDecorator. If a decorator is
                specified for the entire table, then this decorator will decorate that decorator.
            
        
        
            totaled
            false
            true
            
                Is the column part of a total.
            
        
        
            importable
            false
            true
            
                Is the column importable from excel.
            
        
        
            showIfAuthorizedFor
            false
            true
            
                Show the column if the user is authorized for specified link
            
        
        
            showIf
            false
            true
            
                Show the column if the condition is true
            
        
        
            escapeXml
            false
            true
            
                true to escape special xml tags in the output
            
        
    
    
        setProperty
        org.displaytag.tags.el.ELSetPropertyTag
        JSP
        setProperty
        
            Sets the indicated property on the enclosing Table tag. MUST be nested within a Table tag. As an
            alternative, you may create a property file that holds sitewide defaults; see the configuration
            documentation or the DisplayPropertiesLoaderServlet javadoc for information.
        
        
            name
            true
            true
            The name of the property to set on the enclosing Table tag.
        
        
            value
            false
            true
            
                The value to which the property is set. You can also set the property value in the tag body.
            
        
        
            
or
bottom
]]>
        
    
    
        footer
        org.displaytag.tags.TableFooterTag
        JSP
        footer
        
            Tag wich should be nested into a table tag to provide a custom table footer. The body of the tag is
            outputted as is in the generated table in the tfoot section.
        
        
            
  
  
  
  	
  		total:
  		
  	
  

]]>
        
    
    
        caption
        org.displaytag.tags.el.ELCaptionTag
        JSP
        caption
        
            Simple tag which mimics the html caption tag. Use it inside a table tag to display a caption.
        
        
            style
            false
            true
            html pass through attribute.
        
        
            class
            false
            true
            html pass through attribute.
        
        
            id
            false
            true
            html pass through attribute.
        
        
            title
            false
            true
            html pass through attribute.
        
        
            lang
            false
            true
            html pass through attribute.
        
        
            dir
            false
            true
            html pass through attribute.
        
        
            
  
  
  This is the table caption

]]>
        
    




© 2015 - 2025 Weber Informatics LLC | Privacy Policy