Components

This page displays the component reference of the library.

accordion
accordionitem
ajaxloader
authorize
border
colorpicker
gmap
gmapmarker
gmappolypoint
hideablepanel
listsorter
menu
menubar
menuitem
securepassword
slider
slideshow
slideshowitem
submenu
tab
tabview
tooltip
verticalmenu
verticalmenuitem


accordion

NameDescriptionTypeRequiredDefault value
eventType*Specify the event to use for switching an item from a step to an other.
Allow null : false
Default prefix : literal
fr.exanpe.t5.lib.constants.AccordionEventTypeEnumtrueclick
durationThe duration in seconds of the animation during the accordion opening/closing
Allow null : true
Default prefix : literal
floatfalse1.0
multipleSpecify if a multiple items car be opened simultaneously
Allow null : true
Default prefix : literal
booleanfalsetrue
titleThe title of the accordion. If set, display a header with this title.
Allow null : true
Default prefix : message
java.lang.Stringfalse

accordionitem

NameDescriptionTypeRequiredDefault value
contentThe content of the item. May be initialized through a resource file.
Allow null : true
Default prefix : message
java.lang.Stringfalse
openedThe default state of the item.
Allow null : true
Default prefix : literal
java.lang.Booleanfalsefalse
titleThe title of the item. May be initialized through a resource file.
Allow null : true
Default prefix : message
java.lang.Stringfalse

ajaxloader

NameDescriptionTypeRequiredDefault value
width*The width of the panel, in pixel.
Allow null : true
Default prefix : literal
inttrue150
autoLoadDecide if auto load the content on dom ready.
Allow null : true
Default prefix : literal
java.lang.Booleanfalsetrue
highlightDecide to highlight the result at the end of the loading, or not.
Allow null : true
Default prefix : literal
java.lang.Booleanfalsefalse
imageImage displayed during loading.
Allow null : true
Default prefix : asset
org.apache.tapestry5.Assetfalseimg/ajaxloader/ajax-loader.gif
messageMessage displayed to the user during asynchronous loading.
Allow null : true
Default prefix : message
java.lang.Stringfalseexanpe-ajaxloader-default-message
showPanelDecide to show the panel during the ajax load, or not.
Allow null : true
Default prefix : literal
java.lang.Booleanfalsetrue

authorize

NameDescriptionTypeRequiredDefault value
allComma separated role values All of these roles are required to allow rendering
Allow null : true
Default prefix : literal
java.lang.Stringfalse
anyComma separated role values Any of these roles are required to allow rendering
Allow null : true
Default prefix : literal
java.lang.Stringfalse
blockBlock to render authorization. If not provided, the body of the component is rendered.
Allow null : true
Default prefix : prop
org.apache.tapestry5.Blockfalse
notComma separated role values None of these roles are required to allow rendering (if one is present in the session, no rendering)
Allow null : true
Default prefix : literal
java.lang.Stringfalse

border

NameDescriptionTypeRequiredDefault value

colorpicker

NameDescriptionTypeRequiredDefault value
closeText*Define the text to close the component.
Allow null : false
Default prefix : message
java.lang.Stringtrueliteral:Close
iconDefine the icon to open the color picker.
Allow null : true
Default prefix : asset
org.apache.tapestry5.Assetfalseimg/cpk/color_wheel.png
valueDefine the name of the value to set the color in the container.
Allow null : true
Default prefix : prop
java.lang.Stringfalse

gmap

NameDescriptionTypeRequiredDefault value
latitude*Initial latitude used to center the map.
Allow null : false
Default prefix : literal
java.lang.Stringtrue
longitude*Initial longitude used to center the map.
Allow null : false
Default prefix : literal
java.lang.Stringtrue
draggableIf false, prevents the map from being dragged. Default value is true.
Allow null : true
Default prefix : literal
java.lang.Booleanfalsetrue
mapTypeSpecify the type of map you want to display. Default is ROADMAP.
Allow null : false
Default prefix : literal
fr.exanpe.t5.lib.constants.GMapTypeEnumfalseROADMAP
polyStrokeColorUsed with fr.exanpe.t5.lib.components.GMapPolyPoint component in order to specify the hexadecimal HTML color of a line. Default is black (#000);
Allow null : true
Default prefix : literal
java.lang.Stringfalse#000
polyStrokeOpacityUsed with fr.exanpe.t5.lib.components.GMapPolyPoint component in order to specify numerical fractional value between 0.0 and 1.0 of the opacity of the line's color. Default is 1.0
Allow null : true
Default prefix : literal
floatfalse1.0
polyStrokeWeightUsed with fr.exanpe.t5.lib.components.GMapPolyPoint component in order to specify the weight of the line's stroke in pixels. Default is 3.
Allow null : true
Default prefix : literal
java.lang.Integerfalse3
polygonUsed with fr.exanpe.t5.lib.components.GMapPolyPoint component in order to draw a Javascript GMap Polygon instead of a Polyline. Default is false.
Allow null : true
Default prefix : literal
java.lang.Booleanfalsefalse
secureLoading Google Maps API over HTTPS or not. Default is false.
Allow null : true
Default prefix : literal
java.lang.Booleanfalsefalse
sidebarIf true, displays a side bar with marker links. Default is false.
Allow null : true
Default prefix : literal
java.lang.Booleanfalsefalse
zoomInitial Map zoom level
Allow null : false
Default prefix : literal
java.lang.Integerfalse15

gmapmarker

NameDescriptionTypeRequiredDefault value
latitude*The latitude position of the marker
Allow null : false
Default prefix : literal
java.lang.Stringtrue
longitude*The longitude position of the marker
Allow null : false
Default prefix : literal
java.lang.Stringtrue
iconSpecify the icon of the item
Allow null : true
Default prefix : asset
org.apache.tapestry5.Assetfalse
infoInfo text of the item
Allow null : true
Default prefix : literal
java.lang.Stringfalse
titleSpecify the title of the item
Allow null : true
Default prefix : message
java.lang.Stringfalse

gmappolypoint

NameDescriptionTypeRequiredDefault value
latitude*The latitude position of the point
Allow null : false
Default prefix : literal
java.lang.Stringtrue
longitude*The longitude position of the point
Allow null : false
Default prefix : literal
java.lang.Stringtrue

hideablepanel

NameDescriptionTypeRequiredDefault value
duration*Duration of show
Allow null : true
Default prefix : literal
floattrue1.0
hideWidth*Width in pixel for the hideable panel
Allow null : true
Default prefix : literal
inttrue
hideable*Bloc hideable, disposed on left
Allow null : true
Default prefix : literal
org.apache.tapestry5.Blocktrue
visible*Bloc always visible, on right
Allow null : true
Default prefix : literal
org.apache.tapestry5.Blocktrue
hideImgImage displayed to hide the panel
Allow null : true
Default prefix : asset
org.apache.tapestry5.Assetfalseimg/hdp/hide.png
showImgImage displayed to show the panel
Allow null : true
Default prefix : asset
org.apache.tapestry5.Assetfalseimg/hdp/show.png

listsorter

NameDescriptionTypeRequiredDefault value
source*Source list parameter.
Allow null : false
Default prefix : prop
java.util.Listtrue
useDefaultSkin*Whether to use a default skin for the list sorter. True by default. Turn to false to design each element your own way.
Allow null : true
Default prefix : literal
booleantruetrue
value*Value to iterate over. Mainly used to bind to a property of the page, then design the list content.
Allow null : true
Default prefix : prop
java.lang.Objecttrue

menu

NameDescriptionTypeRequiredDefault value
targetHtmlIdDefines an HTML id where the menu should be opened next to. The top left corner of the menu will be bound to the bottom right html element provided.
Allow null : true
Default prefix : literal
java.lang.Stringfalse

menubar

NameDescriptionTypeRequiredDefault value
eventType*Defines the event triggering the menu.
Allow null : false
Default prefix : literal
fr.exanpe.t5.lib.constants.MenuEventTypeEnumtruehover

menuitem

NameDescriptionTypeRequiredDefault value
disabledSpecify the disabled state of the item.
Allow null : false
Default prefix : prop
java.lang.Booleanfalsefalse
labelSpecify the label of the item.
Allow null : true
Default prefix : message
java.lang.Stringfalse
visibleSpecify the rendered state of the item.
Allow null : false
Default prefix : prop
java.lang.Booleanfalsetrue

securepassword

NameDescriptionTypeRequiredDefault value
characters*Defines the set of characters to display in the password grid.
Allow null : false
Default prefix : literal
java.lang.Stringtrue0123456789
eventType*Defines the event triggering the number.
Allow null : false
Default prefix : literal
fr.exanpe.t5.lib.constants.SecurePasswordEventTypeEnumtrueclick
gridHeight*Defines the height of the grid where are randomly positioned the numbers (row number).
Allow null : false
Default prefix : literal
inttrue4
gridWidth*Defines the width of the grid where are randomly positioned the numbers (column number).
Allow null : false
Default prefix : literal
inttrue4
resetImage*Defines the asset displayed to clear the password field.
Allow null : false
Default prefix : asset
org.apache.tapestry5.Assettrueimg/spwd/reset.png
maxlengthDefines the max length of the input password field.
Allow null : true
Default prefix : literal
java.lang.Integerfalse
valueDefined the name of the value to set the password in the page.
Allow null : true
Default prefix : prop
java.lang.Stringfalse

slider

NameDescriptionTypeRequiredDefault value
max*Maximum value
Allow null : false
Default prefix : literal
java.lang.Floattrue100
min*Minimum value
Allow null : false
Default prefix : literal
java.lang.Floattrue0
orientation*Specify the orientation of the slider
Allow null : false
Default prefix : literal
fr.exanpe.t5.lib.constants.SliderOrientationTypeEnumtruehorizontal
value*Value to read or update
Allow null : true
Default prefix : prop
java.lang.Objecttrue
ajaxDecide if the update is made in Ajax mode, or not
Allow null : true
Default prefix : literal
java.lang.Booleanfalsefalse
displayCurrentValueDisplay the current value or not
Allow null : true
Default prefix : literal
java.lang.Booleanfalsetrue
displayIdIf displayCurrentValue=true, specify a default html element id to display the value into. By default, display into a span just upside of the slider.
Allow null : false
Default prefix : literal
java.lang.Stringfalse
horizontalCursorImage used for horizontal cursor
Allow null : true
Default prefix : asset
org.apache.tapestry5.Assetfalseimg/slider/thumb-n.gif
intervalOptional parameter for the interval : used to set the unit on the slider move. For example, an interval of 10 force the selection value from ten to ten.
Allow null : true
Default prefix : literal
java.lang.Floatfalse1
verticalCursorImage used for vertical cursor
Allow null : true
Default prefix : asset
org.apache.tapestry5.Assetfalseimg/slider/thumb-e.gif
zoneUse with ajax parameter to allow update a zone element
Allow null : true
Default prefix : literal
java.lang.Stringfalse

slideshow

NameDescriptionTypeRequiredDefault value
autoPlayMillis*Defines the auto play behavior of the component by setting a milliseconds interval. 0 means no autoplay.
Allow null : true
Default prefix : prop
inttrue0
itemHeight*Defines the height, in pixels, of items in the slideShow
Allow null : true
Default prefix : prop
inttrue
numVisible*Defines the number of visible elements in this slide show.
Allow null : true
Default prefix : prop
inttrue1
circularDefines whether this slide show is circular. Circular means that once displayed, the content goes back to the begining.
Allow null : true
Default prefix : prop
booleanfalsetrue

slideshowitem

NameDescriptionTypeRequiredDefault value
imageImage displayed as part of the item
Allow null : true
Default prefix : asset
org.apache.tapestry5.Assetfalse
titleTitle of the image displayed as part of the item
Allow null : true
Default prefix : message
java.lang.Stringfalse

submenu

NameDescriptionTypeRequiredDefault value

tab

NameDescriptionTypeRequiredDefault value
iconSpecify the icon of the tab
Allow null : true
Default prefix : asset
org.apache.tapestry5.Assetfalse
titleSpecify the title of the tab
Allow null : true
Default prefix : message
java.lang.Stringfalse

tabview

NameDescriptionTypeRequiredDefault value
defaultActiveTabId*Defines the tab active by default.
Allow null : false
Default prefix : literal
java.lang.Stringtrue
loadAllDefines the loading behavior of all hidden tab contents.
Allow null : true
Default prefix : literal
booleanfalsefalse

tooltip

NameDescriptionTypeRequiredDefault value
blockIdThe id of the org.apache.tapestry5.Block used for displaying Tooltip content
Allow null : false
Default prefix : literal
java.lang.Stringfalse
messageMessage used for displaying Tooltip content
Allow null : false
Default prefix : message
java.lang.Stringfalse

verticalmenu

NameDescriptionTypeRequiredDefault value
defaultActiveItem*Defines the default active Menu item
Allow null : false
Default prefix : literal
java.lang.Stringtrue

verticalmenuitem

NameDescriptionTypeRequiredDefault value
iconIcon of the menu
Allow null : true
Default prefix : asset
org.apache.tapestry5.Assetfalse
targetTarget of the menu link (_blank for example)
Allow null : true
Default prefix : literal
java.lang.Stringfalse
titleTitle of the menu
Allow null : true
Default prefix : message
java.lang.Stringfalse

Mixins

dialog

NameDescriptionTypeRequiredDefault value
title The title of the Dialog box
Allow null : true
Default prefix : message
java.lang.String false exanpe-dialog-default-title
message The message of the Dialog box
Allow null : true
Default prefix : message
java.lang.String false exanpe-dialog-default-message
targetHtmlId An Html id used to display the content of the Dialog instead of message parameter
Allow null : false
Default prefix : literal
java.lang.String false
yesLabelButton The label of the yes button
Allow null : false
Default prefix : message
java.lang.String false exanpe-dialog-yes-button-label
noLabelButton The label of the no button
Allow null : false
Default prefix : message
java.lang.String false exanpe-dialog-no-button-label
okLabelButton The label of the ok button
Allow null : false
Default prefix : message
java.lang.String false exanpe-dialog-ok-button-label
renderMode Specify the render mode to used for displaying Dialog.
Allow null : false
Default prefix : literal
fr.exanpe.t5.lib.constants.DialogRenderModeEnum true confirm
width Width of the Dialog, in pixel.
Allow null : false
Default prefix : literal
java.lang.Integer true 300

passwordstrengthchecker

NameDescriptionTypeRequiredDefault value
ajax Decide if password checking is made in Ajax mode, or not
Allow null : false
Default prefix : literal
java.lang.Boolean false false
javascriptChecker The javascript function used client-side to check the password complexity.
Allow null : false
Default prefix : literal
java.lang.String false
min Minimum number of caracters before triggering ajax event.
Allow null : false
Default prefix : literal
java.lang.Integer false 4

richtexteditor

NameDescriptionTypeRequiredDefault value
title Rich Text Editor title
Default prefix : message
java.lang.String false
collapse Indicating if the the toolbar should have a collapse button or not.
Default prefix : literal
java.lang.Boolean false true
width Width of the textarea
Default prefix : literal
java.lang.Integer false 500
height Height of the textarea
Default prefix : literal
java.lang.Integer false 300
include A comma-separated list of button names to be retained.
The names are case-insensitive.

Available names are :
bold, italic, underline, justifyleft, justifycenter, justifyright, createlink, undo, redo, insertunorderedlist, insertorderedlist, heading, forecolor, backcolor and separator.


Allow null : false
Default prefix : literal
java.lang.String false
exclude A comma-separated list of button names to be removed from the default editor toolbar.
The names are case-insensitive.

Available names are :
bold, italic, underline, justifyleft, justifycenter, justifyright, createlink, undo, redo, insertunorderedlist, insertorderedlist, heading, forecolor, backcolor.


Allow null : false
Default prefix : literal
java.lang.String false
autofocus Should we focus the textarea when the content is ready.
Default prefix : literal
java.lang.Boolean false true
exclude Used to override the default message catalog.

Available label keys are :
bold, italic, underline, justifyleft, justifycenter, justifyright, createlink, undo, redo, insertunorderedlist, insertorderedlist, heading, none, h1, h2, h3, h4, h5, h6, forecolor, backcolor.


Default prefix : literal
org.apache.tapestry5.ioc.Messages false componentResources.messages

selectloader

NameDescriptionTypeRequiredDefault value
targetId Defines the target select id to populate
Allow null : false
Default prefix : literal
java.lang.String true
targetEncoder Defines the target select id to populate
Allow null : false
Default prefix : prop
org.apache.tapestry5.ValueEncoder false

ajaxvalidation

NameDescriptionTypeRequiredDefault value
message Specify the message displayed on validation error

Default prefix : message
java.lang.String false

authorizemixin

NameDescriptionTypeRequiredDefault value
any Comma separated role values. Any of these roles are required to allow rendering

Default prefix : literal
java.lang.String false
all Comma separated role values. All of these roles are required to allow rendering

Default prefix : literal
java.lang.String false
not Comma separated role values. None of these roles are required to allow rendering (if one is present in the session, no rendering)

Default prefix : literal
java.lang.String false