|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.Widget
com.smartgwt.client.widgets.BaseWidget
com.smartgwt.client.widgets.Canvas
com.smartgwt.client.widgets.grid.ListGrid
com.smartgwt.client.widgets.tableview.TableView
public class TableView
Shows a listing of records with one or more fields from each record, with built-in support for navigation and editing of lists of records.
The TableView provides built-in controls such asnavigation arrows and shows fields from the provided
records in one of several built-in RecordLayouts. NOTE: This widget is intended
primarily for creating handset/phone-sized interfaces and does not have an appearance in any skin other than Mobile.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject |
|---|
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled |
| Field Summary |
|---|
| Fields inherited from class com.smartgwt.client.widgets.BaseWidget |
|---|
config, configOnly, id, isElementSet, scClassName |
| Fields inherited from class com.google.gwt.user.client.ui.UIObject |
|---|
DEBUG_ID_PREFIX |
| Constructor Summary | |
|---|---|
TableView()
|
|
TableView(JavaScriptObject jsObj)
|
|
| Method Summary | |
|---|---|
HandlerRegistration |
addImageClickHandler(ImageClickHandler handler)
Add a imageClick handler. |
HandlerRegistration |
addRecordNavigationClickHandler(RecordNavigationClickHandler handler)
Add a recordNavigationClick handler. |
protected JavaScriptObject |
create()
|
String |
getDataField()
Field to display as part of individual record in "summary" RecordLayouts. |
String |
getDescriptionField()
Field to display as part of individual record in all RecordLayouts except
"titleOnly". |
String |
getIconField()
This property allows the developer to specify the icon displayed next to a record. |
String |
getInfoField()
Field to display as part of individual record in "summary" RecordLayouts. |
String |
getNavIcon()
The navigation icon shown next to records when showNavigation is true and NavigationMode is set to "navIconOny". |
NavigationMode |
getNavigationMode()
Set navigation mode for this TableView. |
static TableView |
getOrCreateRef(JavaScriptObject jsObj)
|
String |
getRecordDataStyle()
Default style for data field. |
String |
getRecordDescriptionStyle()
Default style for description. |
String |
getRecordInfoStyle()
Default style for info field. |
RecordLayout |
getRecordLayout()
Sets the arrangement of data fields from the record. |
String |
getRecordNavigationProperty()
Boolean property on each record that controls whether navigation controls are shown for that record. |
String |
getRecordTitleStyle()
Default style for title. |
Boolean |
getShowIconField()
Should an icon field be shown for each record? A column in the table is set aside for an icon as specified on each record in the iconField. |
Boolean |
getShowNavigation()
Whether to show navigation controls by default on all records. |
TableMode |
getTableMode()
The display mode of the table. |
String |
getTitleField()
Field to display for an individual record as the main title. |
String |
getWholeRecordNavIcon()
The navigation icon shown next to records when showNavigation is true and NavigationMode is set to "wholeRecord". |
void |
setDataField(String dataField)
Field to display as part of individual record in "summary" RecordLayouts. |
static void |
setDefaultProperties(TableView tableViewProperties)
Class level method to set the default properties of this class. |
void |
setDescriptionField(String descriptionField)
Field to display as part of individual record in all RecordLayouts except
"titleOnly". |
void |
setIconField(String iconField)
This property allows the developer to specify the icon displayed next to a record. |
void |
setInfoField(String infoField)
Field to display as part of individual record in "summary" RecordLayouts. |
void |
setNavIcon(String navIcon)
The navigation icon shown next to records when showNavigation is true and NavigationMode is set to "navIconOny". |
void |
setNavigationMode(NavigationMode navigationMode)
Set navigation mode for this TableView. |
void |
setRecordDataStyle(String recordDataStyle)
Default style for data field. |
void |
setRecordDescriptionStyle(String recordDescriptionStyle)
Default style for description. |
void |
setRecordFormatter(RecordFormatter formatter)
|
void |
setRecordInfoStyle(String recordInfoStyle)
Default style for info field. |
void |
setRecordLayout(RecordLayout recordLayout)
Sets the arrangement of data fields from the record. |
void |
setRecordNavigationProperty(String recordNavigationProperty)
Boolean property on each record that controls whether navigation controls are shown for that record. |
void |
setRecordTitleStyle(String recordTitleStyle)
Default style for title. |
void |
setShowIconField(Boolean showIconField)
Should an icon field be shown for each record? A column in the table is set aside for an icon as specified on each record in the iconField. |
void |
setShowNavigation(Boolean showNavigation)
Whether to show navigation controls by default on all records. |
void |
setTableMode(TableMode tableMode)
The display mode of the table. |
void |
setTitleField(String titleField)
Field to display for an individual record as the main title. |
void |
setWholeRecordNavIcon(String wholeRecordNavIcon)
The navigation icon shown next to records when showNavigation is true and NavigationMode is set to "wholeRecord". |
| Methods inherited from class com.google.gwt.user.client.ui.Widget |
|---|
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents |
| Methods inherited from class com.google.gwt.user.client.ui.UIObject |
|---|
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, unsinkEvents |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
|---|
fireEvent |
| Methods inherited from interface com.smartgwt.client.widgets.DataBoundComponent |
|---|
getOrCreateJsObj |
| Constructor Detail |
|---|
public TableView()
public TableView(JavaScriptObject jsObj)
| Method Detail |
|---|
public static TableView getOrCreateRef(JavaScriptObject jsObj)
protected JavaScriptObject create()
create in class ListGridpublic void setDataField(String dataField)
RecordLayouts.
dataField - dataField Default value is "data"public String getDataField()
RecordLayouts.
public void setDescriptionField(String descriptionField)
RecordLayouts except
"titleOnly".
descriptionField - descriptionField Default value is "description"public String getDescriptionField()
RecordLayouts except
"titleOnly".
public void setIconField(String iconField)
record[tableView.iconField] to the URL of the desired icon to display. Only applies if showIconField is true.
iconField - iconField Default value is "icon"public String getIconField()
record[tableView.iconField] to the URL of the desired icon to display. Only applies if showIconField is true.
public void setInfoField(String infoField)
RecordLayouts.
infoField - infoField Default value is "info"RecordLayoutpublic String getInfoField()
RecordLayouts.
RecordLayoutpublic void setNavIcon(String navIcon)
showNavigation is true and NavigationMode is set to "navIconOny".
navIcon - navIcon Default value is "[SKINIMG]/iOS/listArrow_button.png"public String getNavIcon()
showNavigation is true and NavigationMode is set to "navIconOny".
public void setNavigationMode(NavigationMode navigationMode)
navigationMode - navigationMode Default value is "wholeRecord"public NavigationMode getNavigationMode()
public void setRecordDataStyle(String recordDataStyle)
recordDataStyle - recordDataStyle Default value is "recordData"public String getRecordDataStyle()
public void setRecordDescriptionStyle(String recordDescriptionStyle)
recordDescriptionStyle - recordDescriptionStyle Default value is "recordDescription"public String getRecordDescriptionStyle()
public void setRecordInfoStyle(String recordInfoStyle)
recordInfoStyle - recordInfoStyle Default value is "recordInfo"public String getRecordInfoStyle()
public void setRecordLayout(RecordLayout recordLayout)
iconField has been configured, it too is an implicitly
shown field, to the left of the area controlled by RecordLayout.
recordLayout - recordLayout Default value is "titleOnly"public RecordLayout getRecordLayout()
iconField has been configured, it too is an implicitly
shown field, to the left of the area controlled by RecordLayout.
public void setRecordNavigationProperty(String recordNavigationProperty)
showNavigation is true.
recordNavigationProperty - recordNavigationProperty Default value is "_navigate"public String getRecordNavigationProperty()
showNavigation is true.
public void setRecordTitleStyle(String recordTitleStyle)
recordTitleStyle - recordTitleStyle Default value is "recordTitle"public String getRecordTitleStyle()
public void setShowIconField(Boolean showIconField)
iconField.
showIconField - showIconField Default value is truepublic Boolean getShowIconField()
iconField.
public void setShowNavigation(Boolean showNavigation)
recordNavigationProperty.
showNavigation - showNavigation Default value is nullpublic Boolean getShowNavigation()
recordNavigationProperty.
public void setTableMode(TableMode tableMode)
tableMode - tableMode Default value is "plain"public TableMode getTableMode()
public void setTitleField(String titleField)
setTitleField in interface DataBoundComponentsetTitleField in class ListGridtitleField - titleField Default value is "title"public String getTitleField()
getTitleField in interface DataBoundComponentgetTitleField in class ListGridpublic void setWholeRecordNavIcon(String wholeRecordNavIcon)
showNavigation is true and NavigationMode is set to "wholeRecord".
wholeRecordNavIcon - wholeRecordNavIcon Default value is "[SKINIMG]/iOS/listArrow.png"public String getWholeRecordNavIcon()
showNavigation is true and NavigationMode is set to "wholeRecord".
public HandlerRegistration addImageClickHandler(ImageClickHandler handler)
Executed when the user clicks on the image displayed in a record if iconField has been specified.
addImageClickHandler in interface HasImageClickHandlershandler - the imageClick handler
HandlerRegistration used to remove this handlerpublic HandlerRegistration addRecordNavigationClickHandler(RecordNavigationClickHandler handler)
Executed when the user clicks on a record, or on the navigate icon for a record depending on NavigationMode.
addRecordNavigationClickHandler in interface HasRecordNavigationClickHandlershandler - the recordNavigationClick handler
HandlerRegistration used to remove this handlerpublic static void setDefaultProperties(TableView tableViewProperties)
Note: This method is intended for setting default attributes only and will effect all instances of the underlying class (including those automatically generated in JavaScript). This method should not be used to apply standard EventHandlers or override methods for a class - use a custom subclass instead.
tableViewProperties - properties that should be used as new defaults when instances of this class are createdpublic void setRecordFormatter(RecordFormatter formatter)
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||