Controls Documentation

Controls  Complex Types  Show Hierarchies  Show Full Hierarchies 

Control: xp:fileDownload

f:javax.faces.Component
   f:javax.faces.Data
      xp:com.ibm.xsp.Data
         xp:com.ibm.xsp.UIFileDownload
            xp:fileDownload

Description

A control that displays a list of available files for downloading

Properties

Java

Java Class: com.ibm.xsp.component.xp.XspFileDownload


accessibility

title, string
Advisory Title
Provides title information for controls.
Required Attribute false
Localizable true
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
caption, string
Caption
The caption which will be displayed above the table
Required Attribute false
Localizable true
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
summary, string
Table Summary
Provides a summary of the purpose and structure of the table.
Required Attribute false
Localizable true
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
role, string
Control Identifier
Describes the role of the current UI element/area. It can be used by assistive technologies to determine its purpose.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true

basics

binding, object - javax.faces.component.UIComponent  [Inherited]
Control Binding
Specifies an expression that binds the control to a particular control property.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding false
loaded, boolean  [Inherited]
Loaded
Specifies whether or not the control should be created when the page is loaded. Value defaults to 'true'.
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
id, string  [Inherited]
Control Identifier
Specifies the name identifier for the control. No two controls can have the same name identifier in a single page.
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
rendered, boolean  [Inherited]
Rendered Flag
Indicates whether or not the control should be displayed or processed on any subsequent form submission.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
rendererType, string  [Inherited]
Renderer Type
Identifies (with the "family" defined by the control) an appropriate renderer to encode and decode this control
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
fileNameTitle, string  [Inherited]
File Name Title
Overrides the default file name title on the column header.
Required Attribute false
Localizable true
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
fileNameValue, string  [Inherited]
File Name Value
Overrides the default value for the file name
Required Attribute false
Localizable true
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
fileNameHrefValue, string  [Inherited]
File Name URL
Overrides the default value for the file name HREF with a URL that points to the file.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
hideWhen, boolean  [Inherited]
Hide When Unavailable
Hides the file download field when no files are available for download.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
displaySize, boolean  [Inherited]
Display File Size
Indicates whether or not to display the size of the file.
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
sizeTitle, string  [Inherited]
File Size Title
Provides the title of the File Size column header.
Required Attribute false
Localizable true
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
sizeValue, string  [Inherited]
File Size Value Binding
Overrides the value for the file size.
Required Attribute false
Localizable true
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
displayLastModified, boolean  [Inherited]
Display last Modified
Indicates whether or not to display the date the file was last modified.
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
lastModifiedTitle, string  [Inherited]
File Modified Title
Specifies title for Last Modified header.
Required Attribute false
Localizable true
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
lastModifiedValue,   [Inherited]
Last Modified Value Binding
Overrides the Last Modified value.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding false
Allow Non Binding false
displayCreated, boolean  [Inherited]
Display Created
Indicates whether or not to display the date the file was created.
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
createdTitle, string  [Inherited]
Created Title
Specifies title for Created On header.
Required Attribute false
Localizable true
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
createdValue,   [Inherited]
Created Value Binding
Overrides the Created value.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding false
Allow Non Binding false
displayType, boolean  [Inherited]
Display File Type
Indicates whether or not to display the type of the file
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
typeTitle, string  [Inherited]
File Type Title
Provides the title of the File Type column header. Overrides the default column header for file type.
Required Attribute false
Localizable true
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
typeValue, string  [Inherited]
File Type Value
Overrides the default value for file type.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
allowDelete, boolean  [Inherited]
Allow File Delete
Specifies whether or not users are allowed to delete files from the document store.
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
deleteImageTitle, string  [Inherited]
Delete File Image Title
Specifies the title of the delete file image control.
Required Attribute false
Localizable true
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
deleteMessage, string  [Inherited]
Delete File Message
Specifies the prompt for the delete file image control.
Required Attribute false
Localizable true
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
dir, string
Direction
Specifies the direction for text that does not inherit a direction. Valid values are 'LTR' (left to right) and 'RTL' (right to left).
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
lang, string
Language Code
Describes the language used in the generated markup of the control.
Required Attribute false
Localizable true
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
disabled, boolean
Disabled Flag
Determines whether or not the page can receive focus or be included in page submissions.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
rules, string
Table Rules
Specifies rules between table cells. Valid values are 'none' (no rules, default), 'groups' (between row groups), 'rows' (between rows), 'cols' (between columns), and 'all' (between all rows and columns).
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true

data

first, int  [Inherited]
First Row Index
Specifies the row number of the first row to be displayed. Index is zero-based.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
rows, int  [Inherited]
Rows To Display
Specifies the number of rows to display, starting with the row identified by the "first" property. If set to zero, all available rows in the underlying data model will be displayed.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
value, generic  [Inherited]
Value
Specifies the data model. This must either be of type DataModel, or a type that can be adapted into a DataModel using one of the registered DataModelFactorys.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
var, string  [Inherited]
Var
Request-scope attribute under which a row data will be made available
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
indexVar, string  [Inherited]
Index Variable
Specifies the variable name under which the row index is made available to children
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
data, xp:dataInterface - com.ibm.xsp.model.DataSource  [Inherited]
Data
Specifies the data associated with this control
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true

events

onclick, string
Click Script
JavaScript code executed when a pointer control is clicked over this control
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
ondblclick, string
Double Click Script
JavaScript code executed when a pointer control is double clicked over this control
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onmousedown, string
Mouse Down Script
JavaScript code executed when a pointer control is pressed down over this control
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onmouseup, string
Mouse Up Script
JavaScript code executed when a pointer control is released over this control
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onmouseover, string
Mouse Over Script
JavaScript code executed when a pointer control is moved onto this control
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onmousemove, string
Mouse Move Script
JavaScript code executed when a pointer control is moved within this control
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onmouseout, string
Mouse Out Script
JavaScript code executed when a pointer control is moved away from this control
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onkeypress, string
Key Press Script
JavaScript code executed when a key is pressed and released over this control.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onkeydown, string
Key Down Script
JavaScript code executed when a key is pressed down over this control
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onkeyup, string
Key Up Script
JavaScript code executed when a key is released over this control
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true

format

border, int
Table Border
Specifies the pixel width of the table border
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
cellpadding, string
Cell Padding
Defines how much space should be left between the border of each cell and its contents
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
cellspacing, string
Cell Spacing
Defines how much space should left between the sides of a table and the edge rows and columns. Also specifies the amount of space to leave between cells.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
width, string
Table Width
Width of the entire table
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
bgcolor, string
Background Color
Specifies the name or code of the table background color
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
frame, string
Table Frame
Specifies which sides of the frame surrounding a table will be visible
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true

styling

disableTheme, boolean  [Inherited]
Disable Theme
A flag used to determine if the theme should be applied to this control.
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
themeId, string  [Inherited]
Theme Id
The theme id that should be used to set the component properties when a theme is applied
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
typeStyleClass, string  [Inherited]
Type Style Class
CSS style class to be applied to the Type column.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
sizeStyleClass, string  [Inherited]
Size Style Class
CSS style class to be applied to the Size column.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
nameStyleClass, string  [Inherited]
Name Style Class
CSS style class to be applied to the Name column.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
createdStyleClass, string  [Inherited]
Created Style Class
CSS style class to be applied to the Created On column.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
modifiedStyleClass, string  [Inherited]
Last Modified Style Class
CSS style class to be applied to the Last Modified column.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
deleteStyleClass, string  [Inherited]
Delete Style Class
CSS style class to be applied to the Delete column.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
style, string
CSS Styles
Specifies CSS style(s) to be applied when this control is rendered.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
styleClass, string
CSS Style Classes
Specifies the space-separated list of CSS style class(es) to be applied when this control is rendered. This value must be passed through as the "class" attribute on generated markup.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
captionStyleClass, string
Caption CSS Style Classes
Space-separated list of CSS style class(es) to be applied to the caption
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
rowClasses, string
Row CSS Classes
A comma separated list of style classes that are iterated through for each row. So applying two style classes here will result in every second row referencing the second style class. Space separated style classes can be used too.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
columnClasses, string
Column CSS Classes
Specifies a comma-delimited list of CSS style classes that will be applied to table columns
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
footerClass, string
Footer CSS Classes
Specifies a space-separated list of CSS style class(es) that will be applied to any table footer
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
headerClass, string
Header CSS Classes
Specifies a space-separated list of CSS style class(es) that will be applied to any table header
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true