Controls Documentation

Controls  Complex Types  Show Hierarchies  Show Full Hierarchies 

Control: xp:com.ibm.xsp.UIFileDownload

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

Properties

Java

Java Class: com.ibm.xsp.component.UIFileDownload


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
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
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
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
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
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
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
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
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
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,
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
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
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,
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
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
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
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
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
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
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

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

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
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
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
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
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
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
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