-
buildColumnList(index)
-
Sends list object from the parent kind to the layout form
Parameters:
| Name |
Type |
Description |
index |
Object
|
|
- Source:
-
clearParameters()
-
Clear all of the currently loaded parameters and bubble
parameter change events.
- Source:
-
create()
-
Setup function for the parameter widget which adds the
item management forms to the top of the kind and the
characteristics to the bottom of the kind. Also loads
the last filter choice and sets the parameter values for
this choice.
- Source:
-
defaultFilterChanged()
-
When the default filter is set, populate the
params with the values.
- Source:
-
getParameters()
-
Returns an array of the parameter search objects.
- Source:
-
getSelectedValues(options)
-
Retrieves parameter values. By default returns values as human readable
strings. Boolean options are:
* name - If true returns the parameter item control name, otherwise returns the label.
* value - If true returns the control value, other wise returns a human readable string.
* deltaDate - If true returns as string for the date difference for date widgets. (i.e. "+5").
Parameters:
| Name |
Type |
Description |
options |
Object
|
|
- Source:
-
loadItem()
-
Gets the model from the change
event and populates the fields with parameter
values from the model.
- Source:
-
populateFromUserPref()
-
Reads the last filter value from the user preferences
and populates the filter picker with this value.
- Source:
-
populateLayout(params)
-
Loops through the values in the params object
and sets the value on attribute fields in the
layout tree. Bubbles up a change event after
all of the fields are set.
Parameters:
| Name |
Type |
Description |
params |
Object
|
String
|
|
- Source:
-
populateParameters(params)
-
Loops through the values in the params object
and sets the value on the parameter fields and
bubbles up the change events.
Parameters:
| Name |
Type |
Description |
params |
String
|
|
- Source:
-
saveItem()
-
Receives the event from the item form with the user-
entered values and combines these with the other item values
for a save.
If the item name already exists for this type, it performs an edit
instead of a new insert.
- Source:
-
saveToUserPref()
-
Saves the last selected filter and layout to the user
preference table.
- Source:
-
setParameterItemValues(items)
-
Accepts an array of items to push into the parameter items. Matches item name
to component under the assumption that there will be a component by the
name of the incoming name (which itself is the name of the model attribute).
Fails silently if it cannot find the name.
Parameters:
| Name |
Type |
Argument |
Description |
items |
Array
|
|
|
item.name |
Array
|
String
|
<optional>
|
A string *or an array of strings* with the name or attr of
the attribute to be updated. In the case of an array, this function will set
any component that matches any of the names, and ignore the rest. |
item.value |
Object
|
String
|
Number
|
<optional>
|
The payload of the setValue to the ParameterItem. |
item.showing |
Boolean
|
<optional>
|
Set to false to completely hide and disable the parameter. |
- Source: