com.webmethods.caf.faces.component.export.view

Class ExportTableButtonView

java.lang.Object

com.webmethods.caf.faces.bean.BaseFacesBean

com.webmethods.caf.faces.bean.BaseFacesSessionBean

com.webmethods.caf.faces.bean.BaseViewBean

com.webmethods.caf.faces.bean.BaseCompositeViewControlPageBean

com.webmethods.caf.faces.component.export.view.ExportTableButtonView

All Implemented Interfaces:

IPageFlowScopeAdapter, ICompositeViewControlPageBean, Serializable, EventListener, PhaseListener, HttpSessionBindingListener

public class ExportTableButtonView
extends BaseCompositeViewControlPageBean

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.webmethods.caf.faces.bean.BaseViewBean

BaseViewBean.ClientIdsContentProvider

Field Summary

Fields

Modifier and Type	Field and Description
protected ISelectItemGroupProvider	fCharacterEncodingSelectItemGroupProvider
protected String	fExportCharacterEncoding
protected String	fExportExcludeComponentsCSV
protected String	fExportFileName
protected String	fExportFor
protected ITableContentProvider	fExportProvider
protected Boolean	fExportShowEncodingDialog

Fields inherited from class com.webmethods.caf.faces.bean.BaseCompositeViewControlPageBean

fCompositeNamingContainer

Fields inherited from class com.webmethods.caf.faces.bean.BaseViewBean

clientIds, initialized

Fields inherited from class com.webmethods.caf.faces.bean.BaseFacesSessionBean

fExpireWithPageFlow

Fields inherited from class com.webmethods.caf.faces.bean.BaseFacesBean

DATA_BINDING_CLIENTS, EMPTY_RESOURCES, OUTCOME_ERROR, OUTCOME_OK, resourcesProviders

Constructor Summary

Constructors

Constructor and Description
ExportTableButtonView()

Method Summary

Modifier and Type	Method and Description
void	doExportButton_actionListener(ActionEvent actionEvent) Action Listener for the control with id='doExportButton'
ISelectItemGroupProvider	getAvailableExportCharacterEncodings()
HtmlCommandButton	getDoExportNowButton() Getter method for the control with id='doExportNowButton'
String	getExportCharacterEncoding() Return the character encoding to use for the table export
String	getExportExcludeComponentsCSV()
String	getExportFileName()
String	getExportFor()
ITableContentProvider	getExportProvider()
HtmlOneWayToggleButton	getShowExportDialogButton() Getter method for the control with id='showExportDialogButton'
protected UIData	getTableControl() Returns the table control this export button is for or null.
protected List<UIComponent>	hideExcludedComponents() Hides the components specified by the getExportExcludeComponentsCSV() property.
boolean	isExportShowEncodingDialog()
void	setExportCharacterEncoding(String exportCharacterEncoding) Sets the character encoding to use for the table export
void	setExportExcludeComponentsCSV(String excludeComponentsCSV)
void	setExportFileName(String exportFileName)
void	setExportFor(String tableComponentID)
void	setExportProvider(ITableContentProvider exportProvider)
void	setExportShowEncodingDialog(boolean showEncodingDialog)
protected void	showExcludedComponents(List<UIComponent> excluded) Re-shows the specified list of components.

Methods inherited from class com.webmethods.caf.faces.bean.BaseCompositeViewControlPageBean

findComponentInRoot, getClientIds, getCompositeViewAbsoluteControlId, getCompositeViewControlId, getCompositeViewNamingContainer, getPropertyOrBindingValue, setCompositeViewNamingContainer

Methods inherited from class com.webmethods.caf.faces.bean.BaseViewBean

afterApplyRequestValues, afterInvokeApplication, afterPhase, afterProcessValidations, afterRenderResponse, afterRestoreView, afterUpdateModelValues, beforeApplyRequestValues, beforeInvokeApplication, beforePhase, beforeProcessValidations, beforeRenderResponse, beforeRestoreView, beforeUpdateModelValues, callInitialize, findComponent, getApplicationScope, getPhaseId, getRealPath, getRequestParam, getRequestScope, getSessionScope, gotoPage, gotoPage, initialize, isAsyncRequest, preRenderResponse, release, resetPageFlowStorage, streamFileDataToResponse

Methods inherited from class com.webmethods.caf.faces.bean.BaseFacesSessionBean

getExpireWithPageFlow, setExpireWithPageFlow, valueBound, valueUnbound

Methods inherited from class com.webmethods.caf.faces.bean.BaseFacesBean

createMethodBinding, createMethodExpression, createValueBinding, createValueExpression, createValueExpression, error, error, error, error, error, getBean, getFacesContext, getLocale, getResourceInputStream, getResources, getResourcesProvider, getRootCause, getStackTrace, getTreeAttribute, isUserInRole, log, log, log, putTreeAttribute, resetDataBindingClients, resolveDataBinding, resolveDataBinding, resolveExpression, setValue

Methods inherited from class java.lang.Object

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

Field Detail

fExportFor

protected String fExportFor

fExportExcludeComponentsCSV

protected String fExportExcludeComponentsCSV

fExportCharacterEncoding

protected String fExportCharacterEncoding

fCharacterEncodingSelectItemGroupProvider

protected ISelectItemGroupProvider fCharacterEncodingSelectItemGroupProvider

fExportFileName

protected String fExportFileName

fExportProvider

protected ITableContentProvider fExportProvider

fExportShowEncodingDialog

protected Boolean fExportShowEncodingDialog

Constructor Detail

ExportTableButtonView

public ExportTableButtonView()

Method Detail

isExportShowEncodingDialog

public boolean isExportShowEncodingDialog()

setExportShowEncodingDialog

public void setExportShowEncodingDialog(boolean showEncodingDialog)

getExportProvider

public ITableContentProvider getExportProvider()

setExportProvider

public void setExportProvider(ITableContentProvider exportProvider)

getExportFileName

public String getExportFileName()

setExportFileName

public void setExportFileName(String exportFileName)

getAvailableExportCharacterEncodings

public ISelectItemGroupProvider getAvailableExportCharacterEncodings()

getExportCharacterEncoding

public String getExportCharacterEncoding()

Return the character encoding to use for the table export

Returns:

Return the character encoding to use for the table export

setExportCharacterEncoding

public void setExportCharacterEncoding(String exportCharacterEncoding)

Sets the character encoding to use for the table export

Parameters:

exportCharacterEncoding - The character encoding to set.

getExportFor

public String getExportFor()

setExportFor

public void setExportFor(String tableComponentID)

getExportExcludeComponentsCSV

public String getExportExcludeComponentsCSV()

setExportExcludeComponentsCSV

public void setExportExcludeComponentsCSV(String excludeComponentsCSV)

doExportButton_actionListener

public void doExportButton_actionListener(ActionEvent actionEvent)

Action Listener for the control with id='doExportButton'

getTableControl

protected UIData getTableControl()

Returns the table control this export button is for or null.

hideExcludedComponents

protected List<UIComponent> hideExcludedComponents()

Hides the components specified by the getExportExcludeComponentsCSV() property. Returns the list of components actually hidden.

showExcludedComponents

protected void showExcludedComponents(List<UIComponent> excluded)

Re-shows the specified list of components.

getShowExportDialogButton

public HtmlOneWayToggleButton getShowExportDialogButton()

Getter method for the control with id='showExportDialogButton'

getDoExportNowButton

public HtmlCommandButton getDoExportNowButton()

Getter method for the control with id='doExportNowButton'