org.kuali.rice.krad.uif.component
Interface ScriptEventSupport

All Known Subinterfaces:

Component, Container, Control, Field, Widget

All Known Implementing Classes:

ActionField, AjaxActionField, BlankField, BreadCrumbs, CheckboxControl, CheckboxGroupControl, CollectionGroup, ComponentBase, ContainerBase, ControlBase, DataField, DatePicker, DirectInquiry, Disclosure, DocumentView, ErrorsField, FieldBase, FieldGroup, FileControl, FormView, GenericField, Group, GroupControl, Growls, HeaderField, Help, HiddenControl, IframeField, ImageField, InputField, Inquiry, InquiryView, LabelField, LightBox, LightBoxLookup, LinkField, LinkGroup, LookupInputField, LookupView, MaintenanceView, MessageField, MultiValueControlBase, NavigationGroup, PageGroup, QuickFinder, RadioGroupControl, RemoteFieldsHolder, Reorderer, ReorderingGroup, RichTable, SelectControl, Spinner, SpinnerControl, Suggest, TabGroup, Tabs, TextAreaControl, TextControl, Tree, TreeGroup, UserControl, View, WidgetBase

public interface ScriptEventSupport

Declares methods for determining which client side events are supported by a Component and methods for retrieving the event 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

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	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
boolean	getSupportsOnBlur() Indicates whether the component supports the onBlur event
boolean	getSupportsOnChange() Indicates whether the component supports the onChange event
boolean	getSupportsOnClick() Indicates whether the component supports the onClick event
boolean	getSupportsOnClose() Indicates whether the component supports the onClose event
boolean	getSupportsOnDblClick() Indicates whether the component supports the onDblClick event
boolean	getSupportsOnDocumentReady() Indicates whether the component supports the document ready event
boolean	getSupportsOnFocus() Indicates whether the component supports the onFocus event
boolean	getSupportsOnKeyDown() Indicates whether the component supports the onKeyDown event
boolean	getSupportsOnKeyPress() Indicates whether the component supports the onKeyPress event
boolean	getSupportsOnKeyUp() Indicates whether the component supports the onKeyUp event
boolean	getSupportsOnLoad() Indicates whether the component supports the onLoad event
boolean	getSupportsOnMouseDown() Indicates whether the component supports the onMouseDown event
boolean	getSupportsOnMouseMove() Indicates whether the component supports the onMouseMove event
boolean	getSupportsOnMouseOut() Indicates whether the component supports the onMouseOut event
boolean	getSupportsOnMouseOver() Indicates whether the component supports the onMouseOver event
boolean	getSupportsOnMouseUp() Indicates whether the component supports the onMouseUp event
boolean	getSupportsOnSubmit() Indicates whether the component supports the onSubmit event
boolean	getSupportsOnUnload() Indicates whether the component supports the onUnload event
void	setOnBlurScript(String script) Setter for the onblur script
void	setOnDocumentReadyScript(String script) Setter for the onDocumentReadyScript
void	setOnLoadScript(String script) Setter for the onLoad script

Method Detail

getSupportsOnLoad

boolean getSupportsOnLoad()

Indicates whether the component supports the onLoad event

Returns:

boolean true if event is supported, false if the event is not supported

getOnLoadScript

String getOnLoadScript()

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

Returns:

String JavaScript code

setOnLoadScript

void setOnLoadScript(String script)

Setter for the onLoad script

Parameters:

script - - script for on load

getSupportsOnDocumentReady

boolean getSupportsOnDocumentReady()

Indicates whether the component supports the document ready event

Returns:

boolean true if event is supported, false if the event is not supported

setOnDocumentReadyScript

void setOnDocumentReadyScript(String script)

Setter for the onDocumentReadyScript

Parameters:

script - - script for onDocumentReadyScript

getOnDocumentReadyScript

String getOnDocumentReadyScript()

Script to be run when the document ready event is triggered

Returns:

the onDocumentReadyScript

getSupportsOnUnload

boolean getSupportsOnUnload()

Indicates whether the component supports the onUnload event

Returns:

boolean true if event is supported, false if the event is not supported

getOnUnloadScript

String getOnUnloadScript()

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

Returns:

String JavaScript code

getSupportsOnClose

boolean getSupportsOnClose()

Indicates whether the component supports the onClose event

Returns:

boolean true if event is supported, false if the event is not supported

getOnCloseScript

String getOnCloseScript()

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

Returns:

String JavaScript code

getSupportsOnBlur

boolean getSupportsOnBlur()

Indicates whether the component supports the onBlur event

Returns:

boolean true if event is supported, false if the event is not supported

getOnBlurScript

String getOnBlurScript()

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

Returns:

String JavaScript code

setOnBlurScript

void setOnBlurScript(String script)

Setter for the onblur script

Parameters:

script -

getSupportsOnChange

boolean getSupportsOnChange()

Indicates whether the component supports the onChange event

Returns:

boolean true if event is supported, false if the event is not supported

getOnChangeScript

String getOnChangeScript()

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

Returns:

String JavaScript code

getSupportsOnClick

boolean getSupportsOnClick()

Indicates whether the component supports the onClick event

Returns:

boolean true if event is supported, false if the event is not supported

getOnClickScript

String getOnClickScript()

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

Returns:

String JavaScript code

getSupportsOnDblClick

boolean getSupportsOnDblClick()

Indicates whether the component supports the onDblClick event

Returns:

boolean true if event is supported, false if the event is not supported

getOnDblClickScript

String getOnDblClickScript()

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

Returns:

String JavaScript code

getSupportsOnFocus

boolean getSupportsOnFocus()

Indicates whether the component supports the onFocus event

Returns:

boolean true if event is supported, false if the event is not supported

getOnFocusScript

String getOnFocusScript()

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

Returns:

String JavaScript code

getSupportsOnSubmit

boolean getSupportsOnSubmit()

Indicates whether the component supports the onSubmit event

Returns:

boolean true if event is supported, false if the event is not supported

getOnSubmitScript

String getOnSubmitScript()

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

Returns:

String JavaScript code

getSupportsOnKeyPress

boolean getSupportsOnKeyPress()

Indicates whether the component supports the onKeyPress event

Returns:

boolean true if event is supported, false if the event is not supported

getOnKeyPressScript

String getOnKeyPressScript()

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

Returns:

String JavaScript code

getSupportsOnKeyUp

boolean getSupportsOnKeyUp()

Indicates whether the component supports the onKeyUp event

Returns:

boolean true if event is supported, false if the event is not supported

getOnKeyUpScript

String getOnKeyUpScript()

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

Returns:

String JavaScript code

getSupportsOnKeyDown

boolean getSupportsOnKeyDown()

Indicates whether the component supports the onKeyDown event

Returns:

boolean true if event is supported, false if the event is not supported

getOnKeyDownScript

String getOnKeyDownScript()

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

Returns:

String JavaScript code

getSupportsOnMouseOver

boolean getSupportsOnMouseOver()

Indicates whether the component supports the onMouseOver event

Returns:

boolean true if event is supported, false if the event is not supported

getOnMouseOverScript

String getOnMouseOverScript()

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

Returns:

String JavaScript code

getSupportsOnMouseOut

boolean getSupportsOnMouseOut()

Indicates whether the component supports the onMouseOut event

Returns:

boolean true if event is supported, false if the event is not supported

getOnMouseOutScript

String getOnMouseOutScript()

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

Returns:

String JavaScript code

getSupportsOnMouseUp

boolean getSupportsOnMouseUp()

Indicates whether the component supports the onMouseUp event

Returns:

boolean true if event is supported, false if the event is not supported

getOnMouseUpScript

String getOnMouseUpScript()

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

Returns:

String JavaScript code

getSupportsOnMouseDown

boolean getSupportsOnMouseDown()

Indicates whether the component supports the onMouseDown event

Returns:

boolean true if event is supported, false if the event is not supported

getOnMouseDownScript

String getOnMouseDownScript()

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

Returns:

String JavaScript code

getSupportsOnMouseMove

boolean getSupportsOnMouseMove()

Indicates whether the component supports the onMouseMove event

Returns:

boolean true if event is supported, false if the event is not supported

getOnMouseMoveScript

String getOnMouseMoveScript()

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

Returns:

String JavaScript code