Apex Reference Guide
jNewer Version Available
DynamicPickList Class
An abstract class, used to display the values of a picklist in a Lightning component on a Lightning page.
Namespace
Usage
To use this class as the datasource of a picklist in a Lightning component, it must be
extended by a custom Apex class and then that class must be called in the component’s design
file.
Example
Here’s an example of a custom Apex class extending the VisualEditor.DynamicPickList class.
1global class MyCustomPickList extends VisualEditor.DynamicPickList{
2
3 global override VisualEditor.DataRow getDefaultValue(){
4 VisualEditor.DataRow defaultValue = new VisualEditor.DataRow('red', 'RED');
5 return defaultValue;
6 }
7 global override VisualEditor.DynamicPickListRows getValues() {
8 VisualEditor.DataRow value1 = new VisualEditor.DataRow('red', 'RED');
9 VisualEditor.DataRow value2 = new VisualEditor.DataRow('yellow', 'YELLOW');
10 VisualEditor.DynamicPickListRows myValues = new VisualEditor.DynamicPickListRows();
11 myValues.addRow(value1);
12 myValues.addRow(value2);
13 return myValues;
14 }
15}Here’s an example of how the custom Apex class gets called in a design file so that the
picklist appears in the Lightning component.
1<design:component>
2 <design:attribute name="property1" datasource="apex://MyCustomPickList"/>
3</design:component>DynamicPickList Methods
The following are methods for DynamicPickList.
getDefaultValue()
Signature
public VisualEditor.DataRow getDefaultValue()
Return Value
Type: VisualEditor.DataRow
getLabel(attributeValue)
Signature
public String getLabel(Object attributeValue)
Parameters
- attributeValue
- Type: Object
- The value of the picklist item.
Return Value
Type: String
isValid(attributeValue)
Returns the valid state of the picklist item’s value. A picklist
value is considered valid if it’s a part of any VisualEditor.DataRow in the VisualEditor.DynamicPickListRows returned by getValues().
Signature
public Boolean isValid(Object attributeValue)
Parameters
- attributeValue
- Type: Object
- The value of the picklist item.
Return Value
Type: Boolean