public class

PreferencesScheduleTransform

extends PreferencesGeneralTransform

java.lang.Object
↳	com.microstrategy.web.transform.AbstractTransform
	↳	com.microstrategy.web.transform.AbstractLayoutTransform
		↳	com.microstrategy.web.app.transforms.AbstractAppTransform
			↳	com.microstrategy.web.app.transforms.AbstractPreferencesTransform
				↳	com.microstrategy.web.app.transforms.PreferencesGenericTransform
					↳	com.microstrategy.web.app.transforms.PreferencesGeneralTransform
						↳	com.microstrategy.web.app.transforms.PreferencesScheduleTransform

Class Overview

This is the transform that render the General Preferences.

Summary

[Expand]

Inherited Constants

From class com.microstrategy.web.app.transforms.PreferencesGeneralTransform

String	FP_ADD_IMAGE	Constant specifying the name of the formal parameter for defining the add image on the shopping cart.
String	FP_AVAILABLE_SIZE	Constant specifying the name of the formal parameter for defining the size of the available list box shopping cart for selecting fonts.
String	FP_COLOR_THEME_PICKER_NAME	Constant specifying the name of the formal parameter for defining the name of the Color Theme picker that provides the color theme options.
String	FP_CREATE_PAGE_NAME	Constant specifying the name of the formal parameter for defining the name of the Create Reports folder page, as specified on the Page Configuration file.
String	FP_DOCUMENT_BEAN_NAME	Constant specifying the name of the formal parameter for defining the name of the document bean.
String	FP_DOCUMENT_PAGE_NAME	Constant specifying the name of the formal parameter for defining the name of the Document page, as specified on the Page Configuration file.
String	FP_DOWN_IMAGE	Constant specifying the name of the formal parameter for defining the down image on the shopping cart.
String	FP_FOLDER_BEAN_NAME	Constant specifying the name of the formal parameter for defining the name of the folder bean.
String	FP_FONT_NAME_PICKER_NAME	Constant specifying the name of the formal parameter for defining the name of the system picker that provides the font name options.
String	FP_HTML5_VI_PAGE_NAME	Constant specifying the name of the formal parameter for defining the name of the HTML5 VI page, as specified on the Page Configuration file.
String	FP_MY_PAGE_NAME	Constant specifying the name of the formal parameter for defining the name of the My Reports folder page, as specified on the Page Configuration file.
String	FP_OIVM_PAGE_NAME	Constant specifying the name of the formal parameter for defining the name of the oivm page, as specified on the Page Configuration file.
String	FP_REMOVE_IMAGE	Constant specifying the name of the formal parameter for defining the remove image on the shopping cart.
String	FP_REPORT_BEAN_NAME	Constant specifying the name of the formal parameter for defining the name of the report bean.
String	FP_REPORT_FRAME_BEAN_NAME	Constant specifying the name of the formal parameter for defining the name of the report frame bean.
String	FP_REPORT_PAGE_NAME	Constant specifying the name of the formal parameter for defining the name of the Report page, as specified on the Page Configuration file.
String	FP_RW_DOCUMENT_BEAN_NAME	Constant specifying the name of the formal parameter for defining the name of the report writing document bean.
String	FP_RW_DOCUMENT_PAGE_NAME	Constant specifying the name of the formal parameter for defining the name of the Report Writing Document page, as specified on the Page Configuration file.
String	FP_SEARCH_OBJECT_TYPES_PICKER_NAME	Constant specifying the name of the formal parameter for defining the name of the search object types picker that provides the search object types.
String	FP_SELECTED_SIZE	Constant specifying the name of the formal parameter for defining the size of the selected list box shopping cart for selecting fonts.
String	FP_SHARED_PAGE_NAME	Constant specifying the name of the formal parameter for defining the name of the Shared Reports folder page, as specified on the Page Configuration file.
String	FP_START_PAGES_PICKER_NAME	Constant specifying the name of the formal parameter for defining the name of the system picker that provides the start page options.
String	FP_TIME_ZONES_PICKER_NAME	Constant specifying the name of the formal parameter for defining the name of the system picker that provides the time zone options.
String	FP_UP_IMAGE	Constant specifying the name of the formal parameter for defining the up image on the shopping cart.
String	PREFERENCE_ALLOW_OVERWRITE_WITHOUT_WARNING
String	PREFERENCE_ALLOW_OVERWRITE_WITH_WARNING
String	PREFERENCE_DISALLOW_OVERWRITE

From class com.microstrategy.web.app.transforms.PreferencesGenericTransform

From class com.microstrategy.web.app.transforms.AbstractPreferencesTransform

From class com.microstrategy.web.app.transforms.AbstractAppTransform

From interface com.microstrategy.web.objects.EnumWebPreferences

[Expand]

Inherited Fields

From class com.microstrategy.web.app.transforms.PreferencesGeneralTransform

protected String	_addImage	This field is deprecated. The formal parameter this property is related to has been deprecated
protected String	_downImage	This field is deprecated. The formal parameter this property is related to has been deprecated
protected String	_removeImage	This field is deprecated. The formal parameter this property is related to has been deprecated
protected String	_upImage	This field is deprecated. The formal parameter this property is related to has been deprecated
protected FormalParameter	addImage	This field is deprecated. The image is now defined with a CSS style (`add`), which should be updated if another image is to be used
protected FormalParameter	availableSize	Specifies the size of the Available listbox of the shopping cart used to select the application's fonts.
protected FormalParameter	colorThemePickerName	Indicates the name of the system picker that contains the color themes that shall be displayed to the user as possible options for color theme in preferences section of the application.
protected FormalParameter	createPageName	Specifies the name of the page that displays the contents of Create Reports, as defined on the Page Configuration File.
protected FormalParameter	documentBeanName	Specifies the name of the bean that displays the documents' content.
protected FormalParameter	documentPageName	Specifies the name of the page that displays the documents' contents, as defined on the Page Configuration File.
protected FormalParameter	downImage	This field is deprecated. The image is now defined with a CSS style (`down`), which should be updated if another image is to be used
protected FormalParameter	folderBeanName	Specifies the name of the bean that displays the folders' contents.
protected FormalParameter	fontNamePickerName	Indicates the name of the system picker that contains the font names that shall be displayed to the user as possible options for fonts to use on the application.
protected FormalParameter	html5VIPageName	Indicates the name of the html5vi dashboard
protected FormalParameter	myPageName	Specifies the name of the page that displays the contents of My Reports, as defined on the Page Configuration File.
protected FormalParameter	oivmPageName	Indicates the name of the oivm document
protected FormalParameter	removeImage	This field is deprecated. The image is now defined with a CSS style (`remove`), which should be updated if another image is to be used
protected FormalParameter	reportBeanName	Specifies the name of the bean that displays the reports' content.
protected FormalParameter	reportFrameBeanName	Specifies the name of the bean that contains the report bean and other editor/toolbar beans.
protected FormalParameter	reportPageName	Specifies the name of the page that displays the reports' contents, as defined on the Page Configuration File.
protected FormalParameter	rwDocumentBeanName	Specifies the name of the bean that displays the report writing documents' content.
protected FormalParameter	rwDocumentPageName	Specifies the name of the page that displays the report writing documents' contents, as defined on the Page Configuration File.
protected FormalParameter	searchObjectTypesPickerName	Indicates the name of the system picker that contains the all search object types that shall be displayed to the Admin user as available options for search object types in preferences section of the application.
protected FormalParameter	selectedSize	Specifies the size of the Selected listbox of the shopping cart used to select the application's fonts.
protected FormalParameter	sharedPageName	Specifies the name of the page that displays the contents of Shared Reports, as defined on the Page Configuration File.
protected FormalParameter	startPagesPickerName	Indicates the name of the system picker that contains the start pages that shall be displayed to the user as possible start pages in the application.
protected FormalParameter	timeZonesPickerName	Indicates the name of the system picker that contains the time zones that shall be displayed to the user as possible options for time zones in preferences section of the application.
protected FormalParameter	upImage	This field is deprecated. The image is now defined with a CSS style (`up`), which should be updated if another image is to be used

From class com.microstrategy.web.app.transforms.AbstractPreferencesTransform

From class com.microstrategy.web.app.transforms.AbstractAppTransform

protected final String	CLASS_INPUT	This field is deprecated. This property is not used anymore by the transform.
protected final String	CLASS_MESSAGE	This field is deprecated. This property is not used anymore by the transform.
protected WebComponent	_bean	Instance of `WebComponent` being transformed.
protected ComponentBlock	_componentBlock
protected String	_cssPrefix	Property corresponding to the value of the `cssPrefix` formal parameter
protected String	_imgBlank	Field that containts the URL location of a blank image (used as the source of most <IMG> tags as the real URL is specified through css).
protected String	_imgWait	This field is deprecated. This value is not used anymore by the Transform as the wait image is included using css.
protected MarkupOutput	_selfOutput	This field is deprecated. this field is no longer used since partial update blocks are now generated via `ComponentBlock`
protected MarkupOutput	_subOutput	This field is deprecated. this field is no longer used since partial update blocks are now generated via `ComponentBlock`
public FormalParameter	appliesTo	This parameter informs the javascript the id of the bone the actions of this component applies to.
public FormalParameter	contextMenus	This formal parameter is used by the Transform to identify the context-menus definition.
public FormalParameter	cssFile	CSS file that includes the style definition.
public FormalParameter	cssPrefix	Prefix to append to all css class names.
public FormalParameter	debugErrorFlags	Indicates which extra debug information to include in case of an error.
public FormalParameter	debugFlags	Indicates which debug information to include.
public FormalParameter	dragMode	Indicates the drag mode that the component to render will have.
public FormalParameter	extraInput	Indicates any extra inputs to be included in the forms generated by the transform.
public FormalParameter	extraUrl	Indicates any extra parameters to be included in the links generated by the transform.
public FormalParameter	globalCssErrorMessage	This field is deprecated. The css class to use cannot be controlled through a formal parameter anymore.
public FormalParameter	globalCssErrorTitle	This field is deprecated. The css class to use cannot be controlled through a formal parameter anymore.
public FormalParameter	height	Indicates the default height of the component.
public FormalParameter	iframeEnabled	Indicates whether the transform supports iframe manipulations.
public FormalParameter	imgWait	This field is deprecated. This value is not used anymore by the Transform as the wait image is included using css.
protected int	indent	This field is deprecated. Indentation is not appended by Transforms anymore. Although it provided a somewhat better looking HTML source, it also affected performance by increasing the HTML size.
public FormalParameter	initialIndent	This field is deprecated. Indentation is not appended by Transforms anymore. Although it provided a somewhat better looking HTML source, it also affected performance by increasing the HTML size.
protected boolean	isDHTML	This field is deprecated. Use `isDhtml()`.
public FormalParameter	orientation	Indicates the orientation the dialog to render will have.
public FormalParameter	orientationsAllowed	Indicates the orientation modes allowed for the dialog to render.
public FormalParameter	partialIframeUpdate	This formal parameter specifies whether we should replace the whole contentst of the div shell (outerHTML) or the just the inner contents (innerHTML) of that shell div for the transform when the iframe update is going on.
public FormalParameter	processingButtonsFlags	Indicates which buttons to include on the wait page.
public FormalParameter	processingInfoFlags	Indicates which information to include on the wait page.
public FormalParameter	resizeLevel	Indicates whether the component can be resized vertically/horizontally or both or none.
public FormalParameter	scriptClass	Holds the name of the javaScript class (if any) to be associated with the component.
protected static final ScriptVariableJSONEncoder	scriptEndTagEncoder	reference to encoder that deals with tag encoding
public FormalParameter	type	This parameter is used when the output of this Transform generates a corresponding Microstrategy bone in the page, and it informs the javascript the type of bone it is.
public FormalParameter	useDHTML	Indicates whether to use DHTML on the output.
public FormalParameter	width	Indicates the default width of the component.

From interface com.microstrategy.web.objects.EnumWebPreferences

Public Constructors
	PreferencesScheduleTransform()

Public Methods
WebEvent	getEventCancel() Returns the event to cancel editing or saving an address.
WebEvent	getEventSave() Returns the event to save the address currently being editing
void	initializeTransform(Transformable data) Extends `initializeTransform` by keeping its own copy of the data.
void	renderCancel(MarkupOutput out)
void	renderFormEnd(MarkupOutput out, WebEvent event) Renders the Form end tag
void	renderFormStart(MarkupOutput out, WebEvent event) Renders the start of the Preference's Form.
void	renderHiddenInputs(MarkupOutput out) Renders the FORM end tag.
void	renderSave(MarkupOutput out)
void	renderScheduleShoppingCart(MarkupOutput out)
void	renderScheduleTypes(MarkupOutput out) Renders 'Schedule Types' preference.
void	renderUpdateConfirmation(MarkupOutput out) Render a confirmation message to show updating is successful or error happened.
void	renderWarning(MarkupOutput out) Render a warning message when users select schedules.

[Expand]

Inherited Methods

From class com.microstrategy.web.app.transforms.PreferencesGeneralTransform

From class com.microstrategy.web.app.transforms.PreferencesGenericTransform

boolean	checkPreferenceValue(String preferenceEnumName, String prefValue, String prefLevel) This method checks if the value of a particular preference at a particular level is equal to a value which the user wants to check against.
List	getAllowableValues(String preferenceEnumName)
void	renderAllowSaveFlash(MarkupOutput out, String preferenceEnumName, String descriptorID) render a select box for allow save over flash dashboard in HTML5.
void	renderAsCheckBox(MarkupOutput out, String preferenceEnumName, String descriptorID) Renders the particular preference as a check box along with the descriptor text next to the preference.
void	renderAsChecklist(MarkupOutput out, String preferenceName, String onclick) Render the list of allowable values as CheckBox list
void	renderAsComboBox(MarkupOutput out, String preferenceEnumName, String descriptorID) Renders the particular preference as a set of options within a select box.
void	renderAsComboBox(MarkupOutput out, String preferenceEnumName, String descriptorID, Map<String, String> attributes)
void	renderAsComboBox(MarkupOutput out, String preferenceEnumName, String descriptorID, String desc)
void	renderAsRadio(MarkupOutput out, String preferenceEnumName, String prefValue, String descriptorID) Renders the particular preference as a radio button along with the descriptor text next to the preference.
void	renderAsRadio(MarkupOutput out, String preferenceEnumName, String orientation) Renders the particular preference as a set of radio buttons.
void	renderAsRadio(MarkupOutput out, String preferenceEnumName) Renders the particular preference as a set of radio buttons.
void	renderAsTextBox(MarkupOutput out, String preferenceEnumName, String size, String maxLength, String descriptorID) Renders the particular preference as a text box along with the descriptor text next to the preference.
void	renderCheckBox(MarkupOutput out, String preferenceEnumName) Renders the particular preference as a check box.
void	renderCheckBox(MarkupOutput out, String preferenceEnumName, String onclick) Renders the particular preference as a check box.
void	renderComboBox(MarkupOutput out, String preferenceEnumName) Renders the particular preference as a set of options within a select box.
void	renderDefaultDashboard(MarkupOutput out, String preferenceEnumName, String descriptorID) render a select box for default dashboard execution mode.
void	renderLabel(MarkupOutput out, String preferenceEnumName, String descriptorID) Renders the descriptor text for a particular preference.
void	renderLabel2(MarkupOutput out, String preferenceEnumName, String text)
void	renderPreference(String preferenceName, MarkupOutput out) This method is deprecated. No replacement.
void	renderPreference(MarkupOutput out, String preferenceName)
void	renderRadio(MarkupOutput out, String preferenceEnumName, String prefValue) Renders the particular preference as a radio button.
void	renderShortcutListAsComboBox(MarkupOutput out, String preferenceEnumName, String listName) Renders the particular preference as a set of options within a select box.
void	renderTextBox(MarkupOutput out, String preferenceEnumName, String size, String maxLength) Renders the particular preference as a text box.
void	transformBody(MarkupOutput out) Abstract method that must be override by the concrete class.

From class com.microstrategy.web.app.transforms.AbstractPreferencesTransform

From class com.microstrategy.web.app.transforms.AbstractAppTransform

From class com.microstrategy.web.transform.AbstractLayoutTransform

From class com.microstrategy.web.transform.AbstractTransform

void	addFormalParam(FormalParameterImpl formal) This method is used to add a `FormalParameterImpl` object to the transform.
boolean	canTransform(Transformable data) Checks that the transform supports specified data object and that object is in the state supported by this transform.
static List<Integer>	getEvents(RequestKeys rkeys) Determines event(s) triggered from the request keys.
FormalParameters	getFormalParams() Returns the collection of formal parameters associated with this transform.
String	getID() Returns the unique name of the component to be used as the ID for its shell
MarkupOutput	getPreview() Produces a preview output for this transform.
boolean	isPreviewAvailable() Returns true if this transform supports preview functionality, false otherwise.
boolean	isResolved() Returns whether each required formal parameter has a value associated with it.
FormalParameterImpl	removeFormalParam(String name) Removes the formal parameter with the given name from the formal parameters collection.
void	setAnnotation(FormalParameter fp, FormalParameterAnnotation fpa) Used for internal housekeeping.
void	setDeprecated(FormalParameter fp, String desc) Used for internal housekeeping.
boolean	supports(Class type) Returns true if the transform supports objects of specified type.
boolean	supports(Transformable data) Returns true if the transform supports the specified data object.

From class java.lang.Object

From interface com.microstrategy.web.app.transforms.AppTransform

From interface com.microstrategy.web.transform.LayoutTransform

From interface com.microstrategy.web.transform.Transform

abstract boolean	canTransform(Transformable data) Checks that the transform supports specified data object and that object is in the state supported by this transform.
abstract String	getDescription() Returns a textual description of the transform.
abstract FormalParameters	getFormalParams() Returns the collection of formal parameters associated with this transform.
abstract String	getID() Returns the unique name of the component to be used as the ID for its shell
abstract MarkupOutput	getPreview() This method is deprecated. This feature is not used
abstract Class	getSupportedBeanType() Returns a root class/interface supported by this transform.
abstract boolean	isPreviewAvailable() This method is deprecated. This feature is not used
abstract boolean	isResolved() Returns whether each required formal parameter has a value associated with it.
abstract boolean	supports(Class beanClass) Returns true if the transform supports objects of specified type.
abstract boolean	supports(Transformable data) Returns true if the transform supports the specified data object.
abstract void	transform(Transformable data, MarkupOutput transOut) Transforms the data object and appends result to the transOut.

Public Constructors

public PreferencesScheduleTransform ()

Public Methods

public WebEvent getEventCancel ()

Returns the event to cancel editing or saving an address.

Returns

The EnumServletEvents.WebEventCancel event.

public WebEvent getEventSave ()

Returns the event to save the address currently being editing

Returns

The EnumAddressListBeanEvents.ADDRESS_LIST_EVENT_SAVE event.

public void initializeTransform (Transformable data)

Extends initializeTransform by keeping its own copy of the data. This method initializes the private and protected fields of the transform. It also invokes the initializeTransform method of the parent.

Parameters

data	the bean to transform.

public void renderCancel (MarkupOutput out)

public void renderFormEnd (MarkupOutput out, WebEvent event)

Renders the Form end tag

Parameters

out	where to write the output of the method.

public void renderFormStart (MarkupOutput out, WebEvent event)

Renders the start of the Preference's Form. This method also renders the hidden inputs associated with the event

Parameters

out	where to write the output of the method.
event	the WebEvent to render

public void renderHiddenInputs (MarkupOutput out)

Renders the FORM end tag.

Parameters

out	The transform's output.

public void renderSave (MarkupOutput out)

public void renderScheduleShoppingCart (MarkupOutput out)

public void renderScheduleTypes (MarkupOutput out)

Renders 'Schedule Types' preference.

Parameters

out	the output object

public void renderUpdateConfirmation (MarkupOutput out)

Render a confirmation message to show updating is successful or error happened.

Parameters

out	output by this transform

public void renderWarning (MarkupOutput out)

Render a warning message when users select schedules.

Parameters

out	output by this transform

Interfaces

Classes

PreferencesScheduleTransform

Class Overview

Summary

Public Constructors

public PreferencesScheduleTransform ()

Public Methods

public WebEvent getEventCancel ()

Returns

public WebEvent getEventSave ()

Returns

public void initializeTransform (Transformable data)

Parameters

public void renderCancel (MarkupOutput out)

public void renderFormEnd (MarkupOutput out, WebEvent event)

Parameters

public void renderFormStart (MarkupOutput out, WebEvent event)

Parameters

public void renderHiddenInputs (MarkupOutput out)

Parameters

public void renderSave (MarkupOutput out)

public void renderScheduleShoppingCart (MarkupOutput out)

public void renderScheduleTypes (MarkupOutput out)

Parameters

public void renderUpdateConfirmation (MarkupOutput out)

Parameters

public void renderWarning (MarkupOutput out)

Parameters