com.businessobjects.jsf.sdk.components
Class UIReportFormat

java.lang.Object
  |
  +--UICommand
        |
        +--com.businessobjects.jsf.sdk.components.UIBaseControl
              |
              +--com.businessobjects.jsf.sdk.components.UIBaseScheduleControl
                    |
                    +--com.businessobjects.jsf.sdk.components.UIReportFormat

public class UIReportFormat

extends UIBaseScheduleControl

Enables a user to select the file format of the report they wish to schedule.

See Also:

Serialized Form

Field Summary

static java.lang.String

TYPE

Fields inherited from class com.businessobjects.jsf.sdk.components.UIBaseScheduleControl

DEFAULT_FORM, SUBMIT

Constructor Summary

UIReportFormat()

Method Summary

boolean	checkItemType() For internal use only.
void	decode(FacesContext context) For internal use only.
CharacterSeparatedProps	getCharacterSeparated() Gets the text label to display beside the Delimiter and Separator text boxes.
java.lang.String	getCharactersText() Gets the text label to display beside the Characters Per Inch text box.
ExcelProps	getExcel() Gets the formatting properties of Microsoft Excel and Microsoft Excel (Data Only) files.
java.lang.String	getFamily()
java.util.List	getFormats() Gets the list of formats.
java.lang.String	getFormatText() Gets the text label to display beside the Format box.
java.lang.String	getNotReportText() Gets the text to display when the item in the EnterpriseItem bean bound to the component (via the itemSource attribute) is not a report.
java.lang.String	getOptionsText() Gets the text label to display beside the Options box.
PageLayoutProps	getPageLayout() Gets the text labels to display beside the Layout, Orientation, Page Size, and Printer boxes.
PaginatedTextProps	getPaginatedText() Gets the text label to display beside the Paginated Text box.
java.lang.String	getRangeText() Gets the text label to display beside the Range box.
int	getSelectedFormat() Gets the default format type to be used in the list of formats.
java.lang.String	getSelectedPageLayout() Gets the default page layout type to be used in the Page Layout list.
java.lang.String	getVisibleFormats() Gets the list of visible formats to be displayed in the Format list.
boolean	isShowCharacters() Gets a value indicating whether to display a scheduling option that sets the number of characters per inch in plain text or paginted text file formats.
boolean	isShowOptions() Gets a value indicating whether to display the options for a particular format type.
boolean	isShowPageRange() Gets a value indicating whether to display the page range.
void	restoreState(FacesContext context, java.lang.Object state) For internal use only.
java.lang.Object	saveState(FacesContext context) For internal use only.
void	setCharacterSeparated(CharacterSeparatedProps characterSeparated) Sets the text labels to display beside the Delimiter and Separator text boxes.
void	setCharactersText(java.lang.String charactersText) Sets the text label to display beside the Characters Per Inch text box.
void	setExcel(ExcelProps excel) Sets the formatting properties of Microsoft Excel and Microsoft Excel (Data Only) files.
void	setFormatText(java.lang.String formatText) Sets the text label to display beside the Format box.
void	setItemSource(IItemSource itemSource) Sets the source of the item to be bound to the ReportFormat component.
void	setNotReportText(java.lang.String notReportText) Sets the text to display when the item in the EnterpriseItem bean bound to the component (via the itemSource attribute) is not a report.
void	setOptionsText(java.lang.String optionsText) Sets the text label to display beside the Options box.
void	setPageLayout(PageLayoutProps pageLayout) Sets the text labels to display beside the Layout, Orientation, Page Size, and Printer boxes.
void	setPaginatedText(PaginatedTextProps paginatedText) Sets the text label to display beside the Paginated Text box.
void	setRangeText(java.lang.String rangeText) Sets the text label to display beside the Range box.
void	setSelectedFormat(int selectedFormat) Sets the default format type to be used in the list of formats.
void	setSelectedPageLayout(java.lang.String selectedPageLayout) Sets the default page layout type to be used in the Page Layout list.
void	setShowCharacters(boolean showCharacters) Sets a value indicating whether to display a scheduling option that sets the number of characters per inch in plain text or paginted text file formats.
void	setShowOptions(boolean showOptions) Sets a value indicating whether to display the options for a particular format type.
void	setShowPageRange(boolean showPageRange) Sets a value indicating whether to display the page range.
void	setVisibleFormats(java.lang.String visibleFormats) Sets the list of visible formats to be displayed in the Format list.
void	submit(IItemSource item) For internal use only.

Methods inherited from class com.businessobjects.jsf.sdk.components.UIBaseScheduleControl

getEmptyText, getItemSource, getLabelAlignment, getLoggedOffText, getStyleClass, getSubmitButton, setAutoHandleEvents, setEmptyText, setLabelAlignment, setLoggedOffText, setStyleClass, setSubmitButton

Methods inherited from class com.businessobjects.jsf.sdk.components.UIBaseControl

encodeBegin, getLocale, getTitle, isAutoHandleEvents, isEnabled, setEnabled, setLocale, setTitle

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

Constructor Detail

UIReportFormat

public UIReportFormat()

Method Detail

setItemSource

public void setItemSource(IItemSource itemSource)

Sets the source of the item to be bound to the ReportFormat component.

The item source is a bean that implements either IEnterpriseItem or IEnterpriseItems.

Overrides:

setItemSource in class UIBaseControl

Parameters:

itemSource - An IItemSource object.

decode

public void decode(FacesContext context)

For internal use only.

submit

public void submit(IItemSource item)
            throws SDKException

For internal use only.

Overrides:

submit in class UIBaseScheduleControl

Returns:

A String that indicates success or error.

SDKException

getCharacterSeparated

public CharacterSeparatedProps getCharacterSeparated()

Gets the text label to display beside the Delimiter and Separator text boxes.

Returns:

A CharacterSeparatedProps object that specifies the text label to display beside the Delimiter and Separator text boxes.

setCharacterSeparated

public void setCharacterSeparated(CharacterSeparatedProps characterSeparated)

Sets the text labels to display beside the Delimiter and Separator text boxes.

Parameters:

characterSeparated - a CharacterSeparatedProps object that specifies the text labels to display beside the Delimiter and Separator text boxes.

getCharactersText

public java.lang.String getCharactersText()

Gets the text label to display beside the Characters Per Inch text box.

Returns:

A String containing the text label to display beside the Characters Per Inch text box.

setCharactersText

public void setCharactersText(java.lang.String charactersText)

Sets the text label to display beside the Characters Per Inch text box.

Parameters:

charactersText - a String containing the text label to display beside the Characters Per Inch text box.

getExcel

public ExcelProps getExcel()

Gets the formatting properties of Microsoft Excel and Microsoft Excel (Data Only) files.

Returns:

An ExcelProps object that specifies the formatting properties.

setExcel

public void setExcel(ExcelProps excel)

Sets the formatting properties of Microsoft Excel and Microsoft Excel (Data Only) files.

Parameters:

excel - an ExcelProps object that specifies the formatting properties.

getFormats

public java.util.List getFormats()

Gets the list of formats.

Returns:

A List of formats.

getFormatText

public java.lang.String getFormatText()

Gets the text label to display beside the Format box.

Returns:

A String containing the text label to display beside the Format box.

setFormatText

public void setFormatText(java.lang.String formatText)

Sets the text label to display beside the Format box.

Parameters:

formatText - a String containing the text label to display beside the Format box.

getOptionsText

public java.lang.String getOptionsText()

Gets the text label to display beside the Options box.

Returns:

A String containing the text label to display beside the Options box.

setOptionsText

public void setOptionsText(java.lang.String optionsText)

Sets the text label to display beside the Options box.

Parameters:

optionsText - a String containing the text label to display beside the Options box.

getPageLayout

public PageLayoutProps getPageLayout()

Gets the text labels to display beside the Layout, Orientation, Page Size, and Printer boxes.

Returns:

A PageLayoutProps object that specifies the text labels to display beside the Layout, Orientation, Page Size, and Printer boxes.

setPageLayout

public void setPageLayout(PageLayoutProps pageLayout)

Sets the text labels to display beside the Layout, Orientation, Page Size, and Printer boxes.

Parameters:

pageLayout - a PageLayoutProps object that specifies the text labels to display.

getPaginatedText

public PaginatedTextProps getPaginatedText()

Gets the text label to display beside the Paginated Text box.

Returns:

A PaginatedTextProps object that specifies the text label to display.

setPaginatedText

public void setPaginatedText(PaginatedTextProps paginatedText)

Sets the text label to display beside the Paginated Text box.

Parameters:

paginatedText - a PaginatedTextProps object that specifies the text label to display.

getRangeText

public java.lang.String getRangeText()

Gets the text label to display beside the Range box.

Returns:

A String containing the text label to display beside the Range box.

setRangeText

public void setRangeText(java.lang.String rangeText)

Sets the text label to display beside the Range box.

Parameters:

rangeText - a String containing the text label to display beside the Range box.

getSelectedFormat

public int getSelectedFormat()

Gets the default format type to be used in the list of formats.

Returns:

A int that specifies the default format type to be used in the list of formats.

setSelectedFormat

public void setSelectedFormat(int selectedFormat)

Sets the default format type to be used in the list of formats.

Parameters:

selectedFormat - an int that specifies the default format type to be used in the list of formats. It is one of the values specified in com.businessobjects.jsf.sdk.properties.ReportFormatType

See Also:

ReportFormatType

getSelectedPageLayout

public java.lang.String getSelectedPageLayout()

Gets the default page layout type to be used in the Page Layout list.

Returns:

A String that specifies the default page layout type to be used in the Page Layout list.

setSelectedPageLayout

public void setSelectedPageLayout(java.lang.String selectedPageLayout)

Sets the default page layout type to be used in the Page Layout list.

Parameters:

selectedPageLayout - a String that specifies the default page layout type to be used in the Page Layout list.

isShowCharacters

public boolean isShowCharacters()

Gets a value indicating whether to display a scheduling option that sets the number of characters per inch in plain text or paginted text file formats.

Returns:

A boolean that is true if the scheduling option should be displayed, otherwise false.

setShowCharacters

public void setShowCharacters(boolean showCharacters)

Sets a value indicating whether to display a scheduling option that sets the number of characters per inch in plain text or paginted text file formats.

Parameters:

showCharacters - a boolean value that is true if the scheduling option should be displayed, otherwise false.

isShowOptions

public boolean isShowOptions()

Gets a value indicating whether to display the options for a particular format type.

Returns:

A boolean value that is true if the option should be displayed, otherwise false.

setShowOptions

public void setShowOptions(boolean showOptions)

Sets a value indicating whether to display the options for a particular format type.

Parameters:

showOptions - a boolean that is true if the options should be displayed, otherwise false.

isShowPageRange

public boolean isShowPageRange()

Gets a value indicating whether to display the page range.

Returns:

A boolean that is true if the page range should be displayed, otherwise false.

setShowPageRange

public void setShowPageRange(boolean showPageRange)

Sets a value indicating whether to display the page range.

Parameters:

showPageRange - a boolean value that is true if the page range should be displayed, otherwise false.

getVisibleFormats

public java.lang.String getVisibleFormats()

Gets the list of visible formats to be displayed in the Format list.

Returns:

A String containing the list of visible formats to be displayed in the Format list.

setVisibleFormats

public void setVisibleFormats(java.lang.String visibleFormats)

Sets the list of visible formats to be displayed in the Format list.

Parameters:

visibleFormats - a String containing the list of visible formats to be displayed in the Format list.

getNotReportText

public java.lang.String getNotReportText()

Gets the text to display when the item in the EnterpriseItem bean bound to the component (via the itemSource attribute) is not a report.

Returns:

A String containing text to display when the item is not a report.

setNotReportText

public void setNotReportText(java.lang.String notReportText)

Sets the text to display when the item in the EnterpriseItem bean bound to the component (via the itemSource attribute) is not a report.

Parameters:

notReportText - a String containing text to display when the item is not a report.

checkItemType

public boolean checkItemType()

For internal use only.

Specified by:

checkItemType in class UIBaseScheduleControl

getFamily

public java.lang.String getFamily()

saveState

public java.lang.Object saveState(FacesContext context)

For internal use only.

Overrides:

saveState in class UIBaseScheduleControl

restoreState

public void restoreState(FacesContext context,
                         java.lang.Object state)

For internal use only.

Overrides:

restoreState in class UIBaseScheduleControl