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