org.kuali.rice.krad.uif.component

Interface ScriptEventSupport

All Known Subinterfaces:

CollectionGroup, Component, Container, ContentElement, Control, DataBinding, DataField, Field, Group, InputField, PageGroup, SelectControl, TextControl, Widget

All Known Implementing Classes:

Accordion, AccordionGroup, Action, ActionField, ApplicationHeader, BlockUI, BreadcrumbItem, Breadcrumbs, CheckboxControl, CheckboxGroupControl, CollectionGroupBase, ComponentBase, ComponentExhibit, ComponentLibraryView, ContainerBase, Content, ContentElementBase, ControlBase, DataFieldBase, DataTable, DatePicker, DialogGroup, Disclosure, Div, DocumentView, FieldBase, FieldGroup, FileControl, FormView, GenericField, GroupBase, GroupControl, GroupLinkField, Growls, Header, HeadLink, Help, HiddenControl, Icon, Iframe, IframeView, Image, ImageField, InputFieldBase, Inquiry, InquiryView, Label, LightBox, LightTable, Link, LinkField, LinkGroup, LocationSuggest, LookupInputField, LookupView, MaintenanceDocumentView, Message, MessageField, MessageView, MetaTag, MockView, MultiFileUploadCollection, MultiValueControlBase, NavigationBar, NextPager, NumberedPager, OptionListControl, PageGroupBase, Pager, PasswordControl, ProgressBar, ProgressBarField, QuickFinder, RadioGroupControl, RemoteFieldsHolder, RichTable, RoleLinkField, Scrollpane, SelectControlBase, SidebarNavigationGroup, Space, SpaceField, Spinner, SpinnerControl, StepProgressBar, Suggest, SyntaxHighlighter, TabGroup, TabNavigationGroup, Tabs, TextAreaControl, TextControlBase, ToggleMenu, Tooltip, TransactionalDocumentView, Tree, TreeGroup, UserControl, UserLinkField, View, ViewHeader, WidgetBase, WizardGroup

public interface ScriptEventSupport

Declares methods for retrieving the event script code

The code returned by the get*Script methods will be wrapped in the appropriate event registration code, therefore only the body needs to be returned

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

Modifier and Type	Method and Description
String	getOnBlurScript() Script that should be executed when the component's onBlur event is fired
String	getOnChangeScript() Script that should be executed when the component's onChange event is fired
String	getOnClickScript() Script that should be executed when the component's onClick event is fired
String	getOnCloseScript() Script that should be executed when the component's onClose event is fired
String	getOnDblClickScript() Script that should be executed when the component's onDblClick event is fired
String	getOnDocumentReadyScript() Script to be run when the document ready event is triggered
String	getOnFocusScript() Script that should be executed when the component's onFocus event is fired
String	getOnInputScript() Script that should be executed when the component's onInput event is fired
String	getOnKeyDownScript() Script that should be executed when the component's onKeyDown event is fired
String	getOnKeyPressScript() Script that should be executed when the component's onKeyPress event is fired
String	getOnKeyUpScript() Script that should be executed when the component's onKeyUp event is fired
String	getOnLoadScript() Script that should be executed when the component's onLoad event is fired
String	getOnMouseDownScript() Script that should be executed when the component's onMouseDown event is fired
String	getOnMouseMoveScript() Script that should be executed when the component's onMouseMove event is fired
String	getOnMouseOutScript() Script that should be executed when the component's onMouseOut event is fired
String	getOnMouseOverScript() Script that should be executed when the component's onMouseOver event is fired
String	getOnMouseUpScript() Script that should be executed when the component's onMouseUp event is fired
String	getOnSubmitScript() Script that should be executed when the component's onSubmit event is fired
String	getOnUnloadScript() Script that should be executed when the component's onUnload event is fired
void	setOnBlurScript(String onBlurScript) Script that should be executed when the component's onBlur event is fired
void	setOnChangeScript(String onChangeScript) Setter for the components onChange script
void	setOnClickScript(String onClickScript) Setter for the components onClick script
void	setOnCloseScript(String onCloseScript) Setter for the components onClose script
void	setOnDblClickScript(String onDblClickScript) Setter for the components onDblClick script
void	setOnDocumentReadyScript(String onDocumentReadyScript) Setter for the components onDocumentReady script
void	setOnFocusScript(String onFocusScript) Setter for the components onFocus script
void	setOnInputScript(String onInputScript) Setter for the components onInput script
void	setOnKeyDownScript(String onKeyDownScript) Setter for the components onKeyDown script
void	setOnKeyPressScript(String onKeyPressScript) Setter for the components onKeyPress script
void	setOnKeyUpScript(String onKeyUpScript) Setter for the components onKeyUp script
void	setOnLoadScript(String onLoadScript) Script that should be executed when the component's onLoad event is fired
void	setOnMouseDownScript(String onMouseDownScript) Setter for the components onMouseDown script
void	setOnMouseMoveScript(String onMouseMoveScript) Setter for the components onMouseMove script
void	setOnMouseOutScript(String onMouseOutScript) Setter for the components onMouseOut script
void	setOnMouseOverScript(String onMouseOverScript) Setter for the components onMouseOver script
void	setOnMouseUpScript(String onMouseUpScript) Setter for the components onMouseUp script
void	setOnSubmitScript(String onSubmitScript) Setter for the components onSubmit script
void	setOnUnloadScript(String onUnloadScript) Setter for the components onUnload script

Method Detail

getOnLoadScript

String getOnLoadScript()

Script that should be executed when the component's onLoad event is fired

Returns:

String JavaScript code

setOnLoadScript

void setOnLoadScript(String onLoadScript)

Script that should be executed when the component's onLoad event is fired

Parameters:

onLoadScript - JavaScript code

getOnDocumentReadyScript

String getOnDocumentReadyScript()

Script to be run when the document ready event is triggered

Returns:

the onDocumentReadyScript

setOnDocumentReadyScript

void setOnDocumentReadyScript(String onDocumentReadyScript)

Setter for the components onDocumentReady script

Parameters:

onDocumentReadyScript -

getOnUnloadScript

String getOnUnloadScript()

Script that should be executed when the component's onUnload event is fired

Returns:

String JavaScript code

setOnUnloadScript

void setOnUnloadScript(String onUnloadScript)

Setter for the components onUnload script

Parameters:

onUnloadScript -

getOnCloseScript

String getOnCloseScript()

Script that should be executed when the component's onClose event is fired

Returns:

String JavaScript code

setOnCloseScript

void setOnCloseScript(String onCloseScript)

Setter for the components onClose script

Parameters:

onCloseScript -

getOnBlurScript

String getOnBlurScript()

Script that should be executed when the component's onBlur event is fired

Returns:

String JavaScript code

setOnBlurScript

void setOnBlurScript(String onBlurScript)

Script that should be executed when the component's onBlur event is fired

Parameters:

onBlurScript - JavaScript code

getOnChangeScript

String getOnChangeScript()

Script that should be executed when the component's onChange event is fired

Returns:

String JavaScript code

setOnChangeScript

void setOnChangeScript(String onChangeScript)

Setter for the components onChange script

Parameters:

onChangeScript -

getOnClickScript

String getOnClickScript()

Script that should be executed when the component's onClick event is fired

Returns:

String JavaScript code

setOnClickScript

void setOnClickScript(String onClickScript)

Setter for the components onClick script

Parameters:

onClickScript -

getOnDblClickScript

String getOnDblClickScript()

Script that should be executed when the component's onDblClick event is fired

Returns:

String JavaScript code

setOnDblClickScript

void setOnDblClickScript(String onDblClickScript)

Setter for the components onDblClick script

Parameters:

onDblClickScript -

getOnFocusScript

String getOnFocusScript()

Script that should be executed when the component's onFocus event is fired

Returns:

String JavaScript code

setOnFocusScript

void setOnFocusScript(String onFocusScript)

Setter for the components onFocus script

Parameters:

onFocusScript -

getOnSubmitScript

String getOnSubmitScript()

Script that should be executed when the component's onSubmit event is fired

Returns:

String JavaScript code

setOnSubmitScript

void setOnSubmitScript(String onSubmitScript)

Setter for the components onSubmit script

Parameters:

onSubmitScript -

getOnInputScript

String getOnInputScript()

Script that should be executed when the component's onInput event is fired

This differs from key press/up or change in that it will catch autocomplete, cut, and paste mouse actions on an input.

Returns:

String JavaScript code

setOnInputScript

void setOnInputScript(String onInputScript)

Setter for the components onInput script

Parameters:

onInputScript -

getOnKeyPressScript

String getOnKeyPressScript()

Script that should be executed when the component's onKeyPress event is fired

Returns:

String JavaScript code

setOnKeyPressScript

void setOnKeyPressScript(String onKeyPressScript)

Setter for the components onKeyPress script

Parameters:

onKeyPressScript -

getOnKeyUpScript

String getOnKeyUpScript()

Script that should be executed when the component's onKeyUp event is fired

Returns:

String JavaScript code

setOnKeyUpScript

void setOnKeyUpScript(String onKeyUpScript)

Setter for the components onKeyUp script

Parameters:

onKeyUpScript -

getOnKeyDownScript

String getOnKeyDownScript()

Script that should be executed when the component's onKeyDown event is fired

Returns:

String JavaScript code

setOnKeyDownScript

void setOnKeyDownScript(String onKeyDownScript)

Setter for the components onKeyDown script

Parameters:

onKeyDownScript -

getOnMouseOverScript

String getOnMouseOverScript()

Script that should be executed when the component's onMouseOver event is fired

Returns:

String JavaScript code

setOnMouseOverScript

void setOnMouseOverScript(String onMouseOverScript)

Setter for the components onMouseOver script

Parameters:

onMouseOverScript -

getOnMouseOutScript

String getOnMouseOutScript()

Script that should be executed when the component's onMouseOut event is fired

Returns:

String JavaScript code

setOnMouseOutScript

void setOnMouseOutScript(String onMouseOutScript)

Setter for the components onMouseOut script

Parameters:

onMouseOutScript -

getOnMouseUpScript

String getOnMouseUpScript()

Script that should be executed when the component's onMouseUp event is fired

Returns:

String JavaScript code

setOnMouseUpScript

void setOnMouseUpScript(String onMouseUpScript)

Setter for the components onMouseUp script

Parameters:

onMouseUpScript -

getOnMouseDownScript

String getOnMouseDownScript()

Script that should be executed when the component's onMouseDown event is fired

Returns:

String JavaScript code

setOnMouseDownScript

void setOnMouseDownScript(String onMouseDownScript)

Setter for the components onMouseDown script

Parameters:

onMouseDownScript -

getOnMouseMoveScript

String getOnMouseMoveScript()

Script that should be executed when the component's onMouseMove event is fired

Returns:

String JavaScript code

setOnMouseMoveScript

void setOnMouseMoveScript(String onMouseMoveScript)

Setter for the components onMouseMove script

Parameters:

onMouseMoveScript -