com.businessobjects.jsf.sdk.components
Class UIBaseScheduleControl

java.lang.Object
  UICommand
      com.businessobjects.jsf.sdk.components.UIBaseControl
          com.businessobjects.jsf.sdk.components.UIBaseScheduleControl

Direct Known Subclasses:

UIDestination, UIReportDatabaseLogon, UIReportFilters, UIReportFormat, UIReportParameters, UIReportPrint, UISchedule

public abstract class UIBaseScheduleControl
extends UIBaseControl

The base scheduling component from which all other BusinessObjects Enterprise JSF scheduling components inherit.

Field Summary

static java.lang.String	DEFAULT_FORM
static java.lang.String	SUBMIT

Constructor Summary

UIBaseScheduleControl()

Method Summary

abstract boolean	checkItemType() For internal use only.
java.lang.String	getEmptyText() Gets the text to display when the ItemSource connected to the schedule component is empty.
IItemSource	getItemSource() Gets the source of the item bound to the component.
int	getLabelAlignment() Gets the alignment of the label.
java.lang.String	getLoggedOffText() Gets the text to display when the user attempts to access the component while they are logged off.
java.lang.String	getStyleClass() Gets the CSS style class to be applied when this element is rendered.
SubmitButtonProps	getSubmitButton() Gets an instance of the SubmitButtonProps class which specifies the properties of the submit button.
void	restoreState(FacesContext context, java.lang.Object state) For internal use only.
java.lang.Object	saveState(FacesContext context) For internal use only.
void	setAutoHandleEvents(boolean autoHandleEvents) Enables or disables event auto handling.
void	setEmptyText(java.lang.String emptyText) Sets the text to display when the ItemSource connected to the schedule component is empty.
void	setLabelAlignment(int labelAlignment) Sets the horizontal alignment of the label.
void	setLoggedOffText(java.lang.String loggedOffText) Sets the text to display when the user attempts to access the component while they are logged off.
void	setStyleClass(java.lang.String styleClass) Sets the CSS style class to be applied when this element is rendered.
void	setSubmitButton(SubmitButtonProps submitButton) Sets an instance of the SubmitButtonProps class which specifies the properties of the submit button.
void	submit(IItemSource item) Applies the changes to the schedule properties of the item source passed in.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

SUBMIT

public static final java.lang.String SUBMIT

See Also:

Constant Field Values

DEFAULT_FORM

public static final java.lang.String DEFAULT_FORM

See Also:

Constant Field Values

Constructor Detail

UIBaseScheduleControl

public UIBaseScheduleControl()

Method Detail

setAutoHandleEvents

public void setAutoHandleEvents(boolean autoHandleEvents)

Enables or disables event auto handling. Pass in true if the component will react to its own events using a built-in event handler, otherwise, set to false.

Overrides:

setAutoHandleEvents in class UIBaseControl

Parameters:

autoHandleEvents - true to enable auto handling, otherwise, false.

getEmptyText

public java.lang.String getEmptyText()

Gets the text to display when the ItemSource connected to the schedule component is empty.

The ItemSource hooked up to the schedule component is empty when the item source contains no InfoObject. For example, when IEnterpriseItem.getInfoobject()==null or EnterpriseItems.getInfoObjects().size() == 0

Returns:

A String that specifies the text to display when the schedule component is empty.

setEmptyText

public void setEmptyText(java.lang.String emptyText)

Sets the text to display when the ItemSource connected to the schedule component is empty.

The ItemSource hooked up to the schedule component is empty when the item source contains no InfoObject. For example, when IEnterpriseItem.getInfoobject()==null or EnterpriseItems.getInfoObjects().size() == 0

Parameters:

emptyText - A String that specifies the text to display when the schedule component is empty.

getLoggedOffText

public java.lang.String getLoggedOffText()

Gets the text to display when the user attempts to access the component while they are logged off.

Returns:

A String that specifies the text to display when the user is logged off and they attempt to access the component.

setLoggedOffText

public void setLoggedOffText(java.lang.String loggedOffText)

Sets the text to display when the user attempts to access the component while they are logged off.

Parameters:

loggedOffText - A String that specifies the text to display when the user is logged off and they attempt to access the component.

getStyleClass

public java.lang.String getStyleClass()

Gets the CSS style class to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.

Returns:

A String that specifies the value of the styleClass property.

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Sets the CSS style class to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.

Parameters:

styleClass - A String that specifies the value of the styleClass property.

getSubmitButton

public SubmitButtonProps getSubmitButton()

Gets an instance of the SubmitButtonProps class which specifies the properties of the submit button.

Returns:

an instance of the SubmitButtonProps class which specifies the properties of the submit button.

setSubmitButton

public void setSubmitButton(SubmitButtonProps submitButton)

Sets an instance of the SubmitButtonProps class which specifies the properties of the submit button.

Parameters:

submitButton - an instance of the SubmitButtonProps class which specifies the properties of the submit button.

getLabelAlignment

public int getLabelAlignment()

Gets the alignment of the label.

Returns:

the horizontal alignment of all labels as an int

setLabelAlignment

public void setLabelAlignment(int labelAlignment)

Sets the horizontal alignment of the label.

Parameters:

labelAlignment - the horizontal alignment of the label as an int

submit

public void submit(IItemSource item)
            throws SDKException

Applies the changes to the schedule properties of the item source passed in.

Parameters:

an - IItemSource object that contains the schedule item information.

Throws:

SDKException

checkItemType

public abstract boolean checkItemType()

For internal use only.

getItemSource

public IItemSource getItemSource()

Gets the source of the item bound to the component.

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

Overrides:

getItemSource in class UIBaseControl

Returns:

An IItemSource object.

saveState

public java.lang.Object saveState(FacesContext context)

For internal use only.

Overrides:

saveState in class UIBaseControl

restoreState

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

For internal use only.

Overrides:

restoreState in class UIBaseControl