com.ibm.xsp.component.xp
Class XspFileDownload

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIData
              com.ibm.xsp.component.UIDataEx
                  com.ibm.xsp.component.UIFileDownload
                      com.ibm.xsp.component.xp.XspFileDownload

All Implemented Interfaces:

FacesAjaxComponent, FacesAttrsObject, FacesComponent, FacesDataIterator, FacesRefreshableComponent, FacesRowAttrsComponent, FacesRowIndex, FacesThemeHandler, ThemeControl, javax.faces.component.NamingContainer, javax.faces.component.StateHolder

public class XspFileDownload
extends UIFileDownload

A control that displays a list of available files for downloading

XPages Core Controls - File Download

Nested Class Summary

Nested classes/interfaces inherited from class com.ibm.xsp.component.UIFileDownload

UIFileDownload.DownloadVb, UIFileDownload.InternalCreated, UIFileDownload.InternalHref, UIFileDownload.InternalId, UIFileDownload.InternalLastModified, UIFileDownload.InternalName, UIFileDownload.InternalSizeValue, UIFileDownload.InternalType

Nested classes/interfaces inherited from class javax.faces.component.UIComponentBase

javax.faces.component.UIComponentBase.AggregatedIterator, javax.faces.component.UIComponentBase.UnmodifiableIterator

Nested classes/interfaces inherited from class javax.faces.component.UIComponent

javax.faces.component.UIComponent.StateMap, javax.faces.component.UIComponent.StateMapEntry

Field Summary

static java.lang.String	COMPONENT_TYPE
static java.lang.String	RENDERER_TYPE

Fields inherited from class com.ibm.xsp.component.UIDataEx

AJAX_GETROWS, DEFAULT_ROWS_PER_PAGE

Fields inherited from class javax.faces.component.UIData

COMPONENT_FAMILY

Fields inherited from class javax.faces.component.UIComponentBase

EMPTY_ITERATOR

Fields inherited from class javax.faces.component.UIComponent

_xspStateId

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

XspFileDownload()

Method Summary

java.lang.String	getBgcolor() Return the value of the bgcolor property.
int	getBorder() Return the value of the border property.
java.lang.String	getCaption() Return the value of the caption property.
java.lang.String	getCaptionStyleClass() Return the value of the captionStyleClass property.
java.lang.String	getCellpadding() Return the value of the cellpadding property.
java.lang.String	getCellspacing() Return the value of the cellspacing property.
java.lang.String	getColumnClasses() Return the value of the columnClasses property.
java.lang.String	getDir() Return the value of the dir property.
java.lang.String	getFooterClass() Return the value of the footerClass property.
java.lang.String	getFrame() Return the value of the frame property.
java.lang.String	getHeaderClass() Return the value of the headerClass property.
java.lang.String	getLang() Return the value of the lang property.
java.lang.String	getOnclick() Return the value of the onclick property.
java.lang.String	getOndblclick() Return the value of the ondblclick property.
java.lang.String	getOnkeydown() Return the value of the onkeydown property.
java.lang.String	getOnkeypress() Return the value of the onkeypress property.
java.lang.String	getOnkeyup() Return the value of the onkeyup property.
java.lang.String	getOnmousedown() Return the value of the onmousedown property.
java.lang.String	getOnmousemove() Return the value of the onmousemove property.
java.lang.String	getOnmouseout() Return the value of the onmouseout property.
java.lang.String	getOnmouseover() Return the value of the onmouseover property.
java.lang.String	getOnmouseup() Return the value of the onmouseup property.
java.lang.String	getRole() Return the value of the role property.
java.lang.String	getRowClasses() Return the value of the rowClasses property.
java.lang.String	getRules() Return the value of the rules property.
java.lang.String	getStyle() Return the value of the style property.
java.lang.String	getStyleClass() Return the value of the styleClass property.
java.lang.String	getSummary() Return the value of the summary property.
java.lang.String	getTitle() Return the value of the title property.
java.lang.String	getWidth() Return the value of the width property.
boolean	isDisabled() Return the value of the disabled property.
void	restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
java.lang.Object	saveState(javax.faces.context.FacesContext _context)
void	setBgcolor(java.lang.String bgcolor) Set the value of the bgcolor property.
void	setBorder(int border) Set the value of the border property.
void	setCaption(java.lang.String caption) Set the value of the caption property.
void	setCaptionStyleClass(java.lang.String captionStyleClass) Set the value of the captionStyleClass property.
void	setCellpadding(java.lang.String cellpadding) Set the value of the cellpadding property.
void	setCellspacing(java.lang.String cellspacing) Set the value of the cellspacing property.
void	setColumnClasses(java.lang.String columnClasses) Set the value of the columnClasses property.
void	setDir(java.lang.String dir) Set the value of the dir property.
void	setDisabled(boolean disabled) Set the value of the disabled property.
void	setFooterClass(java.lang.String footerClass) Set the value of the footerClass property.
void	setFrame(java.lang.String frame) Set the value of the frame property.
void	setHeaderClass(java.lang.String headerClass) Set the value of the headerClass property.
void	setLang(java.lang.String lang) Set the value of the lang property.
void	setOnclick(java.lang.String onclick) Set the value of the onclick property.
void	setOndblclick(java.lang.String ondblclick) Set the value of the ondblclick property.
void	setOnkeydown(java.lang.String onkeydown) Set the value of the onkeydown property.
void	setOnkeypress(java.lang.String onkeypress) Set the value of the onkeypress property.
void	setOnkeyup(java.lang.String onkeyup) Set the value of the onkeyup property.
void	setOnmousedown(java.lang.String onmousedown) Set the value of the onmousedown property.
void	setOnmousemove(java.lang.String onmousemove) Set the value of the onmousemove property.
void	setOnmouseout(java.lang.String onmouseout) Set the value of the onmouseout property.
void	setOnmouseover(java.lang.String onmouseover) Set the value of the onmouseover property.
void	setOnmouseup(java.lang.String onmouseup) Set the value of the onmouseup property.
void	setRole(java.lang.String role) Set the value of the role property.
void	setRowClasses(java.lang.String rowClasses) Set the value of the rowClasses property.
void	setRules(java.lang.String rules) Set the value of the rules property.
void	setStyle(java.lang.String style) Set the value of the style property.
void	setStyleClass(java.lang.String styleClass) Set the value of the styleClass property.
void	setSummary(java.lang.String summary) Set the value of the summary property.
void	setTitle(java.lang.String title) Set the value of the title property.
void	setWidth(java.lang.String width) Set the value of the width property.

Methods inherited from class com.ibm.xsp.component.UIFileDownload

addAttr, addRowAttr, bindBasicColumn, buildContents, createExpression, getAttrs, getCreatedStyleClass, getCreatedTitle, getCreatedValue, getCurrentFileDownloadValue, getDeleteImageTitle, getDeleteMessage, getDeleteStyleClass, getEffectiveCreatedValue, getEffectiveFileNameHrefValue, getEffectiveFileNameValue, getEffectiveLastModifiedValue, getEffectiveSizeValue, getEffectiveTypeValue, getFileCreatedColumn, getFileDeleteColumn, getFileId, getFileLastModifiedColumn, getFileNameColumn, getFileNameHrefValue, getFileNameTitle, getFileNameValue, getFileSizeColumn, getFileTypeColumn, getLastModifiedTitle, getLastModifiedValue, getModifiedStyleClass, getNameStyleClass, getNumberConverter, getRowAttrs, getSizeStyleClass, getSizeTitle, getSizeValue, getStyleKitFamily, getTypeStyleClass, getTypeTitle, getTypeValue, getZeroRows, initAfterContents, initBasicColumn, initBeforeContents, initFileDeleteColumn, isAllowDelete, isDisplayCreated, isDisplayLastModified, isDisplaySize, isDisplayType, isHideWhen, isReadOnlyMode, isRendered, processRestoreState, resolveValue, setAllowDelete, setAttrs, setCreatedStyleClass, setCreatedTitle, setCreatedValue, setDeleteImageTitle, setDeleteMessage, setDeleteStyleClass, setDisplayCreated, setDisplayLastModified, setDisplaySize, setDisplayType, setFileNameHrefValue, setFileNameTitle, setFileNameValue, setHideWhen, setLastModifiedTitle, setLastModifiedValue, setModifiedStyleClass, setNameStyleClass, setRowAttrs, setSizeStyleClass, setSizeTitle, setSizeValue, setThemeProperty, setTypeStyleClass, setTypeTitle, setTypeValue

Methods inherited from class com.ibm.xsp.component.UIDataEx

_xspCleanTransientData, broadcast, computeDataModelKey, createDataModel, encodeBegin, encodeEnd, getAjaxUrl, getAjaxUrl, getData, getDataModel, getDataSource, getIndexVar, getLastCreatedDataModel, getNonChildClientId, getRefreshId, getRowCount, getRowCount, getRows, getValue, gotoFirstPage, gotoLastPage, gotoNextPage, gotoPage, gotoPreviousPage, gotoRow, handles, invokeOnComponent, isNestedInDataIterator, isPartialExecute, isPartialRefresh, processAjaxGetRows, processAjaxRequest, processDecodes, processUpdates, processValidators, publishControlData, queueEvent, resetDataModel, revokeControlData, setData, setDataModel, setIndexVar, setRowIndex, setRows, setValue, setValueBinding, setVar, visitTree

Methods inherited from class javax.faces.component.UIData

getClientId, getFamily, getFirst, getFooter, getHeader, getRowData, getRowIndex, getVar, isRowAvailable, setFirst, setFooter, setHeader

Methods inherited from class javax.faces.component.UIComponentBase

_xspGetReadOnlyObj, _xspGetRendererData, _xspRemoveReadOnlyObj, _xspRemoveRendererData, _xspSetIdUnchecked, _xspSetReadOnlyObj, _xspSetRendererData, addFacesListener, decode, encodeChildren, findComponent, getAttributes, getChildCount, getChildren, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isTransient, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient

Methods inherited from class javax.faces.component.UIComponent

_xspGetStateId, _xspGetStateMap, _xspRestoreAttribute, _xspRestoreState, _xspSaveState, isVisitable, markInitialState, setControlState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibm.xsp.component.FacesDataIterator

getFirst, getRowIndex, setFirst

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

XspFileDownload

public XspFileDownload()

Method Detail

getBgcolor

public java.lang.String getBgcolor()

Return the value of the bgcolor property. Contents:

Specifies the name or code of the table background color

getBorder

public int getBorder()

Return the value of the border property. Contents:

Specifies the pixel width of the table border

getCaption

public java.lang.String getCaption()

Return the value of the caption property. Contents:

The caption which will be displayed above the table

getCaptionStyleClass

public java.lang.String getCaptionStyleClass()

Return the value of the captionStyleClass property. Contents:

Space-separated list of CSS style class(es) to be applied to the caption

getCellpadding

public java.lang.String getCellpadding()

Return the value of the cellpadding property. Contents:

Defines how much space should be left between the border of each cell and its contents

getCellspacing

public java.lang.String getCellspacing()

Return the value of the cellspacing property. Contents:

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.

getColumnClasses

public java.lang.String getColumnClasses()

Return the value of the columnClasses property. Contents:

Specifies a comma-delimited list of CSS style classes that will be applied to table columns

getDir

public java.lang.String getDir()

Return the value of the dir property. Contents:

Specifies the direction for text that does not inherit a direction. Valid values are 'LTR' (left to right) and 'RTL' (right to left).

getFooterClass

public java.lang.String getFooterClass()

Return the value of the footerClass property. Contents:

Specifies a space-separated list of CSS style class(es) that will be applied to any table footer

getFrame

public java.lang.String getFrame()

Return the value of the frame property. Contents:

Specifies which sides of the frame surrounding a table will be visible

getHeaderClass

public java.lang.String getHeaderClass()

Return the value of the headerClass property. Contents:

Specifies a space-separated list of CSS style class(es) that will be applied to any table header

getLang

public java.lang.String getLang()

Return the value of the lang property. Contents:

Describes the language used in the generated markup of the control.

getOnclick

public java.lang.String getOnclick()

Return the value of the onclick property. Contents:

JavaScript code executed when a pointer control is clicked over this control

getOndblclick

public java.lang.String getOndblclick()

Return the value of the ondblclick property. Contents:

JavaScript code executed when a pointer control is double clicked over this control

getOnkeydown

public java.lang.String getOnkeydown()

Return the value of the onkeydown property. Contents:

JavaScript code executed when a key is pressed down over this control

getOnkeypress

public java.lang.String getOnkeypress()

Return the value of the onkeypress property. Contents:

JavaScript code executed when a key is pressed and released over this control.

getOnkeyup

public java.lang.String getOnkeyup()

Return the value of the onkeyup property. Contents:

JavaScript code executed when a key is released over this control

getOnmousedown

public java.lang.String getOnmousedown()

Return the value of the onmousedown property. Contents:

JavaScript code executed when a pointer control is pressed down over this control

getOnmousemove

public java.lang.String getOnmousemove()

Return the value of the onmousemove property. Contents:

JavaScript code executed when a pointer control is moved within this control

getOnmouseout

public java.lang.String getOnmouseout()

Return the value of the onmouseout property. Contents:

JavaScript code executed when a pointer control is moved away from this control

getOnmouseover

public java.lang.String getOnmouseover()

Return the value of the onmouseover property. Contents:

JavaScript code executed when a pointer control is moved onto this control

getOnmouseup

public java.lang.String getOnmouseup()

Return the value of the onmouseup property. Contents:

JavaScript code executed when a pointer control is released over this control

getRole

public java.lang.String getRole()

Return the value of the role property. Contents:

Describes the role of the current UI element/area. It can be used by assistive technologies to determine its purpose.

getRowClasses

public java.lang.String getRowClasses()

Return the value of the rowClasses property. Contents:

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.

getRules

public java.lang.String getRules()

Return the value of the rules property. Contents:

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

getStyle

public java.lang.String getStyle()

Return the value of the style property. Contents:

Specifies CSS style(s) to be applied when this control is rendered.

XPages Styling Category - style

getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property. Contents:

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.

getSummary

public java.lang.String getSummary()

Return the value of the summary property. Contents:

Provides a summary of the purpose and structure of the table.

getTitle

public java.lang.String getTitle()

Return the value of the title property. Contents:

Provides title information for controls.

getWidth

public java.lang.String getWidth()

Return the value of the width property. Contents:

Width of the entire table

isDisabled

public boolean isDisabled()

Return the value of the disabled property. Contents:

Determines whether or not the page can receive focus or be included in page submissions.

restoreState

public void restoreState(javax.faces.context.FacesContext _context,
                         java.lang.Object _state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class UIFileDownload

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext _context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class UIFileDownload

setBgcolor

public void setBgcolor(java.lang.String bgcolor)

Set the value of the bgcolor property.

setBorder

public void setBorder(int border)

Set the value of the border property.

setCaption

public void setCaption(java.lang.String caption)

Set the value of the caption property.

setCaptionStyleClass

public void setCaptionStyleClass(java.lang.String captionStyleClass)

Set the value of the captionStyleClass property.

setCellpadding

public void setCellpadding(java.lang.String cellpadding)

Set the value of the cellpadding property.

setCellspacing

public void setCellspacing(java.lang.String cellspacing)

Set the value of the cellspacing property.

setColumnClasses

public void setColumnClasses(java.lang.String columnClasses)

Set the value of the columnClasses property.

setDir

public void setDir(java.lang.String dir)

Set the value of the dir property.

setDisabled

public void setDisabled(boolean disabled)

Set the value of the disabled property.

setFooterClass

public void setFooterClass(java.lang.String footerClass)

Set the value of the footerClass property.

setFrame

public void setFrame(java.lang.String frame)

Set the value of the frame property.

setHeaderClass

public void setHeaderClass(java.lang.String headerClass)

Set the value of the headerClass property.

setLang

public void setLang(java.lang.String lang)

Set the value of the lang property.

setOnclick

public void setOnclick(java.lang.String onclick)

Set the value of the onclick property.

setOndblclick

public void setOndblclick(java.lang.String ondblclick)

Set the value of the ondblclick property.

setOnkeydown

public void setOnkeydown(java.lang.String onkeydown)

Set the value of the onkeydown property.

setOnkeypress

public void setOnkeypress(java.lang.String onkeypress)

Set the value of the onkeypress property.

setOnkeyup

public void setOnkeyup(java.lang.String onkeyup)

Set the value of the onkeyup property.

setOnmousedown

public void setOnmousedown(java.lang.String onmousedown)

Set the value of the onmousedown property.

setOnmousemove

public void setOnmousemove(java.lang.String onmousemove)

Set the value of the onmousemove property.

setOnmouseout

public void setOnmouseout(java.lang.String onmouseout)

Set the value of the onmouseout property.

setOnmouseover

public void setOnmouseover(java.lang.String onmouseover)

Set the value of the onmouseover property.

setOnmouseup

public void setOnmouseup(java.lang.String onmouseup)

Set the value of the onmouseup property.

setRole

public void setRole(java.lang.String role)

Set the value of the role property.

setRowClasses

public void setRowClasses(java.lang.String rowClasses)

Set the value of the rowClasses property.

setRules

public void setRules(java.lang.String rules)

Set the value of the rules property.

setStyle

public void setStyle(java.lang.String style)

Set the value of the style property.

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.

setSummary

public void setSummary(java.lang.String summary)

Set the value of the summary property.

setTitle

public void setTitle(java.lang.String title)

Set the value of the title property.

setWidth

public void setWidth(java.lang.String width)

Set the value of the width property.