SwatObject
└─SwatUIObject
└─SwatWidget
└─SwatControl
└─SwatView
public abstract class SwatView
extends SwatControl
| Field Summary | |
|---|---|
| array | The values of the checked checkboxes. |
| SwatTableModel | A data structure that holds the data to display in this view. |
| protected array | The selections of this view. |
| protected array | The selectors of this view. |
| Constructor Summary | |
|---|---|
SwatView(string id) Creates a new recordset view. |
|
| Method Summary | |
|---|---|
| protected final void | addSelector(mixed selector) This method should be called internally by the {@link SwatView::init() method on all descendant UI-objects that are SwatViewSelector objects. |
| SwatViewSelection | getSelection(SwatViewSelector|string selector) Gets a selection of this view. |
| void | init() Initializes this view. |
| void | setSelection(SwatViewSelection selection, SwatViewSelector|string selector) Sets a selection of this view. |
| Methods inherited from Swat.SwatControl | |
|---|---|
| addMessage, getNote, printWidgetTree | |
| Methods inherited from Swat.SwatWidget | |
|---|---|
| addCompositeWidget, addMessage, confirmCompositeWidgets, copy, createCompositeWidgets, display, displayHtmlHeadEntries, getCSSClassNames, getCompositeWidget, getCompositeWidgets, getFocusableHtmlId, getHtmlHeadEntrySet, getMessages, hasMessage, init, isDisplayed, isInitialized, isProcessed, isSensitive, printWidgetTree, process, replaceWithContainer | |
| Methods inherited from Swat.SwatUIObject | |
|---|---|
| addComment, addJavaScript, addStyleSheet, addTangoAttribution, copy, getCSSClassNames, getCSSClassString, getFirstAncestor, getHtmlHeadEntrySet, getInlineJavaScript, getUniqueId, isVisible | |
public array $checked_items = array()
The values of the checked checkboxes
This array is set in the SwatTableView::process() method. For
this to be set, this table-view must contain a
SwatCellRendererCheckbox with an id of "checkbox".
public SwatTableModel $model = null
A data structure that holds the data to display in this view
The data structure used is some form of SwatTableModel.
protected array $selections = array()
The selections of this view
This is an array of SwatViewSelection objects indexed by
selector id.
protected array $selectors = array()
The selectors of this view
This is an array of SwatViewSelector objects indexed by selector
id.
public SwatView(string id)
Creates a new recordset view
id - a non-visible unique id for this recordset view.protected final void addSelector(mixed selector)
This method should be called internally by the {@link SwatView::init() method on all descendant UI-objects that are SwatViewSelector objects.
public SwatViewSelection getSelection(SwatViewSelector|string selector)
Gets a selection of this view
Selections are an iterable, countable set of row identifiers for rows processed in this view that were selected (in some way) by the user.
selector - optional. The view selector object or the view selector identifier for which to get the selection. Use this parameter if this view has multiple selectors. By default, the first selector in the view is used.public void init()
Initializes this view
public void setSelection(SwatViewSelection selection, SwatViewSelector|string selector)
Sets a selection of this view
Use by SwatViewSelector objects during the processing phase to
set the selection of this view for a particular selector.
This method may also be used to override the selection provided by a selector.
selection - the selection object to set.selector - optional. The view selector object or the view selector identifier for which to get the selection. Use this parameter if this view has multiple selectors. By default, the first selector in the view is used.
An abstract class from which to derive recordset views