Apex Developer Guide
jNewer Version Available
StandardSetController Class
StandardSetController objects allow you to create list controllers similar to, or as extensions
of, the pre-built Visualforce list controllers provided by Salesforce.
Namespace
Usage
The StandardSetController class also contains a prototype
object. This is a single sObject contained within the Visualforce StandardSetController class. If
the prototype object's fields are set, those values are used during the save action,
meaning that the values are applied to every record in the set controller's
collection. This is useful for writing pages that perform mass updates
(applying identical changes to fields within a collection of objects).
Instantiation
You can instantiate
a StandardSetController in either of the following ways:
- From a list of sObjects:
1List<account> accountList = [SELECT Name FROM Account LIMIT 20]; 2ApexPages.StandardSetController ssc = new ApexPages.StandardSetController(accountList); - From a query locator:
1ApexPages.StandardSetController ssc = 2new ApexPages.StandardSetController(Database.getQueryLocator([SELECT Name,CloseDate FROM Opportunity]));
Example
The following example shows how
a StandardSetController object can be used in the constructor for
a custom list controller:
1public class opportunityList2Con {
2 // ApexPages.StandardSetController must be instantiated
3 // for standard list controllers
4 public ApexPages.StandardSetController setCon {
5 get {
6 if(setCon == null) {
7 setCon = new ApexPages.StandardSetController(Database.getQueryLocator(
8 [SELECT Name, CloseDate FROM Opportunity]));
9 }
10 return setCon;
11 }
12 set;
13 }
14
15 // Initialize setCon and return a list of records
16 public List<Opportunity> getOpportunities() {
17 return (List<Opportunity>) setCon.getRecords();
18 }
19}The following Visualforce markup shows how the controller above can be used in a page:
1<apex:page controller="opportunityList2Con">
2 <apex:pageBlock>
3 <apex:pageBlockTable value="{!opportunities}" var="o">
4 <apex:column value="{!o.Name}"/>
5 <apex:column value="{!o.CloseDate}"/>
6 </apex:pageBlockTable>
7 </apex:pageBlock>
8</apex:page>StandardSetController Constructors
The following are constructors for StandardSetController.
StandardSetController(queryLocator)
Creates an instance of the ApexPages.StandardSetController class for the list of objects returned by the query
locator.
Signature
public StandardSetController(Database.QueryLocator queryLocator)
Parameters
- queryLocator
- Type: Database.QueryLocator
- A query locator representing a list of sObjects.
StandardSetController(controllerSObjects)
Creates an instance of the ApexPages.StandardSetController class for the specified list of standard or custom
objects.
Signature
public StandardSetController(List<sObject> controllerSObjects)
Example
1List<account> accountList = [SELECT Name FROM Account LIMIT 20];
2ApexPages.StandardSetController ssc = new ApexPages.StandardSetController(accountList);StandardSetController Methods
The following are methods for StandardSetController. All are instance methods.
cancel()
Returns the PageReference of the original page, if known,
or the home page.
Signature
public System.PageReference cancel()
Return Value
Type: System.PageReference
getCompleteResult()
Indicates whether there are more records in the set than
the maximum record limit. If this is false, there are more records
than you can process using the list controller. The maximum record
limit is 10,000 records.
Signature
public Boolean getCompleteResult()
Return Value
Type: Boolean
getFilterId()
Returns the ID of the filter that is currently in context.
Signature
public String getFilterId()
Return Value
Type: String
getHasNext()
Indicates whether there are more records after the current
page set.
Signature
public Boolean getHasNext()
Return Value
Type: Boolean
getHasPrevious()
Indicates whether there are more records before the current
page set.
Signature
public Boolean getHasPrevious()
Return Value
Type: Boolean
getListViewOptions()
Returns a list of the listviews available to the current
user.
Signature
public System.SelectOption getListViewOptions()
Return Value
Type: System.SelectOption[]
getPageNumber()
Returns the page number of the current page set. Note that
the first page returns 1.
Signature
public Integer getPageNumber()
Return Value
Type: Integer
getPageSize()
Returns the number of records included in each page set.
Signature
public Integer getPageSize()
Return Value
Type: Integer
getRecord()
Returns the sObject that represents the changes to the
selected records. This retrieves the prototype object contained within
the class, and is used for performing mass updates.
Signature
public sObject getRecord()
Return Value
Type: sObject
getRecords()
Returns the list of sObjects in the current page set. This
list is immutable, i.e. you can't call clear() on it.
Signature
public sObject[] getRecords()
Return Value
Type: sObject[]
getResultSize()
Returns the number of records in the set.
Signature
public Integer getResultSize()
Return Value
Type: Integer
getSelected()
Returns the list of sObjects that have been selected.
Signature
public sObject[] getSelected()
Return Value
Type: sObject[]
previous()
Returns the previous page of records.
Signature
public Void previous()
Return Value
Type: Void
save()
Inserts new records or updates existing records that have
been changed. After this operation is finished, it returns a PageReference
to the original page, if known, or the home page.
Signature
public System.PageReference save()
Return Value
Type: System.PageReference
setFilterID(filterId)
Sets the filter ID of the controller.
Signature
public Void setFilterID(String filterId)
Parameters
- filterId
- Type: String
Return Value
Type: Void
setpageNumber(pageNumber)
Sets the page number.
Signature
public Void setpageNumber(Integer pageNumber)
Parameters
- pageNumber
- Type: Integer
Return Value
Type: Void
setPageSize(pageSize)
Sets the number of records in each page set.
Signature
public Void setPageSize(Integer pageSize)
Parameters
- pageSize
- Type: Integer
Return Value
Type: Void
setSelected(selectedRecords)
Set the selected records.
Signature
public Void setSelected(sObject[] selectedRecords)
Parameters
- selectedRecords
- Type: sObject[]
Return Value
Type: Void