Component Specific Actions
Component specific actions refer to actions that are specifically designed for a certain component, providing unique functionalities and features tailored to that component's requirements.
blur
This will shift the mouse focus out of the widget automatically. This is typically used when the focus must be shifted to another widget.
clear
This can be used to clear the current value of the widget. It is a reset operation done on the widget technically.
clearAll
This can be used to clear all the items loaded onto the widget. For example, the start and end dates are cleared when this action is called.
clearCommentList
Clears all the comments list from the Comment widget.
clearDefaultValue
Clears the default value, set on the widget. It is commonly used to clear the default string from the input type widgets, and this action can be called to clear the selection when the user wants to remove the default selection for SELECT type widgets.
clearDeletedItem
Used to clear the deleted item permanently on the Comment widget.
clearEnd
Clears only the end value, set on the widget. For example - it clears the end time on the Time Range widget.
clearEvents
It deletes all the events attached to the calendar widget. As this makes the calendar events empty, this action must be called after analyzing the requirement carefully.
clearInitial
This action clears the initial step value from the widget. Makes the first value from the array as empty.
clearInvalid
Clears the invalid rule from the widget. It is to clear the items saved using 'setValid' functions on the widget.
clearKey
Clears out the tab container's value from the storage and shows it empty.
clearStart
Clears only the start value, set on the widget. For example - it clears the start time on the Time Range widget.
clearStep
Clears the initial step of the widget, and also clears the selection steps carried out.
clearSubmitedItem
Clears the comment that was submitted already by the user.
clearText
Clears the string displayed on the widget. Used to set a new message to show on the widget dynamically. This action will be used to remove the information that was shown previously using the Text Display widget.
clearValue
Clears the current value or selection from the widget. It is kind of the reset operation performed on the widget. Typically used to clear out the values loaded before.
clearValueInItems
If the items are set on the widget, calling this function will clear those items from the widget.
clearVisible
Clears the visible property, set previously using the 'setVisible()' action on the Modal and Drawer widgets.
click
Automates the mouse click event on the widget. This executes the actions that are carried out when the user clicks on the element.
closeDrawer
Used to close the Drawer widget. This can be used in the scenario where the user wants to close the drawer just after the information captured is submitted.
closeModal
Used to close the Modal widget. This can be used in the scenario where the user wants to close the modal just after the information captured is submitted.
deselectValue
It is the opposite of the selection action on the Multi Select widget. This method removes the current selection from the Multi Select widget.
disable
Makes the widget a read-only element on the screen, and the user cannot work with the widget thereafter.
focus
Sets the focus on the widget and highlights the control. It is used to set focus on input types fields often, to give users the focus to enter or edit the value.
hide
Makes the widget invisible, thus hiding the element from the screen. The users will not be able to see the widget and make any changes.
openDrawer
This action opens up an existing Drawer widget. This will, in turn, display all the controls placed on the drawer.
openModal
This action opens up an existing Modal widget. This will, in turn, display all the controls placed on the modal.
reset
It is usually called on Forms when the user wants to get the widget back to its initial state. This action resets the form and its elements.
resetAll
This action is same as the 'reset()' method, and it is specific to range-type widgets. It resets both the start and end values when it is called.
resetCommentList
This will reset the comment list associated with the widget and the user must re-associate the comment if need be.
resetDefaultValue
It clears out the default value specified for the widget. This means there is no default value associated with the element until a new value is assigned to the widget as default.
resetDeletedItem
It resets the deleting item set by 'setDeletedItem' or deleteditem array and it comes back to normal state.
resetEnd
This action is related to the range-type widgets which have the start and end values. It resets only the end value, without disturbing the start value.
resetEvents
The user can call this action to reset the events on the calendar widget. The element is set back to its initial state after the action is complete.
resetInitial
It resets the inital step performed by 'setInitial' step and it comes back to normal state.
resetInvalid
This action resets or clears out the work performed using 'setInvalid' action.
resetKey
This resets the tabbed container key perormed by 'setKey' and it comes back to normal state.
resetSelections
Sets the row and column selections, done by the user, back to the original state. This action removes the selection made by the user on the Table widget.
resetStart
This action is related to the range-type widgets which have the start and end values. It resets only the start value, without disturbing the end value.
resetStep
This action resets the step carried out by 'setStep' and it comes back to normal state.
resetSubmitedItem
It resets the submited item, done by 'setSubmIted' items or array and it come back to normal state.
resetText
This is specific to the Text Display widget, where this action clears and resets the string text displayed to its original value.
resetValue
It is the most commonly available method and can be applied to most of the widgets. This action removes the current value or selection, and resets to the original value or selection.
resetVisible
Resets the visibility of the Modal and Drawer widgets. Assigns the visibility property to its original state, either True or False. This decides whether to show or hide the widget.
select
This automates the selection of the value on the widget. As a result, the value is selected automatically for the user to work on. It is mostly called on the input type widgets.
selectValue
When using the Multi Select widget, the user can call this action to select a particular value from the list of options attached to the element.
setData
Pass a valid JSON array using this action and set the fields for the form widget. This will be used to define the fields and values of the form dynamically.
setDefaultValue
The user can call this action and set a default value to the widget and load the widget on to the screen. It is one of the sample scenarios, and this method will be useful to define a default value to the widget before the user calls the widget to the screen.
setDeletedItem
It will set the deleting item from the comment widget.
setDisabledState
It will set the input widget to the disabled state, making the widget as non-editable.
setEnd
Used to assign only the end value to the range-type widgets. The start value on the widget is not disturbed. This can be used when the max limit for the range widget is changed and the user wants to set a new end value.
setEvents
Provide the valid JSON array that contains the events and related details to this action, and that will load the Calendar with the events provided.
setFilter
It is related to the Table widget and the parameter passed will be used as the filter, and the action filters the table data with filter parameter.
setInitial
This action sets the index number that decides where the widget's step should start. By default, the index is 0 and the widget's step starts from here.
setInvalid
This action sets which value should be made invalide when it is called.
setKey
Changes the 'selectedTabKey' for the Tab Container widget. If the 'selectedTabKey' is 'Tab2' then providing 'Tab1' will change the value.
setPage
Calling this action by passing the page number as the parameter will take the user to the mentioned page number on the widget.
setRangeText
This action is used to replace a particular string on the widget. The user will need to pass the start index, end index numbers along with the replacement text to overwrite the existing value, from the start index to the end index mentioned.
setSelectionRange
Assigns the start and end index within the text on the widget, to focus/highlight. This will focus that particular text within the selection range mentioned using start and end indexes.
setSort
The Table widget can be sorted by a column using this action programmatically. The user needs to pass the following parameters.
setStart
Used to assign only the start value to the range-type widgets. The end value on the widget is not disturbed. This can be used when the minimum limit for the range widget is changed and the user wants to set a new start value.
setStep
Alters or changes the current step on the 'Steps' widget programmatically.
setSubmitedItem
Pass a JSON packet/array and submit a comment to the Comment widget using the code.
setText
When the user wants to set a new text to be displayed on the widget, the user can call this action by passing the new text. It can be used on the button and text display widgets.
setValue
It is a common action to most of the input type widgets where the users can pass the new value to set on the widget. The value must be in the format accepted by the widget type. The Input type widget expects a string whereas the Number Input widget expects a number value.
setVisibility
The 'value' parameter passed to call this action must be a boolean string true/false.The user can call this action to set the visibility for the widget, either to show that on the screen or hide it.
setVisible
The 'value' parameter passed to call this action must be a boolean string true/false. The user can call this action to set the visibility for the pop-up-type widgets, to the modal on the screen or to hide it.
submit
The user can programmatically submit the details collected on the form widget using this action.
Last updated