Members
(constant) KEYCODES
Mapping to be used to match keyCodes
returned from keydown events.
- Source:
(constant) MAX_ITEMS
Maximum number of items to be shown without the Search bar
- Source:
(constant) RULE
Copyright (c) 2000-present Liferay, Inc. All rights reserved.
This library is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the Free
Software Foundation; either version 2.1 of the License, or (at your option)
any later version.
This library is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
details.
- Source:
Methods
App()
Exporting default application to Forms Admin. Only Providers and
routing must be defined.
- Source:
appendValue(options) → {Array}
Appends a new value on the current value state
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object |
Properties
|
- Source:
Returns:
- Type
- Array
AutoSaveProvider()
AutoSave performs a periodic routine in minutes to save the current form. Save will
only happen if the data on the form changes.
Each time the rules are changed, the form is saved.
- Source:
convertValueToJSON()
Copyright (c) 2000-present Liferay, Inc. All rights reserved.
This library is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the Free
Software Foundation; either version 2.1 of the License, or (at your option)
any later version.
This library is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
details.
- Source:
createFormURL()
Copyright (c) 2000-present Liferay, Inc. All rights reserved.
This library is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the Free
Software Foundation; either version 2.1 of the License, or (at your option)
any later version.
This library is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
details.
- Source:
dedupValue()
Deduplicates the value by checking if there is a
value in the fields, always incrementing an integer
in front of the value to be friendly for the user.
- Source:
ManagementToolbar()
This is a fake component that only takes advantage of the React lifecycle
to manipulate the visibility of the Management Toolbar, it is currently
rendered via JSP and it is necessary to control visibility via JavaScript.
Creates a simulation that this component is in React and deals with the
visibility of elements in the DOM and events such as click.
- Source:
NavigationBar()
This is a fake component that only takes advantage of the React lifecycle to
change the React Router route, currently the component is rendered via JSP
and it is necessary to control the interaction via JavaScript.
- Source:
normalizePages()
NormalizePages deals with manipulations of the Field to change behaviors or
fixes something specific to the structure that affects the Field.
Called only at application startup, but adds an initial computing load
to traverse through all fields on the form as well as nested fields.
- Source:
normalizeValue()
If the value is null or undefined, normalize follows a
verification order and the final stage of normalization
is to deduplicate the value if necessary.
1. If the current value is null, use the default value that can be the label
or the default option name, the parameter generateValueUsingLabel
decides which of these two values will be used.
2. If the default value is null, use the string Option.
- Source:
Panel()
Alternative component for ClayPanel,
since the original component don't have to much flexibility
for adding items on the ClayPanel trigger.
- Source:
removeValue(options) → {Array}
Removes a value from the value array.
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object |
Properties
|
- Source:
Returns:
- Type
- Array
Report()
This is a fake component that only takes advantage of the React lifecycle to
manipulate the visibility of the report page, it is currently rendered via
JSP and it is necessary to control visibility via JavaScript.
- Source:
setJSONArrayValue()
Copyright (c) 2000-present Liferay, Inc. All rights reserved.
This library is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the Free
Software Foundation; either version 2.1 of the License, or (at your option)
any later version.
This library is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
details.
- Source:
toArray(value)
Wraps the given argument into an array.
Parameters:
| Name | Type | Description |
|---|---|---|
value |
Array | String |
- Source:
useBack()
useBack is a hook that adds middleware to the Back button of the DXP Control
Menu to alert the user if there is any change in the form that has not
been saved.
- Source:
useStateSync()
This hook is just a way to save the state in the hidden input of the form
to make the submit, this is the same implementation of StateSyncronizer.
- Source:
useSyncValue()
Use Sync Value to synchronize the initial value with the current internal
value, only update the internal value with the new initial value if the
values are different and when the value is not changed for more than ms.