Reusable Accessible Mapping PlatformOkCancelButtonBrick Class
The OkCancelButtonBrick prototype. A MultiBrick with two ButtonBricks displayed side by side and styled as OK and Cancel buttons. To instantiate, call new on the OkCancelButtonBrick prototype.
Imports RAMP Modules:
Uses RAMP Templates:
templates/bricks_template.json
Item Index
Properties
Methods
clear
()
MultiBrick
chainable
Clears the MultiBrick by clearing of the individual bricks inside the MultiBrick using their specific clear methods.
Returns:
itself
disable
-
disable -
force
Disables or re-enables the Brick.
Parameters:
Returns:
itself
displayNotice
-
notice -
[noticeTemplate]
Display a (error) notice on the brick.
Parameters:
Returns:
itself
getData
-
[wrap]
Returns MultiBrick's data by mixing together data of the individual bricks inside using their specific getData methods and then passing it to the Brick's getData method for potential wrapping.
Parameters:
-
[wrap]Boolean optionalindicates of the payload should be wrapped with a Brick's id; useful when collection information from several Bricks at once.
Returns:
MultiBrick's data
isValid
()
Boolean
Checks if the MultiBrick is valid. It's valid only if all individual bricks inside it are valid.
Returns:
true if valid; false if not
new
-
id -
config
Initializes the OkCancelButtonBrick by generating a specified template and setting defaults. Also sets a click listener on the template button. OkCancelButtonBrick is a brick with two preset buttons: OK and Cancel. Button container classes are predefined as "ok-button-brick-container" and "cancel-button-brick-container"
Parameters:
-
idStringspecified id of the Brick
-
configObjecta configuration object for the Brick
-
[header]String optionala Brick header
-
[instructions]String optionala configuration object for the Brick
-
[required]Array | Object optionalcollection of rules specifying what external conditions must be valid for the Brick to be enabled
-
[freezeStates]Array optionala set of rules specifying states Brick should be frozen
-
[baseTemplate]String optionala base template name to be used
-
[noticeTemplate]String optionala notice template name to be used
-
[containerClass]String optionala CSS class of the specific brick container
-
[template]String optionala name of the specific Brick template
-
[buttonClass]String optionala CSS class of the button in the OkCancelButtonBrick
-
[okLabel]String optionalan OK button label
-
[cancelLabel]String optionala Cancel button label
-
[okButtonClass]String optionalan OK button CSS class
-
[cancelButtonClass]String optionala Cancel button CSS class
-
[okFreezeStates]String optionalan OK button freeze states
-
[cancelFreezeStates]String optionala Cancel button freeze states
-
[reverseOrder]String optionalreverses the default visual order of OK, Cancel button to Cancel, OK.
-
Returns:
notify
-
eventName -
data
Notifies a listener of a Brick event.
Parameters:
Returns:
itself
on
-
eventName -
listener
Sets a listener on the Brick for a specified eventName.
Parameters:
Returns:
itself
setData
-
data
Sets MultiBrick's data by setting data to the individual bricks inside it. Uses their own specific setData functions. *
Parameters:
-
dataObject
Returns:
itself
setState
-
state
Sets the state of the MultiBrick by setting states of the individual bricks inside the MultiBrick using their specific setState methods.
Parameters:
-
stateStringa name of the state to set
Returns:
itself
Properties
_isFrozen
Boolean
private
Indicates if the Brick is frozen and cannot be interacted with.
Default: false
_listeners
Object
private
A collection of listeners to be notified of specified Brick events.
Default: {}
cancelButtonId
String
private
Default id of the cancel button of the Brick, cannot be changed.
Default: "cancelButton"
cancelButtonId
String
private
Default id of the cancel button of the Brick, cannot be changed.
Default: "cancelButton"
containerClass
String
private
A CSS class of the OkCancelButtonBrick container node.
Default: "okcancelbutton-brick-container"
content
Array
private
A collection of Brick objects to be displayed side by side in the MultiBrick.
Default: []
event
Object
A dictionary of possible OkCancelButtonBrick events. Adds a OK_CLICK and CANCEL_CLICK events to the default ButtonBrick events.
Example:
event: {
CHANGE: "brick/change",
CLICK: "buttonBrick/click",
OK_CLICK: "okCancelButtonBrick/okClick",
CANCEL_CLICK: "okCancelButtonBrick/cancelClick"
}
freezeStates
Array
private
A set of rules specifying states Brick should be frozen.
Default: []
Example:
[
Bricks.Brick.state.SUCCESS,
Bricks.Brick.state.ERROR
],
okButtonId
String
private
Default id of the OK button of the Brick, cannot be changed.
Default: "okButton"
required
Array
A collection of rules specifying what external conditions must be valid for the Brick to be enabled. This is not used directly by the Brick itself, but instead by the external object manipulating a collection of Bricks. Two types of rules possible: "all" and "any". Any additional properties needed can be specified.
Default: null
Example:
[
{
type: "all",
check: ["serviceType", "serviceURL"]
}
]
reverseOrder
Boolean
private
Reverses the default visual order of OK, Cancel button to Cancel, OK.
Default: "false"
state
Object
A dictionary of Brick events.
Example:
state: {
SUCCESS: "brick/success",
ERROR: "brick/error",
DEFAULT: "brick/default"
}
template
String
private
A name of the default MultiBrick template.
Default: "default_multi_brick_template"
Events
Bricks.Brick.event.CHANGE
Published whenever a Brick undergoes some change.
Event Payload:
-
dataObjectanything, usually result of calling getData() on the Brick
Bricks.OkCancelButtonBrick.event.CANCEL_CLICK
Published whenever an Cancel button of the OkCancelButtonBrick is clicked
Event Payload:
-
dataObjectanything, usually result of calling getData() on the Brick
Bricks.OkCancelButtonBrick.event.OK_CLICK
Published whenever an OK button of the OkCancelButtonBrick is clicked.
Event Payload:
-
dataObjectanything, usually result of calling getData() on the Brick