FormField
|
+--SearchResultsField
public class SearchResultsField
extends FormField
| Field Summary | |
|---|---|
| mixed | The heading of the checkbox column if the checkbox column is being displayed. |
| mixed | The sub fields for the checkboxes. |
| mixed | The sub field for the first button. |
| mixed | The sub field for entering the go to page. |
| mixed | The sub field for the go to page submit button. |
| mixed | The sub field for the header or title. |
| mixed | True if the sectionTitleHeader should be hidden. |
| mixed | True if the bottom navigation bar: page index, results and go to page, should be hidden. |
| mixed | True if the go to page section should be hidden. |
| mixed | True if the result details section should be hidden. |
| mixed | True if the rows per page section should be hidden. |
| mixed | True if the top navigation bar: page index, results and rows to page, should be hidden. |
| mixed | The sub field for the last button. |
| mixed | The sub field for the next button. |
| mixed | The error string that is display no records where found in the database. |
| mixed | The sub field that stores whether the data is sorted in ascending or descending order. |
| mixed | The sub field for the previous button. |
| mixed | The number of rows per page. |
| mixed | A sub field for selecting the rows per page to display. |
| mixed | The number of rows that were returned from the database. |
| mixed | The sub field that stores the name of the data to sort by. |
| mixed | The SQL query used to retrieve the data from the database. |
| mixed | True if an empty sub field constitutes an invalid value. |
| mixed | The TableSet that holds the database data for this SearchResultsField. |
| Fields inherited from FORMfields.fields.FormField | |
|---|---|
| autoPropagate, data, disableEnterHandler, displayValuesOnNewLine, editable, enabled, endingString, enterTabHandler, enterTabs, error, extraHtml, fieldBelowLabel, formError, help, hidden, htmlify, id, isData, label, labelForId, multiValues, name, required, subFieldDisplayValueSeparator, subFieldSeparator, subFieldValueSeparator, subFields, subFieldsCannotBeEmpty, trimWhitespace, validators, value, valueIsHtml | |
| Constructor Summary | |
|---|---|
SearchResultsField(string name, string label, string sql, int rowsPerPage) Creates a new SearchResultsField. |
|
__construct(string name, string label, string sql, int rowsPerPage) Creates a new SearchResultsField. |
|
| Method Summary | |
|---|---|
| void | addCheckboxColumn(array idHeading, string checkboxInsertHeading) Adds a checkbox column to the results. |
| array | Returns a string array of the ids selected. |
| string | Returns the HTML used to display the input portion of this field. |
| void | Returns the HTML to display the bottom navigation bar: page index, results and go to page, should be hidden. |
| void | Retrieves the posted field value. |
public mixed $checkboxInsertHeading = null
The heading of the checkbox column if the checkbox column is being displayed.
public mixed $checkboxes = array()
The sub fields for the checkboxes.
public mixed $first
The sub field for the first button.
public mixed $goToPage
The sub field for entering the go to page.
public mixed $goToPageSubmit
The sub field for the go to page submit button.
public mixed $header
The sub field for the header or title.
public mixed $hideBorder = false
True if the sectionTitleHeader should be hidden.
public mixed $hideBottomNavigation = false
True if the bottom navigation bar: page index, results and go to page, should be hidden.
public mixed $hideGoToPage = false
True if the go to page section should be hidden.
public mixed $hideResultDetails = false
True if the result details section should be hidden.
public mixed $hideRowsPerPage = false
True if the rows per page section should be hidden.
public mixed $hideTopNavigation = false
True if the top navigation bar: page index, results and rows to page, should be hidden.
public mixed $last
The sub field for the last button.
public mixed $next
The sub field for the next button.
public mixed $noRecordsString = "No Records Found"
The error string that is display no records where found in the database.
public mixed $order
The sub field that stores whether the data is sorted in ascending or descending order.
public mixed $prev
The sub field for the previous button.
public mixed $rowsPerPage
The number of rows per page.
public mixed $rowsPerPageField
A sub field for selecting the rows per page to display.
public mixed $rowsReturned
The number of rows that were returned from the database. Used to accomodate manual modifications to the underlying TableSet
public mixed $sort
The sub field that stores the name of the data to sort by.
public mixed $sql
The SQL query used to retrieve the data from the database.
public mixed $subFieldsCannotBeEmpty = false
True if an empty sub field constitutes an invalid value.
public mixed $tableSet
The TableSet that holds the database data for this SearchResultsField.
public SearchResultsField(string name, string label, string sql, int rowsPerPage)
Creates a new SearchResultsField.
public __construct(string name, string label, string sql, int rowsPerPage)
Creates a new SearchResultsField.
public void addCheckboxColumn(array idHeading, string checkboxInsertHeading)
Adds a checkbox column to the results. Note: The ID values must not contain spaces or special characters, we recommend using an int value.
public array getCheckboxValues()
Returns a string array of the ids selected.
public string getEditableFieldTag()
Returns the HTML used to display the input portion of this field.
public void getPageNavigationHtml()
Returns the HTML to display the bottom navigation bar: page index, results and go to page, should be hidden.
public void getParameter()
Retrieves the posted field value. In other words, sets this field value using the appropriate values in $_REQUEST. This method also loads the data from database as described by the posted values.
SearchResultsField is a field that automatically pagifies the display of large amounts of database data. Note: this field is not a typcial FormField in that it is often the the only field in its form.