    001// Licensed under the Apache License, Version 2.0 (the "License");
    002// you may not use this file except in compliance with the License.
    003// You may obtain a copy of the License at
    004//
    005// http://www.apache.org/licenses/LICENSE-2.0
    006//
    007// Unless required by applicable law or agreed to in writing, software
    008// distributed under the License is distributed on an "AS IS" BASIS,
    009// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    010// See the License for the specific language governing permissions and
    011// limitations under the License.
    012
    013package org.apache.tapestry5;
    014
    015/**
    016 * Constants for core component parameters defined by {@link org.apache.tapestry5.ioc.annotations.Symbol}
    017 *
    018 * @since 5.3
    019 */
    020public class ComponentParameterConstants
    021{
    022    /**
    023     * The default number for how many rows to display in a
    024     * {@link org.apache.tapestry5.corelib.components.Grid} page.
    025     */
    026    public static final String GRID_ROWS_PER_PAGE = "tapestry.components.grid_rows_per_page";
    027
    028    /**
    029     * The default position of the {@link org.apache.tapestry5.corelib.components.Grid}
    030     * pager.
    031     */
    032    public static final String GRID_PAGER_POSITION = "tapestry.components.grid_pager_position";
    033
    034    /**
    035     * The default name of the {@link org.apache.tapestry5.Block} used to display an empty
    036     * {@link org.apache.tapestry5.corelib.components.Grid}.
    037     */
    038    public static final String GRID_EMPTY_BLOCK = "tapestry.components.grid_empty_block";
    039
    040
    041    /**
    042     * The default name of the CSS class for the &lt;table&gt; element of the
    043     * {@link org.apache.tapestry5.corelib.components.Grid} component.
    044     */
    045    public static final String GRID_TABLE_CSS_CLASS = "tapestry.components.grid_table_css_class";
    046
    047    /**
    048     * The default number of page range to display in the
    049     * {@link org.apache.tapestry5.corelib.components.GridPager} before and after the current page.
    050     */
    051    public static final String GRIDPAGER_PAGE_RANGE = "tapestry.components.gridpager_page_range";
    052
    053    /**
    054     * The default {@link org.apache.tapestry5.Asset} to display in
    055     * {@link org.apache.tapestry5.corelib.components.GridColumns} header for ascending sort action.
    056     */
    057    public static final String GRIDCOLUMNS_ASCENDING_ASSET = "tapestry.components.gridcolumns_ascending_asset";
    058
    059    /**
    060     * The default {@link org.apache.tapestry5.Asset} to display in
    061     * {@link org.apache.tapestry5.corelib.components.GridColumns} header for descending sort action.
    062     */
    063    public static final String GRIDCOLUMNS_DESCENDING_ASSET = "tapestry.components.gridcolumns_descending_asset";
    064
    065    /**
    066     * The default {@link org.apache.tapestry5.Asset} to display in
    067     * {@link org.apache.tapestry5.corelib.components.GridColumns} header for identifying a sortable column.
    068     */
    069    public static final String GRIDCOLUMNS_SORTABLE_ASSET = "tapestry.components.gridcolumns_sortable_asset";
    070
    071    /**
    072     * The default position where to insert content into {@link org.apache.tapestry5.corelib.components.Form}.
    073     * Defaults to "above".
    074     * @deprecated Deprecated in 5.4 with no replacement.
    075     */
    076    public static final String FORMINJECTOR_INSERT_POSITION = "tapestry.components.forminjector_insert_position";
    077
    078    /**
    079     * The default name for a JS function to use to show the injected content by the (removed in 5.4) FormInjector
    080     * component.
    081     *
    082     * Defaults to "highlight".
    083     * @deprecated Deprecated in 5.4 with no replacement.
    084     */
    085    public static final String FORMINJECTOR_SHOW_FUNCTION = "tapestry.components.forminjector_show_function";
    086
    087    /**
    088     * The default size of rows to display in a {@link org.apache.tapestry5.corelib.components.Palette}
    089     * component. Defaults to 10.
    090     */
    091    public static final String PALETTE_ROWS_SIZE = "tapestry.components.palette_rows_size";
    092
    093    /**
    094     * The default for whether components that use a SelectModel (e.g.
    095     * {@link org.apache.tapestry5.corelib.components.Select}) enforce
    096     * that the submitted value is one of the values in the SelectModel
    097     *
    098     * @since 5.4
    099     */
    100    public static final String VALIDATE_WITH_MODEL = "tapestry.components.validate_with_model";
    101
    102    /**
    103     * The default name of a JS function attached to Tapestry.ElementEffect object to use for the initial
    104     * visualization of a {@link org.apache.tapestry5.corelib.components.Zone}.
    105     * Defaults to "show"
    106     *
    107     * @deprecated Deprecated in 5.4 with no replacement.
    108     */
    109    public static final String ZONE_SHOW_METHOD = "tapestry.components.zone_show_method";
    110
    111    /**
    112     * The default name of a JS function attached to Tapestry.ElementEffect object to point out an
    113     * update on a {@link org.apache.tapestry5.corelib.components.Zone}.
    114     * Defaults to "highlight"
    115     *
    116     * @deprecated Deprecated in 5.4 with no replacement.
    117     */
    118    public static final String ZONE_UPDATE_METHOD = "tapestry.components.zone_update_method";
    119}