Value List Handler
Tag root


This tag is required as a root tag for all other vlh tag.

Example

  • <vlh:root id="tableOfBooks" value="list" url="?" includeParameters="bookId|#" >
  • It will forward request param 'bookId' as well. Actions params are excluded automatically for any tableId. ValueListInfo.DO_FOCUS param you cannot forward. It is forbidden.



    Tag Information
    Tag Classnet.mlw.vlh.web.tag.ValueListSpaceTag
    TagExtraInfo ClassNone
    Body ContentJSP
    Display NameNone

    Attributes
    NameRequiredRequest-timeTypeDescription
    valuetruetruejava.lang.String

    The name of the variable containing a ValueList or a List in the given scope.

  • Instancies of List are automatically wrapped by DefaultListBackedValueList with the default ValueListInfo. (Thus information about list is always dropped.)
  • scopefalsetruejava.lang.String

    Specify where to find a variable containng ValueList or a List. Valid options are: request|session|application, the default is request.

    Warning: When you are using ValueListHandlerHelper you should always use request scope!

    idfalsetruejava.lang.String

    If more than one table is included in one request then an id can be assigned to a table. The id is appended to all the parameters. For example if you had a table with an id="(bob)" then the pagging parameter would be ?paggingColumn=firstName(bob)

    When no id is specified, it is used the default id. See javadoc for the class TableInfo.DEFAULT_ID.

    When you are using handler helper ValueListHandlerHelper in your mvc controller, the id is used to build information about a list (ValueListInfo) obtained from request (or from the session, when no info was found in the request). Therefore you need to specify unique id in whole application.

    urltruetruejava.lang.String

    The base url to post back to. All links generated in table start with this url. Only tag action can overide it.

    Example

    <vlh:root id="MyTable" value="list" url="?" includeParameters=" " >

      Here are starting all links with the prefix "?". Thus result is like this:

      <a href="?param1=value1&....&paramN=valueN" >

      <vlh:action url="/delete.html?" >

        Omited other innner parts.

        Here are starting all links with the prefix "/delete.html?". Thus result is like this:

        <a href="/delete.html?param1=value1&....¶mN=valueN" >

      </vlh:action>
    </vlh:root>

    includeParametersfalsetruejava.lang.String

    A pipe delimited list of parameters to include (forward) when encoding every url in table.

    • # - forward only control (like sortColumn, pagingPage, etc.) parameters of others tables in jsp

      Automatically exclude params with the prefix of the ACTION_TEMP_PARAM_PREFIX.

    • $ - forward only parameters of others tables in jsp that stats with prefix ACTION_TEMP_PARAM_PREFIX.
    • partOfParam - forward parameteres that starts with prefix partOfParam.

      Automatically are excluded keys start with

        ACTION_TEMP_PARAM_PREFIX and with
        DO_FOCUS+id of this table.

    • myForwardParameterOne|myForwardParameterTwo - forward parameter from request if the name is as the same as myForwardParameterOne or myForwardParameterTwo

    Example

  • <vlh:root id="tableOfBooks" value="list" url="?" includeParameters="bookId|partOfParam |#" >

  • It will forward request param 'bookId' and all keys start with the prefix 'partOfParam' as well. Actions params are excluded automatically for any tableId.

  • <vlh:root id="tableOfBooks" value="list" url="?" includeParameters=" |$" >

  • It will forward all params request, only one param you cannot forward : ValueListInfo.DO_FOCUS.

    excludeParametersfalsetruejava.lang.StringA pipe delimited list of parameters to exclude when encoding urls. Here you cannot use params like #,$ as the same as in includeParameters
    configNamefalsetruejava.lang.String

    The name of the configuration bean to use. This much reference a net.mlw.vlh.web.ValueListConfigBean bean defined in your spring configuration file.

    Example of the configuration bean

    <bean id="classicLook" singleton="true" class="net.mlw.vlh.web.ValueListConfigBean">
      <property name="displayHelper"><bean class="net.mlw.vlh.web.util.PassThroughDisplayHelper" /></property>
      <property name="linkEncoder"><bean class="net.mlw.vlh.web.tag.support.DefaultLinkEncoder" /></property>
      <property name="messageSource">
        <bean class="org.springframework.context.support.ResourceBundleMessageSource">
          <property name="basename"><value>classicLook</value></property>
        </bean>
      </property>
      <property name="styleCount"><value>8</value></property>
      <property name="stylePrefix"><value>classicLook</value></property>
      <property name="displayProviders">
        <map>
          <entry key="html">
            <bean id="classicLookHtmlDisplayProvider" class="net.mlw.vlh.web.tag.support.HtmlDisplayProvider">
              <property name="imageHome"><value>images</value></property>
            </bean>
          </entry>
        </map>
      </property>
    </bean>


    Variables
    No Variables Defined.


    Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.