Update of 
/cvsroot/xdoclet-plugins/xdoclet-plugins/plugin-tapestry/src/main/java/org/xdoclet/plugin/tapestry/qtags
In directory 
sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv1248/xdoclet-plugins/plugin-tapestry/src/main/java/org/xdoclet/plugin/tapestry/qtags

Modified Files:
        TapestryForeachTag.java 
Added Files:
        ContribTableColumnsTag.java ContribTableFormPagesTag.java 
        ContribTableRowsTag.java ContribTableValuesTag.java 
        ContribTableViewTag.java 
Log Message:
Added a bunch of contrib components

--- NEW FILE: ContribTableViewTag.java ---
/*
 * Copyright (c) 2003-2005
 * XDoclet Team
 * All rights reserved.
 */
package org.xdoclet.plugin.tapestry.qtags;

/**
 * The main lower-level Table component.
 * This component should wrap all other lower-level Table components such as 
 * TablePages and TableRows, as it provides the data they use.
 *
 * @qtags.location class
 * @author Paolo Dona
 */
public interface ContribTableViewTag extends 
com.thoughtworks.qdox.model.DocletTag {
    /**
     * The id of the component
     * @qtags.required
     */
    String getId();

    /**
     * The model describing the data to be presented by the table components.
     * This parameter is optional, but either the 'tableModel' or both
     * 'source' and 'columns' parameters must be provided.
     */
    String getTableModel();

    /**
     * The data to be displayed by the component. This parameter is available as
     * an alternative to tableModel and must be used in combination with the
     * 'columns' parameter. 
     * The parameter must be an array of values, a collection, an iterator, 
     * or an object implementing the IBasicTableModel interface.
     */
    String getSource();
    
    /**
     * The table columns to be displayed. 
     * The parameter must be an array, a list, or an Iterator of ITableColumn 
objects,
     * an ITableColumnModel, or a String describing the columns (see 
documentation).
     */
    String getColumns();
    
    /**
     * The number of records displayed per page when source/columns are used.
     * The page size is 10 by default.
     */
    String getPageSize();
    
    /**
     * The initial page to be displayed.
     * This is the first page by default.
     */
    String getInitialPage();
    
    /**
     * The id of the column to initially sort the table by.
     * The column is set to null by default, i.e. there is no sorting.
     */
    String getInitialSortColumn();
   
    /**
     * The order of the initial sorting.
     * Set this parameter to 'false' to sort in an ascending order
     * and to 'true' to sort in a descending one.
     */
    String getInitialSortOrder();

    
    /**
     * The manager defining what part of the table model will be stored in 
     * the session.
     */
    String getTableSessionStateManager();
    
    /**
     * The manager defining where the session data will be stored.
     */
    String getTableSessionStoreManager();
    
    /**
     * Defines how the table state (paging and sorting) will be persisted
     * if no tableSessionStoreManager is defined.
     * The possible values are 'session' (the default), 'client', 
'client:page', 
     * and 'client:app'.
     */
    String getPersist();
    
     /**
     * The tag with which the component will be inserted in the generated 
content.
     */
    String getElement();
    
    /**
     * The component where Block and messages are pulled from when using 
source/columns.
     */
    String getColumnSettingsContainer();
}
--- NEW FILE: ContribTableFormPagesTag.java ---
/**
 * Copyright (c) 2003-2005
 * XDoclet Team
 * All rights reserved.
 */
package org.xdoclet.plugin.tapestry.qtags;

/**
 * A version of TablePages that is designed for operation in a form.
 * It is a low level Table component that renders the pages in the table.
 * This component must be wrapped by TableView.
 * 
 *
 * @qtags.location class
 * @author Paolo Dona
 */
public interface ContribTableFormPagesTag extends 
com.thoughtworks.qdox.model.DocletTag {
    /**
     * The id of the component
     * @qtags.required
     */
    String getId();

    /**
     *  Determines the maximum number of pages to be displayed in the page list 
when the table has more than one page.
     * 
     */
    String getPagesDisplayed();

}

--- NEW FILE: ContribTableRowsTag.java ---
/**
 * Copyright (c) 2003-2005
 * XDoclet Team
 * All rights reserved.
 */
package org.xdoclet.plugin.tapestry.qtags;

/**
 * A low level Table component that generates the rows of the current page in 
the table.
 * This component must be wrapped by TableView.
 * 
 *
 * @qtags.location class
 * @author Paolo Dona
 */
public interface ContribTableRowsTag extends 
com.thoughtworks.qdox.model.DocletTag {
    /**
     * The id of the component
     * @qtags.required
     */
    String getId();

    /**
     * The current row being rendered.
     *
     */
    String getRow();

    /**
     *  If provided, the parameter is updated with the index of the loop on 
each iteration.
     * 
     */
    String getIndex();

    /**
     * The tag to use to wrap the rows in, 'tr' by default.
     *
     */
    String getElement();

    /**
     *  Only active in a form.
     * An OGNL expression that returns the primary key of the iterated value.
     * The primary keys are stored in hidden fields during rendering and are 
loaded from the form during a rewind to ensure that the iterations remain the 
same.
     * This is a simpler, but a less efficient alternative of the 'converter' 
parameter.
     * If needed, please use in conjuction with 'fullSource' to reference 
objects not currently present in 'source'.
     * Also, use the 'defaultValue' parameter to define the object to be 
returned if a value corresponding to a particular primary key cannot be found.
     * 
     */
    String getKeyExpression();

    /**
     *  Only active in a form and in combination with the 'keyExpression' 
parameter.
     * If an object corresponding to a primary key stored in the form cannot be 
found in the 'source' parameter, then the objects provided by this parameter 
are searched for a match next.
     * 
     */
    String getFullSource();

    /**
     *  Only active in a form.
     * The value to be used when no match for a given primary key is found.
     * 
     */
    String getDefaultValue();

    /**
     *  Only active in a form.
     * Defines how the items iterated upon will be stored in the form as hidden 
values and how the stored information will be converted back to objects.
     * This interface allows only the primary key of the items to be stored, 
rather than the whole item.
     * 
     */
    String getConverter();

    /**
     *  Only active in a form.
     * If provided, the parameter is automatically updated before a rewind with 
the list of primary keys stored in the form.
     * The parameter is updated right before the iterations begin in a rewind 
and could be used to preload the relevant objects in a provided 'converter'.
     * 
     */
    String getPrimaryKeys();

    /**
     *  Only active in a form.
     * Determines whether to avoid creating hidden fields within a form.
     * Using this parameter may make the form structure different during render 
and rewind, and cause exceptions as a result.
     * Please use with caution.
     * 
     */
    String getVolatile();

}

Index: TapestryForeachTag.java
===================================================================
RCS file: 
/cvsroot/xdoclet-plugins/xdoclet-plugins/plugin-tapestry/src/main/java/org/xdoclet/plugin/tapestry/qtags/TapestryForeachTag.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** TapestryForeachTag.java     19 Oct 2005 08:08:40 -0000      1.3
--- TapestryForeachTag.java     26 Oct 2005 14:33:17 -0000      1.4
***************
*** 9,13 ****
   * Loops over a collection of source values.
   * May also emulate an element (like an Any component).
!  * It's deprecated please use the <b>tapestry.for<b/> tag.
   *
   * @qtags.location class
--- 9,13 ----
   * Loops over a collection of source values.
   * May also emulate an element (like an Any component).
!  * It's deprecated please use the <b>tapestry.for</b> tag.
   *
   * @qtags.location class

--- NEW FILE: ContribTableColumnsTag.java ---
/**
 * Copyright (c) 2003-2005
 * XDoclet Team
 * All rights reserved.
 */
package org.xdoclet.plugin.tapestry.qtags;

/**
 * A low level Table component that renders the column headers in the table.
 * This component must be wrapped by TableView.
 * 
 *
 * @qtags.location class
 * @author Paolo Dona
 */
public interface ContribTableColumnsTag extends 
com.thoughtworks.qdox.model.DocletTag {
    /**
     * The id of the component
     * @qtags.required
     */
    String getId();

    /**
     * The column currently being rendered [out]
     */
    String getColumn();

    /**
     * The tag to use to wrap the column headers.
     *
     */
    String getElement();

    /**
     * The image to use to describe a column sorted in an ascending order.
     *
     */
    String getArrowUpAsset();

    /**
     * The image to use to describe a column sorted in a descending order.
     *
     */
    String getArrowDownAsset();

    /**
     * The CSS class of the table columns
     */
    String getClass_();

}

--- NEW FILE: ContribTableValuesTag.java ---
/**
 * Copyright (c) 2003-2005
 * XDoclet Team
 * All rights reserved.
 */
package org.xdoclet.plugin.tapestry.qtags;

/**
 * A low level Table component that generates the columns for the current row 
in the table.
 * This component must be wrapped by TableRows.
 * 
 *
 * @qtags.location class
 * @author Paolo Dona
 */
public interface ContribTableValuesTag extends 
com.thoughtworks.qdox.model.DocletTag {
    /**
     * The id of the component
     * @qtags.required
     */
    String getId();

    /**
     * The current column being rendered
     */
    String getColumn();

    /**
     * The tag to use to wrap the values in, 'td' by default.
     *
     */
    String getElement();

    /**
     * The CSS class of the table values
     */
    String getClass_();

}



-------------------------------------------------------
This SF.Net email is sponsored by the JBoss Inc.
Get Certified Today * Register for a JBoss Training Course
Free Certification Exam for All Training Attendees Through End of 2005
Visit http://www.jboss.com/services/certification for more information
_______________________________________________
xdoclet-plugins-commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/xdoclet-plugins-commits

Reply via email to