Class DetailViewer
- All Implemented Interfaces:
HasAttachHandlers,HasHandlers,EventListener,HasVisibility,IsWidget,LogicalStructure,DataBoundComponent,HasClearHandlers,HasClickHandlers,HasDoubleClickHandlers,HasDragCompleteHandlers,HasDragMoveHandlers,HasDragRepositionMoveHandlers,HasDragRepositionStartHandlers,HasDragRepositionStopHandlers,HasDragResizeMoveHandlers,HasDragResizeStartHandlers,HasDragResizeStopHandlers,HasDragStartHandlers,HasDragStopHandlers,HasDropCompleteHandlers,HasDropHandlers,HasDropMoveHandlers,HasDropOutHandlers,HasDropOverHandlers,HasFetchDataHandlers,HasFocusChangedHandlers,HasHoverHandlers,HasHoverHiddenHandlers,HasKeyDownHandlers,HasKeyPressHandlers,HasMouseDownHandlers,HasMouseMoveHandlers,HasMouseOutHandlers,HasMouseOverHandlers,HasMouseStillDownHandlers,HasMouseUpHandlers,HasMouseWheelHandlers,HasMovedHandlers,HasParentMovedHandlers,HasResizedHandlers,HasRightMouseDownHandlers,HasRuleContextChangedHandlers,HasScrolledHandlers,HasShowContextMenuHandlers,HasVisibilityChangedHandlers
-
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, factoryCreated, factoryProperties, id, nativeObject, scClassNameFields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionAdd acom.smartgwt.client.widgets.DragCompleteHandler.Add acom.smartgwt.client.widgets.DropCompleteHandler.addFetchDataHandler(FetchDataHandler handler) Add a fetchData handler.voidConvenience method to display a {@link com.smartgwt.client..FormulaBuilder} to create a new Formula Field.voidConvenience method to display a {@link com.smartgwt.client..SummaryBuilder} to create a new Summary Field.Whether at least one item is selected
static voidchangeAutoChildDefaults(String autoChildName, Canvas defaults) Changes the defaults for Canvas AutoChildren namedautoChildName.static voidchangeAutoChildDefaults(String autoChildName, FormItem defaults) Changes the defaults for FormItem AutoChildren namedautoChildName.protected JavaScriptObjectcreate()void
 Deselect all records

voiddeselectRecord(int record) Deselect aRecordpassed in explicitly, or by index.voiddeselectRecord(Record record) Deselect aRecordpassed in explicitly, or by index.voiddeselectRecords(int[] records) Deselect a list ofRecords passed in explicitly, or by index.voiddeselectRecords(Record[] records) Deselect a list ofRecords passed in explicitly, or by index.voiddisableHilite(String hiliteID) Disable a hilite

voidDisable all hilites.

voidShows a FieldPicker interface allowing end-users to rearrange the order and visibiility of the fields in the associated DataBoundComponent.voidShows a HiliteEditor interface allowing end-users to edit the data-hilites currently in use by this DataBoundComponent.Return the message to show if the component has no data.voidenableHilite(String hiliteID) Enable / disable ahilites

voidenableHilite(String hiliteID, boolean enable) Enable / disable ahilites

voidEnable all hilites.

voidenableHiliting(boolean enable) Enable all hilites.

voidExports this component's data with client-side formatters applied, so is suitable for direct display to users.voidexportClientData(DSRequest requestProperties) voidexportClientData(DSRequest requestProperties, RPCCallback callback) Exports this component's data with client-side formatters applied, so is suitable for direct display to users.voidvoidexportData(DSRequest requestProperties) voidexportData(DSRequest requestProperties, RPCCallback callback) Uses a "fetch" operation on the currentDataSourceto retrieve data that matches the current filter and sort criteria for this component, then exports the resulting data to a file or window in the requested format.voidRetrieves data from the DataSource that matches the specified criteria.voidRetrieves data from the DataSource that matches the specified criteria.voidfetchData(Criteria criteria, DSCallback callback) Retrieves data from the DataSource that matches the specified criteria.voidfetchData(Criteria criteria, DSCallback callback, DSRequest requestProperties) Retrieves data from the DataSource that matches the specified criteria.voidfetchRelatedData(ListGridRecord record, Canvas schema) Based on the relationship between the DataSource this component is bound to and the DataSource specified as the "schema" argument, call fetchData() to retrieve records in this data set that are related to the passed-in record.voidfetchRelatedData(ListGridRecord record, Canvas schema, DSCallback callback) voidfetchRelatedData(ListGridRecord record, Canvas schema, DSCallback callback, DSRequest requestProperties) Based on the relationship between the DataSource this component is bound to and the DataSource specified as the "schema" argument, call fetchData() to retrieve records in this data set that are related to the passed-in record.booleanfieldIsVisible(String field) Check whether a field is currently visiblevoidRetrieves data that matches the provided criteria and displays the matching data in this component.voidfilterData(Criteria criteria) Retrieves data that matches the provided criteria and displays the matching data in this component.voidfilterData(Criteria criteria, DSCallback callback) Retrieves data that matches the provided criteria and displays the matching data in this component.voidfilterData(Criteria criteria, DSCallback callback, DSRequest requestProperties) Retrieves data that matches the provided criteria and displays the matching data in this component.find(AdvancedCriteria adCriteria) Filters all objects according to the AdvancedCriteria passed and returns the first matching object or null if not foundRecord[]findAll(AdvancedCriteria adCriteria) Filters all objects according to the AdvancedCriteria passedintfindIndex(AdvancedCriteria adCriteria) Finds the index of the first Record that matches with the AdvacendCriteria passed.intfindNextIndex(int startIndex, AdvancedCriteria adCriteria) LikeRecordList.findIndex(java.util.Map), but considering the startIndex parameter.intfindNextIndex(int startIndex, AdvancedCriteria adCriteria, int endIndex) LikeRecordList.findIndex(java.util.Map), but considering the startIndex and endIndex parameters.Indicates whether to add "drop values" to items dropped on this component, if both the source and target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key.Text for a menu item allowing users to add a formula fieldoperationIdthis component should use when performing add operations.Text for a menu item allowing users to add a formula fieldIfDataBoundComponent.setAutoFetchData(Boolean)is true, this attribute determines whether the initial fetch operation should be performed viaDataBoundComponent.fetchData()orDataBoundComponent.filterData()If true, when this component is first drawn, automatically callDataBoundComponent.fetchData()orDataBoundComponent.filterData()depending onDataBoundComponent.getAutoFetchAsFilter().IfautoFetchDataistrue, this attribute allows the developer to specify a textMatchStyle for the initialDataBoundComponent.fetchData()call.A string (HTML acceptable) that will be written to a page to separate blocks.CSS style for each block (one record's worth of data).Adds an item to the header context menu allowing users to launch a dialog to define a new
 field based on values present in other fields, using the {@link com.smartgwt.client..FormulaBuilder}.
Adds an item to the header context menu allowing users to launch a dialog to define a new
 text field that can contain both user-defined text and the formatted values present in other 
 fields, using the {@link com.smartgwt.client..SummaryBuilder}.
If set, right-clicking on the DetailViewer will show a context menu that offers to bring up aFieldPickerfor configuring which fields are displayed and their order.CSS style for a normal valueThe title for the Configure Fields menu item.getData()A single record object or an array of them, specifying data.A DetailViewer is adataArity:either component by default which means data population fromCanvas.dataContextwill be treated like a DynamicForm (i.e.Record[]Deprecated.Record[]A single record object or an array of them, specifying data.A single record object or an array of them, specifying data.DetailViewers do not yet support paging, and will fetch and render all available records.intWhen usingdata paging, how many records to fetch at a time.The DataSource that this component should bind to for default fields and for performingDataSource requests.How should Date type values be displayed in this DetailViewer by default?Display format to use for fields specified as type 'datetime'.Before we start editing values in this DataBoundComponent, should we perform a deep clone of the underlying values.Record[]During a drag-and-drop interaction, this method returns the set of records being dragged out of the component.Indicates what to do with data dragged into another DataBoundComponent.CSS Style to apply to the drag tracker when dragging occurs on this component.When an item is dropped on this component, andaddDropValuesis true and both the source and target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key, this object provides the "drop values" that Smart GWT will apply to the dropped object before updating it.Message to show when a user attempts to transfer duplicate records into this component, and
preventDuplicatesis enabled.Text for a menu item allowing users to edit a formula fieldDefault class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.Text for a menu item allowing users to edit the formatter for a fieldText to show for an empty cellThe string to display in the body of a detailViewer with no records.CSS style to display this message inSetting exportAll to true prevents the component from passing its list of fields to the 
 export call.String[]The list of field-names to export.If Summary rows exist for this component, whether to include them when exporting client data.Operation ID this component should use when performing fetch operations.IfautoFetchDataistrue, this attribute allows the developer to declaratively specifyDSRequestproperties for the initialfetchData()call.Returna an array of field alignments for this gridintReturn the number of fields.Deprecated.It is not possible to change this value; changing this attribute did not actually cause the framework to use a different property for the ID of a field.String[]Names of properties onDetailViewerFieldfor which theFieldPickershould show an editing interface, for convenience.Instance ofFieldPickerWindowused ifcanPickFieldsis set.An array of field objects, specifying the order and type of fields to display in this DetailViewer.Return the fields as JavaScriptObjects rather than as SmartGWT Java wrappers of the field class type (e.g.CSS style for a headerHeight for hilite icons for this listGrid.intHow much padding should there be on the left ofhilite iconsby default? Can be overridden at the field levelWhenhiliteIconsare present, where the hilite icon will be placed relative to the field value.intHow much padding should there be on the right ofhilite iconsby default? Can be overridden at the field levelString[]Specifies a list of icons that can be used inhilites.intDefault width and height ofhilite iconsfor this component.Width for hilite icons for this component.Marker that can be set on a record to flag that record as hilited.Hilite[]Return the set of hilite-objects currently applied to this DataBoundComponent.Get the current hilites encoded as a String, for saving.Criteria that are never shown to or edited by the user and are cumulative with any criteria provided viaDataBoundComponent.initialCriteria,DataBoundComponent.setCriteria()etc.Criteria to use whenDataBoundComponent.setAutoFetchData(Boolean)is used.Horizontal alignment of value-labels in this viewer.text to put before a labelCSS style for a normal detail labeltext to put after a labelProperty name on a record that will hold the link text for that record.The string to display in the body of a detailViewer which is loading records.CSS style to use for theloadingMessage.Getter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.static DetailViewergetOrCreateRef(JavaScriptObject jsObj) If set, detect and prevent duplicate records from being transferred to this component, either via
 drag and drop or viaDataBoundComponent.transferSelectedData(com.smartgwt.client.widgets.DataBoundComponent).Optional CSS style for a cell in printable HTML for this component.Optional CSS style for a header in printable HTML for this component.Optional CSS style for a label cell in printable HTML for this component.Indicates whether or not this component will load its dataprogressivelyintgetRecordIndex(Record record) Get the index of the provided record.
Return the underlying data of this DataBoundComponent as aRecordList.intThe number of records to display in a block.operationIdthis component should use when performing remove operations.Return the underlying data of this DataBoundComponent as aResultSet.intHeight of rows rendered by the DetailViewer.Optional identifier for saved searches that should be applied to this component.CSS style for a separatorWhether to show fields of non-atomic types when a DataBoundComponent is given a
 DataSource but nocomponent.fields.
Whether to show fields markeddetail:truewhen a DataBoundComponent is given a DataSource but nocomponent.fields.Whether to show the field when the value is nullShowemptyMessagewhen there is no data to display?Whether to show fields markedhidden:truewhen a DataBoundComponent is given a
 DataSource but nocomponent.fields.
booleanWhether to associate saved searches by default with the currentDataSourceof a component when asavedSearchIdis not provided.getSort()Returns the currentSortSpecifiersfor this component.If true,ListGrid.getFieldState()andListGrid.setFieldState(java.lang.String)will omit state information for hidden fields by default.CSS style for the component as a whole.Display format to use for fields specified as type 'time'.Method to return the fieldName which represents the "title" for records in this
 Component.

 If this.titleField is explicitly specified it will always be used.
 Otherwise, default implementation will checktitleFieldfor databound
 components.

 For non databound components returns the first defined field name of"title", 
"name", or"id".getTitleFieldValue(Record record) Get the value of the titleField for the passed record
operationIdthis component should use when performing update operations.If true, the set of fields given by the "default binding" (see 
fields) is used, with any fields specified in
component.fieldsacting as overrides that can suppress or modify the
 display of individual fields, without having to list the entire set of fields that
 should be shown.
TheuseFlatFieldsflag causes all simple type fields anywhere in a nested
 set of DataSources to be exposed as a flat list for form binding.Horizontal alignment of values in this viewer.Returns a snapshot of the current view state of this DetailViewer.
This includes the field state of the DetailViewer, returned as aDetailViewerViewStateobject.
This object can be passed tosetViewState()to reset this detail viewer's view state to the current state (assuming the same data / fields are present in the detail viewer).Should the label be allowed to wrap, or be fixed to one line no matter how longWhether values should be allowed to wrap by default, or should be shown on one line regardless of length.voidInvalidate the current data cache for this databound component via a call to the dataset'sinvalidateCache()method, for example,ResultSet.invalidateCache().booleanReturns true if this component is currentlyexporting client data.voidSelect all records

voidselectRecord(int record) Select/deselect aRecordpassed in explicitly, or by index.voidselectRecord(int record, boolean newState) Select/deselect aRecordpassed in explicitly, or by index.voidselectRecord(Record record) Select/deselect aRecordpassed in explicitly, or by index.voidselectRecord(Record record, boolean newState) Select/deselect aRecordpassed in explicitly, or by index.voidselectRecords(int[] records) Select/deselect a list ofRecords passed in explicitly, or by index.voidselectRecords(int[] records, boolean newState) Select/deselect a list ofRecords passed in explicitly, or by index.voidselectRecords(Record[] records) Select/deselect a list ofRecords passed in explicitly, or by index.voidselectRecords(Record[] records, boolean newState) Select/deselect a list ofRecords passed in explicitly, or by index.setAddDropValues(Boolean addDropValues) Indicates whether to add "drop values" to items dropped on this component, if both the source and target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key.setAddFormulaFieldText(String addFormulaFieldText) Text for a menu item allowing users to add a formula fieldsetAddOperation(String addOperation) operationIdthis component should use when performing add operations.setAddSummaryFieldText(String addSummaryFieldText) Text for a menu item allowing users to add a formula fieldsetAutoFetchAsFilter(Boolean autoFetchAsFilter) IfDataBoundComponent.setAutoFetchData(Boolean)is true, this attribute determines whether the initial fetch operation should be performed viaDataBoundComponent.fetchData()orDataBoundComponent.filterData()setAutoFetchData(Boolean autoFetchData) If true, when this component is first drawn, automatically callDataBoundComponent.fetchData()orDataBoundComponent.filterData()depending onDataBoundComponent.getAutoFetchAsFilter().setAutoFetchTextMatchStyle(TextMatchStyle autoFetchTextMatchStyle) IfautoFetchDataistrue, this attribute allows the developer to specify a textMatchStyle for the initialDataBoundComponent.fetchData()call.setBlockSeparator(String blockSeparator) A string (HTML acceptable) that will be written to a page to separate blocks.setBlockStyle(String blockStyle) CSS style for each block (one record's worth of data).setCanAddFormulaFields(Boolean canAddFormulaFields) Adds an item to the header context menu allowing users to launch a dialog to define a new
 field based on values present in other fields, using the {@link com.smartgwt.client..FormulaBuilder}.
setCanAddSummaryFields(Boolean canAddSummaryFields) Adds an item to the header context menu allowing users to launch a dialog to define a new
 text field that can contain both user-defined text and the formatted values present in other 
 fields, using the {@link com.smartgwt.client..SummaryBuilder}.
setCanPickFields(Boolean canPickFields) If set, right-clicking on the DetailViewer will show a context menu that offers to bring up aFieldPickerfor configuring which fields are displayed and their order.setCellStyle(String cellStyle) CSS style for a normal valuesetConfigureFieldsText(String configureFieldsText) The title for the Configure Fields menu item.A single record object or an array of them, specifying data.setData(RecordList data) A single record object or an array of them, specifying data.setData(DetailViewerRecord... data) A single record object or an array of them, specifying data.setDataArity(String dataArity) A DetailViewer is adataArity:either component by default which means data population fromCanvas.dataContextwill be treated like a DynamicForm (i.e.setDataFetchMode(FetchMode dataFetchMode) DetailViewers do not yet support paging, and will fetch and render all available records.setDataPageSize(int dataPageSize) When usingdata paging, how many records to fetch at a time.setDataSource(DataSource dataSource) The DataSource that this component should bind to for default fields and for performingDataSource requests.voidsetDataSource(DataSource dataSource, DetailViewerField... fields) Bind to a DataSource.setDataSource(String dataSource) The DataSource that this component should bind to for default fields and for performingDataSource requests.setDateFormatter(DateDisplayFormat dateFormatter) How should Date type values be displayed in this DetailViewer by default?setDatetimeFormatter(DateDisplayFormat datetimeFormatter) Display format to use for fields specified as type 'datetime'.setDeepCloneOnEdit(Boolean deepCloneOnEdit) Before we start editing values in this DataBoundComponent, should we perform a deep clone of the underlying values.static voidsetDefaultProperties(DetailViewer detailViewerProperties) Class level method to set the default properties of this class.setDragDataAction(DragDataAction dragDataAction) Indicates what to do with data dragged into another DataBoundComponent.setDragDataCustomizer(DragDataCustomizer customizer) During a drag-and-drop interaction, this method returns the set of records being dragged out of the component.setDragTrackerStyle(String dragTrackerStyle) CSS Style to apply to the drag tracker when dragging occurs on this component.setDropValues(Map dropValues) When an item is dropped on this component, andaddDropValuesis true and both the source and target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key, this object provides the "drop values" that Smart GWT will apply to the dropped object before updating it.setDuplicateDragMessage(String duplicateDragMessage) Message to show when a user attempts to transfer duplicate records into this component, and
preventDuplicatesis enabled.setEditFormulaFieldText(String editFormulaFieldText) Text for a menu item allowing users to edit a formula fieldsetEditProxyConstructor(String editProxyConstructor) Default class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.setEditSummaryFieldText(String editSummaryFieldText) Text for a menu item allowing users to edit the formatter for a fieldsetEmptyCellValue(String emptyCellValue) Text to show for an empty cellsetEmptyMessage(String emptyMessage) The string to display in the body of a detailViewer with no records.setEmptyMessageStyle(String emptyMessageStyle) CSS style to display this message insetExportAll(Boolean exportAll) Setting exportAll to true prevents the component from passing its list of fields to the 
 export call.setExportFields(String[] exportFields) The list of field-names to export.setExportIncludeSummaries(Boolean exportIncludeSummaries) If Summary rows exist for this component, whether to include them when exporting client data.setFetchOperation(String fetchOperation) Operation ID this component should use when performing fetch operations.setFetchRequestProperties(DSRequest fetchRequestProperties) IfautoFetchDataistrue, this attribute allows the developer to declaratively specifyDSRequestproperties for the initialfetchData()call.setFieldPickerFieldProperties(String... fieldPickerFieldProperties) Names of properties onDetailViewerFieldfor which theFieldPickershould show an editing interface, for convenience.setFields(JavaScriptObject... fields) Field setter variant (alternative tosetFields(FormItem...),setFields(ListGridField...), etc.) that will accept an array of JavaScriptObject, rather than an array of SmartGWT Java wrappers of the field class type (e.g.setFields(DetailViewerField... fields) An array of field objects, specifying the order and type of fields to display in this DetailViewer.setHeaderStyle(String headerStyle) CSS style for a headersetHiliteIconHeight(Integer hiliteIconHeight) Height for hilite icons for this listGrid.setHiliteIconLeftPadding(int hiliteIconLeftPadding) How much padding should there be on the left ofhilite iconsby default? Can be overridden at the field levelsetHiliteIconPosition(HiliteIconPosition hiliteIconPosition) WhenhiliteIconsare present, where the hilite icon will be placed relative to the field value.setHiliteIconRightPadding(int hiliteIconRightPadding) How much padding should there be on the right ofhilite iconsby default? Can be overridden at the field levelsetHiliteIcons(String... hiliteIcons) Specifies a list of icons that can be used inhilites.setHiliteIconSize(int hiliteIconSize) Default width and height ofhilite iconsfor this component.setHiliteIconWidth(Integer hiliteIconWidth) Width for hilite icons for this component.setHiliteProperty(String hiliteProperty) Marker that can be set on a record to flag that record as hilited.setHilites(Hilite[] hilites) Accepts an array of hilite objects and applies them to this DataBoundComponent.setHiliteState(String hiliteState) Set the current hilites based on a hiliteState String previously returned from getHilitesState.setImplicitCriteria(Criteria implicitCriteria) Criteria that are never shown to or edited by the user and are cumulative with any criteria provided viaDataBoundComponent.initialCriteria,DataBoundComponent.setCriteria()etc.setImplicitCriteria(Criteria implicitCriteria, DSCallback callback) setImplicitCriteria(Criteria criteria, DSCallback callback, Boolean initialFetch) setInitialCriteria(Criteria initialCriteria) Criteria to use whenDataBoundComponent.setAutoFetchData(Boolean)is used.setLabelAlign(Alignment labelAlign) Horizontal alignment of value-labels in this viewer.setLabelPrefix(String labelPrefix) text to put before a labelsetLabelStyle(String labelStyle) CSS style for a normal detail labelsetLabelSuffix(String labelSuffix) text to put after a labelsetLinkTextProperty(String linkTextProperty) Property name on a record that will hold the link text for that record.setLoadingMessage(String loadingMessage) The string to display in the body of a detailViewer which is loading records.setLoadingMessageStyle(String loadingMessageStyle) CSS style to use for theloadingMessage.Setter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.setPreventDuplicates(Boolean preventDuplicates) If set, detect and prevent duplicate records from being transferred to this component, either via
 drag and drop or viaDataBoundComponent.transferSelectedData(com.smartgwt.client.widgets.DataBoundComponent).setPrintCellStyle(String printCellStyle) Optional CSS style for a cell in printable HTML for this component.setPrintHeaderStyle(String printHeaderStyle) Optional CSS style for a header in printable HTML for this component.setPrintLabelStyle(String printLabelStyle) Optional CSS style for a label cell in printable HTML for this component.setProgressiveLoading(Boolean progressiveLoading) Indicates whether or not this component will load its dataprogressivelysetRecordsPerBlock(int recordsPerBlock) The number of records to display in a block.setRemoveOperation(String removeOperation) operationIdthis component should use when performing remove operations.setRowHeight(int rowHeight) Height of rows rendered by the DetailViewer.setSavedSearchId(String savedSearchId) Optional identifier for saved searches that should be applied to this component.setSeparatorStyle(String separatorStyle) CSS style for a separatorsetShowComplexFields(Boolean showComplexFields) Whether to show fields of non-atomic types when a DataBoundComponent is given a
 DataSource but nocomponent.fields.
setShowDetailFields(Boolean showDetailFields) Whether to show fields markeddetail:truewhen a DataBoundComponent is given a DataSource but nocomponent.fields.setShowEmptyField(Boolean showEmptyField) Whether to show the field when the value is nullsetShowEmptyMessage(Boolean showEmptyMessage) ShowemptyMessagewhen there is no data to display?setShowHiddenFields(Boolean showHiddenFields) Whether to show fields markedhidden:truewhen a DataBoundComponent is given a
 DataSource but nocomponent.fields.
setShowSavedSearchesByDS(boolean showSavedSearchesByDS) Whether to associate saved searches by default with the currentDataSourceof a component when asavedSearchIdis not provided.setSort(SortSpecifier... sortSpecifiers) Sort the component on one or more fields.setSparseFieldState(Boolean sparseFieldState) If true,ListGrid.getFieldState()andListGrid.setFieldState(java.lang.String)will omit state information for hidden fields by default.voidsetStyleName(String styleName) CSS style for the component as a whole.setTimeFormatter(TimeDisplayFormat timeFormatter) Display format to use for fields specified as type 'time'.setTitleField(String titleField) Sets the best field to use for a user-visible title for an individual record from this component.setUpdateOperation(String updateOperation) operationIdthis component should use when performing update operations.voidsetUseAllDataSourceFields(boolean useAllDataSourceFields) If true, the set of fields given by the "default binding" (see DataBoundComponent.fields) is used, with any fields specified in component.fields acting as overrides that can suppress or modify the display of individual fields, without having to list the entire set of fields that should be shown.setUseAllDataSourceFields(Boolean useAllDataSourceFields) If true, the set of fields given by the "default binding" (see 
fields) is used, with any fields specified in
component.fieldsacting as overrides that can suppress or modify the
 display of individual fields, without having to list the entire set of fields that
 should be shown.
setUseFlatFields(Boolean useFlatFields) TheuseFlatFieldsflag causes all simple type fields anywhere in a nested
 set of DataSources to be exposed as a flat list for form binding.setValueAlign(Alignment valueAlign) Horizontal alignment of values in this viewer.voidsetViewState(String viewState) Reset this detail viewer's view state to match theDetailViewerViewStateobject passed in.
Used to restore previous state retrieved from the detail viewer by a call togetViewState().setWrapLabel(Boolean wrapLabel) Should the label be allowed to wrap, or be fixed to one line no matter how longsetWrapValues(Boolean wrapValues) Whether values should be allowed to wrap by default, or should be shown on one line regardless of length.voidtransferRecords(Record[] records, Record targetRecord, Integer index, Canvas sourceWidget, TransferRecordsCallback callback) Transfer a list ofRecords from another component (does not have to be a databound component) into this component.voidSimulates a drag / drop type transfer of the selected records in some other component to this component, without requiring any user interaction.voidtransferSelectedData(DataBoundComponent source, int index) Simulates a drag / drop type transfer of the selected records in some other component to this component, without requiring any user interaction.voidviewSelectedData(ListGrid selectionComponent) Displays the currently selected record(s) of the ListGrid in the detailViewer.voidviewSelectedData(String selectionComponentID) Displays the currently selected record(s) of the ListGrid in the detailViewer.Methods inherited from class com.smartgwt.client.widgets.Canvas
addChild, addChild, addChild, addChild, addChild, addClearHandler, addClickHandler, addDoubleClickHandler, addDragMoveHandler, addDragRepositionMoveHandler, addDragRepositionStartHandler, addDragRepositionStopHandler, addDragResizeMoveHandler, addDragResizeStartHandler, addDragResizeStopHandler, addDragStartHandler, addDragStopHandler, addDropHandler, addDropMoveHandler, addDropOutHandler, addDropOverHandler, addFocusChangedHandler, addHoverHandler, addHoverHiddenHandler, addKeyDownHandler, addKeyPressHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseStillDownHandler, addMouseUpHandler, addMouseWheelHandler, addMovedHandler, addParentMovedHandler, addPeer, addPeer, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addRuleContextChangedHandler, addScrolledHandler, addShowContextMenuHandler, addSnapAlignCandidate, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, asSGWTComponent, blur, bringToFront, clear, clearExplicitTabIndex, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsEventTarget, containsFocus, containsPoint, containsPoint, dataContextChanged, deparent, depeer, disable, enable, encloses, focus, focusAfterGroup, focusAtEnd, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAdaptiveHeightPriority, getAdaptiveWidthPriority, getAlwaysManageFocusNavigation, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideEffect, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeLayoutMode, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaHandleID, getAriaRole, getAriaStateDefaults, getAutoMaskComponents, getAutoParent, getAutoPopulateData, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBorderRadius, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanAdaptHeight, getCanAdaptWidth, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenResizeSnapAlign, getChildrenSnapAlign, getChildrenSnapCenterAlign, getChildrenSnapEdgeAlign, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getChildTabPosition, getClassName, getComponentMask, getComponentMaskDefaults, getContentElement, getContents, getContextMenu, getCorrectZoomOverflow, getCursor, getDataContext, getDataPath, getDefaultHeight, getDefaultWidth, getDefiningProperty, getDefiningPropertyName, getDefiningPropertyNameOptions, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragMaxHeight, getDragMaxWidth, getDragMinHeight, getDragMinWidth, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragTargetAsString, getDragType, getDropTarget, getDropTargetAsString, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getElement, getElement, getEnableWhen, getEndLine, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFloatingScrollbars, getFormItemAutoChild, getForwardSVGeventsToObject, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupPadding, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverAutoFitMaxWidth, getHoverAutoFitMaxWidthAsString, getHoverAutoFitWidth, getHoverComponent, getHoverDelay, getHoverFocusKey, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverPersist, getHoverScreen, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlElementAsString, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getIsPrinting, getIsRuleScope, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeaveGroupLabelSpace, getLeavePageSpace, getLeft, getLeftAsString, getLocalId, getLocateByIDOnly, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getLocatorName, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMatchElementHeight, getMatchElementWidth, getMaxHeight, getMaxWidth, getMaxZoomOverflowError, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getName, getNativeAutoHideScrollbars, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getOverflow, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPaletteDefaults, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPendingMarkerStyle, getPendingMarkerVisible, getPercentBox, getPercentSource, getPersistentMatchElement, getPointerSettings, getPointerTarget, getPointerTargetAsString, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrintStyleName, getPrompt, getProportionalResizeModifiers, getProportionalResizing, getReceiveScrollbarEvents, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getRuleContext, getRuleContext, getRuleScope, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowColor, getShadowDepth, getShadowHOffset, getShadowImage, getShadowOffset, getShadowSoftness, getShadowSpread, getShadowVOffset, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowPointer, getShowResizeBar, getShowShadow, getShowSnapGrid, getShrinkElementOnHide, getSizeMayChangeOnRedraw, getSkinImgDir, getSnapAlignCandidates, getSnapAlignCenterLineStyle, getSnapAlignEdgeLineStyle, getSnapAxis, getSnapEdge, getSnapGridLineProperties, getSnapGridStyle, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapPosition, getSnapPosition, getSnapResizeToAlign, getSnapResizeToGrid, getSnapTo, getSnapToAlign, getSnapToCenterAlign, getSnapToEdgeAlign, getSnapToGrid, getSnapVDirection, getSnapVGap, getStartLine, getTabIndex, getTestDataContext, getTestInstance, getTitle, getTooltip, getTop, getTopAsString, getTopElement, getUISummary, getUpdateTabPositionOnDraw, getUpdateTabPositionOnReparent, getUseBackMask, getUseCSSShadow, getUseDragMask, getUseImageForSVG, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getValuesManagerAsString, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWhen, getVisibleWidth, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getWorkflows, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, initComplete, intersects, isDirty, isDisabled, isFocused, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, onInit, pageScrollDown, pageScrollUp, parentResized, placeNear, placeNear, placeNear, print, print, print, print, printComponents, provideRuleContext, provideRuleContext, redraw, redraw, registerFontScaledPaddingStyles, removeChild, removeChild, removePeer, removePeer, removeRuleContext, removeSnapAlignCandidate, resizeAutoChildAttributes, resizeBy, resizeControls, resizeControlsTo, resizeFonts, resizeFonts, resizeFonts, resizeFontsTo, resizeIcons, resizePadding, resizePadding, resizeTo, resizeTo, revealChild, revealChild, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAdaptHeightByCustomizer, setAdaptiveHeightPriority, setAdaptiveWidthPriority, setAdaptWidthByCustomizer, setAlign, setAllowExternalFilters, setAlwaysManageFocusNavigation, setAlwaysShowScrollbars, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideEffect, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeLayoutMode, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoHeight, setAutoMaskComponents, setAutoParent, setAutoPopulateData, setAutoResizeAutoChildAttributes, setAutoResizeIcons, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBorderRadius, setBottom, setCanAcceptDrop, setCanAdaptHeight, setCanAdaptWidth, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContents, setContextMenu, setCorrectZoomOverflow, setCursor, setDataContext, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultShowCustomScrollbars, setDefaultWidth, setDefiningProperty, setDefiningPropertyNameOptions, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragMaxHeight, setDragMaxWidth, setDragMinHeight, setDragMinWidth, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragTarget, setDragType, setDropTarget, setDropTarget, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setElement, setEnableWhen, setEndLine, setExtraSpace, setFacetId, setFloatingScrollbars, setForwardSVGeventsToObject, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupPadding, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverAutoFitMaxWidth, setHoverAutoFitMaxWidth, setHoverAutoFitWidth, setHoverDelay, setHoverFocusKey, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverPersist, setHoverScreen, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setIsRuleScope, setIsSnapAlignCandidate, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeaveGroupLabelSpace, setLeavePageSpace, setLeft, setLeft, setLocateByIDOnly, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLocatorName, setLocatorParent, setLocatorParent, setLogicalStructure, setMargin, setMatchElement, setMatchElementHeight, setMatchElementWidth, setMaxHeight, setMaxWidth, setMaxZoomOverflowError, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setName, setNativeAutoHideScrollbars, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setOpacity, setOverflow, setPadding, setPageLeft, setPageTop, setPanelContainer, setParentCanvas, setParentElement, setPeers, setPendingMarkerStyle, setPendingMarkerVisible, setPercentBox, setPercentSource, setPersistentMatchElement, setPointerSettings, setPointerTarget, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrintStyleName, setPrompt, setProportionalResizeModifiers, setProportionalResizing, setReceiveScrollbarEvents, setRect, setRect, setRedrawOnResize, setRelativeTabPosition, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setRuleScope, setScrollbarConstructor, setScrollbarSize, setShadowColor, setShadowDepth, setShadowHOffset, setShadowImage, setShadowOffset, setShadowSoftness, setShadowSpread, setShadowVOffset, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowPointer, setShowResizeBar, setShowShadow, setShowSnapGrid, setShrinkElementOnHide, setSizeMayChangeOnRedraw, setSkinImgDir, setSmoothFade, setSnapAlignCandidates, setSnapAlignCenterLineStyle, setSnapAlignEdgeLineStyle, setSnapAxis, setSnapEdge, setSnapGridLineProperties, setSnapGridStyle, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToAlign, setSnapResizeToGrid, setSnapTo, setSnapToAlign, setSnapToCenterAlign, setSnapToEdgeAlign, setSnapToGrid, setSnapVDirection, setSnapVGap, setStartLine, setTabIndex, setTestDataContext, setTitle, setTooltip, setTop, setTop, setUpdateTabPositionOnDraw, setUpdateTabPositionOnReparent, setUseBackMask, setUseCSSShadow, setUseDragMask, setUseImageForSVG, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setValuesManager, setVisibility, setVisible, setVisibleWhen, setWidth, setWidth, setWidth, setWidth100, setWorkflows, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPendingMarker, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, startDebuggingOverflow, stopDebuggingOverflow, updateChildTabPosition, updateChildTabPositions, updateEditNode, updateHover, updateHover, updateShadow, updateTabPositionForDraw, visibleAtPoint, willAcceptDropMethods inherited from class com.smartgwt.client.widgets.BaseWidget
addDrawHandler, addDynamicProperty, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, clearDynamicProperty, completeCreation, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hasDynamicProperty, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, isDrawn, isFactoryCreated, onBind, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDefaultProperties, setDragTracker, setFactoryCreated, setID, setJavaScriptObject, setLogicalStructure, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toStringMethods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEventsMethods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEventMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.smartgwt.client.widgets.DataBoundComponent
getOrCreateJsObjMethods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
-
Constructor Details
-
DetailViewer
public DetailViewer() -
DetailViewer
-
-
Method Details
-
getOrCreateRef
-
changeAutoChildDefaults
Changes the defaults for Canvas AutoChildren namedautoChildName.- Parameters:
autoChildName- name of an AutoChild to customize the defaults for.defaults- Canvas defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, seeSGWTProperties.- See Also:
-
changeAutoChildDefaults
Changes the defaults for FormItem AutoChildren namedautoChildName.- Parameters:
autoChildName- name of an AutoChild to customize the defaults for.defaults- FormItem defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, seeSGWTProperties.- See Also:
-
create
-
setBlockSeparator
A string (HTML acceptable) that will be written to a page to separate blocks.- Parameters:
blockSeparator- New blockSeparator value. Default value is "<br><br>"- Returns:
DetailViewerinstance, for chaining setter calls- See Also:
-
getBlockSeparator
A string (HTML acceptable) that will be written to a page to separate blocks.- Returns:
- Current blockSeparator value. Default value is "<br><br>"
- See Also:
-
setBlockStyle
CSS style for each block (one record's worth of data).- Parameters:
blockStyle- New blockStyle value. Default value is "detailBlock"- Returns:
DetailViewerinstance, for chaining setter calls- See Also:
-
getBlockStyle
CSS style for each block (one record's worth of data).- Returns:
- Current blockStyle value. Default value is "detailBlock"
- See Also:
-
setCanPickFields
If set, right-clicking on the DetailViewer will show a context menu that offers to bring up aFieldPickerfor configuring which fields are displayed and their order.- Parameters:
canPickFields- New canPickFields value. Default value is false- Returns:
DetailViewerinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getCanPickFields
If set, right-clicking on the DetailViewer will show a context menu that offers to bring up aFieldPickerfor configuring which fields are displayed and their order.- Returns:
- Current canPickFields value. Default value is false
-
setCellStyle
CSS style for a normal value- Parameters:
cellStyle- New cellStyle value. Default value is "detail"- Returns:
DetailViewerinstance, for chaining setter calls- See Also:
-
getCellStyle
CSS style for a normal value- Returns:
- Return the CSS class for a cell. Default implementation calls
getCellStyle()on the field if defined, otherwise returnsthis.cellStyle. Default value is "detail" - See Also:
-
setConfigureFieldsText
The title for the Configure Fields menu item.- Parameters:
configureFieldsText- New configureFieldsText value. Default value is "Configure Fields..."- Returns:
DetailViewerinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getConfigureFieldsText
The title for the Configure Fields menu item.- Returns:
- Current configureFieldsText value. Default value is "Configure Fields..."
-
setData
A single record object or an array of them, specifying data. Note that DetailViewers do not detect changes to the data array (in other words they will not automatically re-draw when the data provided via this property is altered).
If this method is called after the component has been drawn/initialized: Sets the data displayed by this detail viewer.- Parameters:
data- new data to be displayed. Default value is null- Returns:
DetailViewerinstance, for chaining setter calls
-
getData
A single record object or an array of them, specifying data. Note that DetailViewers do not detect changes to the data array (in other words they will not automatically re-draw when the data provided via this property is altered).- Returns:
- Current data value. Default value is null
-
setData
A single record object or an array of them, specifying data. Note that DetailViewers do not detect changes to the data array (in other words they will not automatically re-draw when the data provided via this property is altered).
If this method is called after the component has been drawn/initialized: Sets the data displayed by this detail viewer.- Parameters:
data- new data to be displayed. Default value is null- Returns:
DetailViewerinstance, for chaining setter calls
-
getDataAsRecordArray
A single record object or an array of them, specifying data. Note that DetailViewers do not detect changes to the data array (in other words they will not automatically re-draw when the data provided via this property is altered).- Returns:
- Current data value. Default value is null
-
setData
A single record object or an array of them, specifying data. Note that DetailViewers do not detect changes to the data array (in other words they will not automatically re-draw when the data provided via this property is altered).
If this method is called after the component has been drawn/initialized: Sets the data displayed by this detail viewer.- Parameters:
data- new data to be displayed. Default value is null- Returns:
DetailViewerinstance, for chaining setter calls
-
getDataAsRecordList
A single record object or an array of them, specifying data. Note that DetailViewers do not detect changes to the data array (in other words they will not automatically re-draw when the data provided via this property is altered).- Returns:
- Current data value. Default value is null
-
setDataArity
A DetailViewer is adataArity:either component by default which means data population fromCanvas.dataContextwill be treated like a DynamicForm (i.e. single). However, by explicitly marking an instance of DetailViewer asdataArity:multiple,dataContextpopulation will be treated similarly to a ListGrid.Note : This is an advanced setting
- Parameters:
dataArity- New dataArity value. Default value is "either"- Returns:
DetailViewerinstance, for chaining setter calls
-
getDataArity
A DetailViewer is adataArity:either component by default which means data population fromCanvas.dataContextwill be treated like a DynamicForm (i.e. single). However, by explicitly marking an instance of DetailViewer asdataArity:multiple,dataContextpopulation will be treated similarly to a ListGrid.- Returns:
- Current dataArity value. Default value is "either"
-
setDataFetchMode
DetailViewers do not yet support paging, and will fetch and render all available records.- Specified by:
setDataFetchModein interfaceDataBoundComponent- Parameters:
dataFetchMode- New dataFetchMode value. Default value is "basic"- Returns:
DetailViewerinstance, for chaining setter calls- See Also:
-
getDataFetchMode
DetailViewers do not yet support paging, and will fetch and render all available records.- Specified by:
getDataFetchModein interfaceDataBoundComponent- Returns:
- Current dataFetchMode value. Default value is "basic"
- See Also:
-
setDataSource
The DataSource that this component should bind to for default fields and for performingDataSource requests.Can be specified as either a DataSource instance or the String ID of a DataSource.
- Specified by:
setDataSourcein interfaceDataBoundComponent- Parameters:
dataSource- New dataSource value. Default value is null- Returns:
DetailViewerinstance, for chaining setter calls- See Also:
-
setDataSource
The DataSource that this component should bind to for default fields and for performingDataSource requests.Can be specified as either a DataSource instance or the String ID of a DataSource.
- Specified by:
setDataSourcein interfaceDataBoundComponent- Parameters:
dataSource- New dataSource value. Default value is null- Returns:
DetailViewerinstance, for chaining setter calls- See Also:
-
setDateFormatter
How should Date type values be displayed in this DetailViewer by default?This property specifies the default DateDisplayFormat to apply to Date values displayed in this grid for all fields except those of
type "time"(See alsotimeFormatter).
IfdatetimeFormatteris specified, that will be applied by default to fields of type"datetime".Note that if
DetailViewerField.dateFormatterorDetailViewerField.timeFormatterare specified those properties will take precedence over the component level settings.If unset, date values will be formatted according to the system wide
normal display format.- Parameters:
dateFormatter- New dateFormatter value. Default value is null- Returns:
DetailViewerinstance, for chaining setter calls
-
getDateFormatter
How should Date type values be displayed in this DetailViewer by default?This property specifies the default DateDisplayFormat to apply to Date values displayed in this grid for all fields except those of
type "time"(See alsotimeFormatter).
IfdatetimeFormatteris specified, that will be applied by default to fields of type"datetime".Note that if
DetailViewerField.dateFormatterorDetailViewerField.timeFormatterare specified those properties will take precedence over the component level settings.If unset, date values will be formatted according to the system wide
normal display format.- Returns:
- Current dateFormatter value. Default value is null
-
setDatetimeFormatter
Display format to use for fields specified as type 'datetime'. Default is to use the system-wide default long ("normal") date time format, configured viaDateUtil.setNormalDatetimeDisplayFormat(). Specify any validDateDisplayFormatto change the display format for datetimes used by this viewer.May also be specified at the field level via
DetailViewerField.dateFormatter- Parameters:
datetimeFormatter- New datetimeFormatter value. Default value is null- Returns:
DetailViewerinstance, for chaining setter calls- See Also:
-
getDatetimeFormatter
Display format to use for fields specified as type 'datetime'. Default is to use the system-wide default long ("normal") date time format, configured viaDateUtil.setNormalDatetimeDisplayFormat(). Specify any validDateDisplayFormatto change the display format for datetimes used by this viewer.May also be specified at the field level via
DetailViewerField.dateFormatter- Returns:
- Current datetimeFormatter value. Default value is null
- See Also:
-
setEditProxyConstructor
public DetailViewer setEditProxyConstructor(String editProxyConstructor) throws IllegalStateException Default class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.- Overrides:
setEditProxyConstructorin classCanvas- Parameters:
editProxyConstructor- New editProxyConstructor value. Default value is "DetailViewerEditProxy"- Returns:
DetailViewerinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getEditProxyConstructor
Default class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.- Overrides:
getEditProxyConstructorin classCanvas- Returns:
- Current editProxyConstructor value. Default value is "DetailViewerEditProxy"
- See Also:
-
setEmptyCellValue
Text to show for an empty cellNote : This is an advanced setting
- Parameters:
emptyCellValue- New emptyCellValue value. Default value is " "- Returns:
DetailViewerinstance, for chaining setter calls- See Also:
-
getEmptyCellValue
Text to show for an empty cell- Returns:
- Current emptyCellValue value. Default value is " "
- See Also:
-
setEmptyMessage
The string to display in the body of a detailViewer with no records.- Parameters:
emptyMessage- New emptyMessage value. Default value is "No items to display."- Returns:
DetailViewerinstance, for chaining setter calls- See Also:
-
getEmptyMessage
The string to display in the body of a detailViewer with no records.- Returns:
- Current emptyMessage value. Default value is "No items to display."
- See Also:
-
setEmptyMessageStyle
CSS style to display this message inNote : This is an advanced setting
- Parameters:
emptyMessageStyle- New emptyMessageStyle value. Default value is "normal"- Returns:
DetailViewerinstance, for chaining setter calls- See Also:
-
getEmptyMessageStyle
CSS style to display this message in- Returns:
- Current emptyMessageStyle value. Default value is "normal"
- See Also:
-
setFetchRequestProperties
public DetailViewer setFetchRequestProperties(DSRequest fetchRequestProperties) throws IllegalStateException IfautoFetchDataistrue, this attribute allows the developer to declaratively specifyDSRequestproperties for the initialfetchData()call.Note that any properties governing more specific request attributes for the initial fetch (such as
autoFetchTextMatchStyleand initial sort specifiers) will be applied on top of this properties block.- Parameters:
fetchRequestProperties- New fetchRequestProperties value. Default value is null- Returns:
DetailViewerinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getFetchRequestProperties
IfautoFetchDataistrue, this attribute allows the developer to declaratively specifyDSRequestproperties for the initialfetchData()call.Note that any properties governing more specific request attributes for the initial fetch (such as
autoFetchTextMatchStyleand initial sort specifiers) will be applied on top of this properties block.- Returns:
- Current fetchRequestProperties value. Default value is null
- See Also:
-
getFieldIdProperty
Deprecated.It is not possible to change this value; changing this attribute did not actually cause the framework to use a different property for the ID of a field.Name of the field in the DetailViewerRecord which specifies the data property for that record.Note : This method should be called only after the widget has been rendered.
- Returns:
- Current fieldIdProperty value. Default value is "name"
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setFieldPickerFieldProperties
public DetailViewer setFieldPickerFieldProperties(String... fieldPickerFieldProperties) throws IllegalStateException Names of properties onDetailViewerFieldfor which theFieldPickershould show an editing interface, for convenience.For example, specify ["decimalPad", "decimalPrecision"] to allow end users to modify
DetailViewerField.decimalPadandDetailViewerField.decimalPrecisionrespectively.- Parameters:
fieldPickerFieldProperties- New fieldPickerFieldProperties value. Default value is null- Returns:
DetailViewerinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getFieldPickerFieldProperties
Names of properties onDetailViewerFieldfor which theFieldPickershould show an editing interface, for convenience.For example, specify ["decimalPad", "decimalPrecision"] to allow end users to modify
DetailViewerField.decimalPadandDetailViewerField.decimalPrecisionrespectively.- Returns:
- Current fieldPickerFieldProperties value. Default value is null
-
getFieldPickerWindow
Instance ofFieldPickerWindowused ifcanPickFieldsis set.This component is an AutoChild named "fieldPickerWindow". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current fieldPickerWindow value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setFields
An array of field objects, specifying the order and type of fields to display in this DetailViewer. In DetailViewers, the fields specify rows.- Parameters:
fields- New fields value. Default value is null- Returns:
DetailViewerinstance, for chaining setter calls
-
getFields
An array of field objects, specifying the order and type of fields to display in this DetailViewer. In DetailViewers, the fields specify rows.- Returns:
- Current fields value. Default value is null
-
setHeaderStyle
CSS style for a header- Parameters:
headerStyle- New headerStyle value. Default value is "detailHeader"- Returns:
DetailViewerinstance, for chaining setter calls- See Also:
-
getHeaderStyle
CSS style for a header- Returns:
- Current headerStyle value. Default value is "detailHeader"
- See Also:
-
setHiliteIconHeight
Height for hilite icons for this listGrid. OverrideshiliteIconSize. Can be overridden at the field level- Parameters:
hiliteIconHeight- New hiliteIconHeight value. Default value is null- Returns:
DetailViewerinstance, for chaining setter calls- See Also:
-
getHiliteIconHeight
Height for hilite icons for this listGrid. OverrideshiliteIconSize. Can be overridden at the field level- Returns:
- Current hiliteIconHeight value. Default value is null
- See Also:
-
setHiliteIconLeftPadding
How much padding should there be on the left ofhilite iconsby default? Can be overridden at the field level- Parameters:
hiliteIconLeftPadding- New hiliteIconLeftPadding value. Default value is 2- Returns:
DetailViewerinstance, for chaining setter calls- See Also:
-
getHiliteIconLeftPadding
public int getHiliteIconLeftPadding()How much padding should there be on the left ofhilite iconsby default? Can be overridden at the field level- Returns:
- Current hiliteIconLeftPadding value. Default value is 2
- See Also:
-
setHiliteIconPosition
public DetailViewer setHiliteIconPosition(HiliteIconPosition hiliteIconPosition) throws IllegalStateException WhenhiliteIconsare present, where the hilite icon will be placed relative to the field value. SeeHiliteIconPosition. Can be overridden at the field level.- Parameters:
hiliteIconPosition- New hiliteIconPosition value. Default value is "before"- Returns:
DetailViewerinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getHiliteIconPosition
WhenhiliteIconsare present, where the hilite icon will be placed relative to the field value. SeeHiliteIconPosition. Can be overridden at the field level.- Returns:
- Current hiliteIconPosition value. Default value is "before"
- See Also:
-
setHiliteIconRightPadding
How much padding should there be on the right ofhilite iconsby default? Can be overridden at the field level- Parameters:
hiliteIconRightPadding- New hiliteIconRightPadding value. Default value is 2- Returns:
DetailViewerinstance, for chaining setter calls- See Also:
-
getHiliteIconRightPadding
public int getHiliteIconRightPadding()How much padding should there be on the right ofhilite iconsby default? Can be overridden at the field level- Returns:
- Current hiliteIconRightPadding value. Default value is 2
- See Also:
-
setHiliteIcons
Specifies a list of icons that can be used inhilites.hiliteIconsshould be specified as an Array ofSCImgURL. When present, the hilite editing interface shown whenDataBoundComponent.editHilites()is called will offer the user a drop down for picking one of these icons when defining either a simple or advanced hilite rule.If the user picks an icon, the created hiliting rule will have
Hilite.iconset to the chosen icon.DataBoundComponent.hiliteIconPositioncontrols where the icon will appear for that field -- the default is that it appears in front of the normal cell content. This can also be overridden at the field level.- Parameters:
hiliteIcons- New hiliteIcons value. Default value is ["[SKINIMG]/Dialog/notify.png", "[SKINIMG]/Dialog/warn.png", "[SKINIMG]/actions/approve.png"]- Returns:
DetailViewerinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getHiliteIcons
Specifies a list of icons that can be used inhilites.hiliteIconsshould be specified as an Array ofSCImgURL. When present, the hilite editing interface shown whenDataBoundComponent.editHilites()is called will offer the user a drop down for picking one of these icons when defining either a simple or advanced hilite rule.If the user picks an icon, the created hiliting rule will have
Hilite.iconset to the chosen icon.DataBoundComponent.hiliteIconPositioncontrols where the icon will appear for that field -- the default is that it appears in front of the normal cell content. This can also be overridden at the field level.- Returns:
- Current hiliteIcons value. Default value is ["[SKINIMG]/Dialog/notify.png", "[SKINIMG]/Dialog/warn.png", "[SKINIMG]/actions/approve.png"]
- See Also:
-
setHiliteIconSize
Default width and height ofhilite iconsfor this component. Can be overridden at the component level via explicithiliteIconWidthandhiliteIconHeight, or at the field level viahiliteIconSize,hiliteIconWidthandhiliteIconHeight- Parameters:
hiliteIconSize- New hiliteIconSize value. Default value is 12- Returns:
DetailViewerinstance, for chaining setter calls- See Also:
-
getHiliteIconSize
public int getHiliteIconSize()Default width and height ofhilite iconsfor this component. Can be overridden at the component level via explicithiliteIconWidthandhiliteIconHeight, or at the field level viahiliteIconSize,hiliteIconWidthandhiliteIconHeight- Returns:
- Current hiliteIconSize value. Default value is 12
- See Also:
-
setHiliteIconWidth
Width for hilite icons for this component. OverrideshiliteIconSize. Can be overridden at the field level.- Parameters:
hiliteIconWidth- New hiliteIconWidth value. Default value is null- Returns:
DetailViewerinstance, for chaining setter calls- See Also:
-
getHiliteIconWidth
Width for hilite icons for this component. OverrideshiliteIconSize. Can be overridden at the field level.- Returns:
- Current hiliteIconWidth value. Default value is null
- See Also:
-
setLabelAlign
Horizontal alignment of value-labels in this viewer. If unspecified, defaults to"left"when in RTL mode and"right"otherwise.- Parameters:
labelAlign- New labelAlign value. Default value is null- Returns:
DetailViewerinstance, for chaining setter calls
-
getLabelAlign
Horizontal alignment of value-labels in this viewer. If unspecified, defaults to"left"when in RTL mode and"right"otherwise.- Returns:
- Current labelAlign value. Default value is null
-
setLabelPrefix
text to put before a label- Parameters:
labelPrefix- New labelPrefix value. Default value is ""- Returns:
DetailViewerinstance, for chaining setter calls- See Also:
-
getLabelPrefix
text to put before a label- Returns:
- Current labelPrefix value. Default value is ""
- See Also:
-
setLabelStyle
CSS style for a normal detail label- Parameters:
labelStyle- New labelStyle value. Default value is "detailLabel"- Returns:
DetailViewerinstance, for chaining setter calls- See Also:
-
getLabelStyle
CSS style for a normal detail label- Returns:
- Current labelStyle value. Default value is "detailLabel"
- See Also:
-
setLabelSuffix
text to put after a label- Parameters:
labelSuffix- New labelSuffix value. Default value is ":"- Returns:
DetailViewerinstance, for chaining setter calls- See Also:
-
getLabelSuffix
text to put after a label- Returns:
- Current labelSuffix value. Default value is ":"
- See Also:
-
setLinkTextProperty
Property name on a record that will hold the link text for that record.This property is configurable to avoid possible collision with data values in the record.
Use
DetailViewerField.linkTextPropertyif you have more than one link field and the fields' records do not use the same property to store the linkText.- Parameters:
linkTextProperty- New linkTextProperty value. Default value is "linkText"- Returns:
DetailViewerinstance, for chaining setter calls- See Also:
-
getLinkTextProperty
Property name on a record that will hold the link text for that record.This property is configurable to avoid possible collision with data values in the record.
Use
DetailViewerField.linkTextPropertyif you have more than one link field and the fields' records do not use the same property to store the linkText.- Returns:
- Current linkTextProperty value. Default value is "linkText"
- See Also:
-
setLoadingMessage
The string to display in the body of a detailViewer which is loading records. Use"${loadingImage}"to includea loading image.- Parameters:
loadingMessage- New loadingMessage value. Default value is " ${loadingImage}"- Returns:
DetailViewerinstance, for chaining setter calls- See Also:
-
getLoadingMessage
The string to display in the body of a detailViewer which is loading records. Use"${loadingImage}"to includea loading image.- Returns:
- Current loadingMessage value. Default value is " ${loadingImage}"
- See Also:
-
setLoadingMessageStyle
CSS style to use for theloadingMessage.Note : This is an advanced setting
- Parameters:
loadingMessageStyle- New loadingMessageStyle value. Default value is "normal"- Returns:
DetailViewerinstance, for chaining setter calls- See Also:
-
getLoadingMessageStyle
CSS style to use for theloadingMessage.- Returns:
- Current loadingMessageStyle value. Default value is "normal"
- See Also:
-
setPrintCellStyle
Optional CSS style for a cell in printable HTML for this component. If unsetcellStylewill be used for printing as well as normal presentation.- Parameters:
printCellStyle- New printCellStyle value. Default value is null- Returns:
DetailViewerinstance, for chaining setter calls- See Also:
-
getPrintCellStyle
Optional CSS style for a cell in printable HTML for this component. If unsetcellStylewill be used for printing as well as normal presentation.- Returns:
- Current printCellStyle value. Default value is null
- See Also:
-
setPrintHeaderStyle
Optional CSS style for a header in printable HTML for this component. If unsetheaderStylewill be used for printing as well as normal presentation.- Parameters:
printHeaderStyle- New printHeaderStyle value. Default value is null- Returns:
DetailViewerinstance, for chaining setter calls- See Also:
-
getPrintHeaderStyle
Optional CSS style for a header in printable HTML for this component. If unsetheaderStylewill be used for printing as well as normal presentation.- Returns:
- Current printHeaderStyle value. Default value is null
- See Also:
-
setPrintLabelStyle
Optional CSS style for a label cell in printable HTML for this component. If unsetlabelStylewill be used for printing as well as normal presentation.- Parameters:
printLabelStyle- New printLabelStyle value. Default value is null- Returns:
DetailViewerinstance, for chaining setter calls- See Also:
-
getPrintLabelStyle
Optional CSS style for a label cell in printable HTML for this component. If unsetlabelStylewill be used for printing as well as normal presentation.- Returns:
- Current printLabelStyle value. Default value is null
- See Also:
-
setRecordsPerBlock
The number of records to display in a block. A block is a horizontal row on a page containing one or more records, as specified by the value of recordsPerBlock. The height of a block is equal to the height of a single record. The default setting of 1 causes each record to appear by itself in a vertical row. Setting recordsPerBlock to 2 would cause records to appear side by side in groups of two. Use a value of "*" to indicate all records.- Parameters:
recordsPerBlock- New recordsPerBlock value. Default value is 1- Returns:
DetailViewerinstance, for chaining setter calls- See Also:
-
getRecordsPerBlock
public int getRecordsPerBlock()The number of records to display in a block. A block is a horizontal row on a page containing one or more records, as specified by the value of recordsPerBlock. The height of a block is equal to the height of a single record. The default setting of 1 causes each record to appear by itself in a vertical row. Setting recordsPerBlock to 2 would cause records to appear side by side in groups of two. Use a value of "*" to indicate all records.- Returns:
- Current recordsPerBlock value. Default value is 1
- See Also:
-
setRowHeight
Height of rows rendered by the DetailViewer. Acts as a minimum - the DetailViewer never clips values. This attribute can be set as null.- Parameters:
rowHeight- New rowHeight value. Default value is 19- Returns:
DetailViewerinstance, for chaining setter calls
-
getRowHeight
public int getRowHeight()Height of rows rendered by the DetailViewer. Acts as a minimum - the DetailViewer never clips values. This attribute can be set as null.- Returns:
- Current rowHeight value. Default value is 19
-
setSeparatorStyle
CSS style for a separator- Parameters:
separatorStyle- New separatorStyle value. Default value is "detail"- Returns:
DetailViewerinstance, for chaining setter calls- See Also:
-
getSeparatorStyle
CSS style for a separator- Returns:
- Current separatorStyle value. Default value is "detail"
- See Also:
-
setShowDetailFields
Whether to show fields markeddetail:truewhen a DataBoundComponent is given a DataSource but nocomponent.fields.The
detailproperty is used on DataSource fields to mark fields that shouldn't appear by default in a view that tries to show many records in a small space.- Specified by:
setShowDetailFieldsin interfaceDataBoundComponent- Parameters:
showDetailFields- New showDetailFields value. Default value is true- Returns:
DetailViewerinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getShowDetailFields
Whether to show fields markeddetail:truewhen a DataBoundComponent is given a DataSource but nocomponent.fields.The
detailproperty is used on DataSource fields to mark fields that shouldn't appear by default in a view that tries to show many records in a small space.- Specified by:
getShowDetailFieldsin interfaceDataBoundComponent- Returns:
- Current showDetailFields value. Default value is true
- See Also:
-
setShowEmptyField
Whether to show the field when the value is nullNote : This is an advanced setting
- Parameters:
showEmptyField- New showEmptyField value. Default value is true- Returns:
DetailViewerinstance, for chaining setter calls- See Also:
-
getShowEmptyField
Whether to show the field when the value is null- Returns:
- Current showEmptyField value. Default value is true
- See Also:
-
setShowEmptyMessage
ShowemptyMessagewhen there is no data to display?Note : This is an advanced setting
- Parameters:
showEmptyMessage- New showEmptyMessage value. Default value is true- Returns:
DetailViewerinstance, for chaining setter calls- See Also:
-
getShowEmptyMessage
ShowemptyMessagewhen there is no data to display?- Returns:
- Current showEmptyMessage value. Default value is true
- See Also:
-
setStyleName
CSS style for the component as a whole.- Overrides:
setStyleNamein classCanvas- Parameters:
styleName- New styleName value. Default value is "detailViewer"- See Also:
-
getStyleName
CSS style for the component as a whole.- Overrides:
getStyleNamein classCanvas- Returns:
- Current styleName value. Default value is "detailViewer"
- See Also:
-
setTimeFormatter
Display format to use for fields specified as type 'time'. May also be specified at the field level viaDetailViewerField.timeFormatter.
If unset, time fields will be formatted based on the system wide String- Parameters:
timeFormatter- New timeFormatter value. Default value is null- Returns:
DetailViewerinstance, for chaining setter calls- See Also:
-
getTimeFormatter
Display format to use for fields specified as type 'time'. May also be specified at the field level viaDetailViewerField.timeFormatter.
If unset, time fields will be formatted based on the system wide String- Returns:
- Current timeFormatter value. Default value is null
- See Also:
-
setValueAlign
Horizontal alignment of values in this viewer. If unspecified, defaults to"right"when in RTL mode and"left"otherwise.- Parameters:
valueAlign- New valueAlign value. Default value is null- Returns:
DetailViewerinstance, for chaining setter calls
-
getValueAlign
Horizontal alignment of values in this viewer. If unspecified, defaults to"right"when in RTL mode and"left"otherwise.- Returns:
- Current valueAlign value. Default value is null
-
setWrapLabel
Should the label be allowed to wrap, or be fixed to one line no matter how long- Parameters:
wrapLabel- New wrapLabel value. Default value is false- Returns:
DetailViewerinstance, for chaining setter calls
-
getWrapLabel
Should the label be allowed to wrap, or be fixed to one line no matter how long- Returns:
- Current wrapLabel value. Default value is false
-
setWrapValues
Whether values should be allowed to wrap by default, or should be shown on one line regardless of length.- Parameters:
wrapValues- New wrapValues value. Default value is true- Returns:
DetailViewerinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getWrapValues
Whether values should be allowed to wrap by default, or should be shown on one line regardless of length.- Returns:
- Current wrapValues value. Default value is true
-
emptyMessageHTML
Return the message to show if the component has no data. Default implementation returns a centeredemptyMessageor " " if showEmptyMessage is false. If the component has no data because the browser is offline, we instead display theDataBoundComponent.offlineMessageor " " if showOfflineMessage is false- Returns:
- HTML output
-
exportClientData
public void exportClientData()Exports this component's data with client-side formatters applied, so is suitable for direct display to users. SeeListGrid.exportClientData()for details of the general requirements and restrictions when exporting client data.The following notes apply when exporting client data from DetailViewers:
- Data is exported in "grid" format, with each record shown in a single row and each column representing a single field. This is quite different from the way DetailViewers display records in the browser
If your detailViewer has custom formatters, formatted values will be exported by default, with HTML normalized to text where possible. Since some levels of HTML normalizing aren't possible, this may result in missing or incorrect export values. In this case, you have two possible approaches:
- Set
exportRawValueson the field. This will export the raw underlying value of the field; your formatter will not be called - Have your formatter call
isExportingClientData()and perform whatever alternative formatting you require if that method returns true
- See Also:
-
exportClientData
- See Also:
-
exportClientData
Exports this component's data with client-side formatters applied, so is suitable for direct display to users. SeeListGrid.exportClientData()for details of the general requirements and restrictions when exporting client data.The following notes apply when exporting client data from DetailViewers:
- Data is exported in "grid" format, with each record shown in a single row and each column representing a single field. This is quite different from the way DetailViewers display records in the browser
If your detailViewer has custom formatters, formatted values will be exported by default, with HTML normalized to text where possible. Since some levels of HTML normalizing aren't possible, this may result in missing or incorrect export values. In this case, you have two possible approaches:
- Set
exportRawValueson the field. This will export the raw underlying value of the field; your formatter will not be called - Have your formatter call
isExportingClientData()and perform whatever alternative formatting you require if that method returns true
- Parameters:
requestProperties- Request properties for the export. Note that specifyingexportDataon the request properties allows the developer to pass in an explicit data set to export.callback- Optional callback. If you specifyexportToClient: false in the request properties, this callback will fire after export completes. Otherwise the callback will fire right before the download request is made to the server.- See Also:
-
fetchRelatedData
Based on the relationship between the DataSource this component is bound to and the DataSource specified as the "schema" argument, call fetchData() to retrieve records in this data set that are related to the passed-in record.Relationships between DataSources are declared via
DataSourceField.foreignKey.For example, given two related DataSources "orders" and "orderItems", where we want to fetch the "orderItems" that belong to a given "order". "orderItems" should declare a field that is a
foreignKeyto the "orders" table (for example, it might be named "orderId" with foreignKey="orders.id"). Then, to load the records related to a given "order", call fetchRelatedData() on the component bound to "orderItems", pass the "orders" DataSource as the "schema" and pass a record from the "orders" DataSource as the "record" argument.Note: When you expect a large number of records to be returned it is not recommended to display these in the DetailViewer as it doesn't have the same level of support for large datasets as the
ListGrid.- Parameters:
record- DataSource recordschema- schema of the DataSource record, or DataBoundComponent already bound to that schema- See Also:
-
fetchRelatedData
-
fetchRelatedData
public void fetchRelatedData(ListGridRecord record, Canvas schema, DSCallback callback, DSRequest requestProperties) Based on the relationship between the DataSource this component is bound to and the DataSource specified as the "schema" argument, call fetchData() to retrieve records in this data set that are related to the passed-in record.Relationships between DataSources are declared via
DataSourceField.foreignKey.For example, given two related DataSources "orders" and "orderItems", where we want to fetch the "orderItems" that belong to a given "order". "orderItems" should declare a field that is a
foreignKeyto the "orders" table (for example, it might be named "orderId" with foreignKey="orders.id"). Then, to load the records related to a given "order", call fetchRelatedData() on the component bound to "orderItems", pass the "orders" DataSource as the "schema" and pass a record from the "orders" DataSource as the "record" argument.Note: When you expect a large number of records to be returned it is not recommended to display these in the DetailViewer as it doesn't have the same level of support for large datasets as the
ListGrid.- Parameters:
record- DataSource recordschema- schema of the DataSource record, or DataBoundComponent already bound to that schemacallback- callback to invoke on completionrequestProperties- additional properties to set on the DSRequest that will be issued- See Also:
-
fieldIsVisible
Check whether a field is currently visible- Parameters:
field- field to be checked- Returns:
- true if the field is currently visible, false otherwise.
-
getViewState
Returns a snapshot of the current view state of this DetailViewer.
This includes the field state of the DetailViewer, returned as aDetailViewerViewStateobject.
This object can be passed tosetViewState()to reset this detail viewer's view state to the current state (assuming the same data / fields are present in the detail viewer).- Returns:
- current view state for the detail viewer.
See
DetailViewerViewState - See Also:
-
isExportingClientData
public boolean isExportingClientData()Returns true if this component is currentlyexporting client data. This method can be called from custom cell formatters if you need to return a different formatted value for an export than for a live detailViewer- Returns:
- returns true if this component is currently exporting client data
- See Also:
-
setViewState
Reset this detail viewer's view state to match theDetailViewerViewStateobject passed in.
Used to restore previous state retrieved from the detail viewer by a call togetViewState().- Parameters:
viewState- Object describing the desired view state for the detail viewer. SeeDetailViewerViewState- See Also:
-
setDefaultProperties
Class level method to set the default properties of this class. If set, then all existing and subsequently created instances of this class will automatically have default properties corresponding to the properties set on the SmartGWT class instance passed to this function before its underlying SmartClient JS object was created. This is a powerful feature that eliminates the need for users to create a separate hierarchy of subclasses that only alter the default properties of this class. Can also be used for skinning / styling purposes.Note: This method is intended for setting default attributes only and will affect 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. Calling this method after instances have been created can result in undefined behavior, since it bypasses any setters and a class instance may have already examined a particular property and not be expecting any changes through this route.
- Parameters:
detailViewerProperties- properties that should be used as new defaults when instances of this class are created- See Also:
-
setUseAllDataSourceFields
public void setUseAllDataSourceFields(boolean useAllDataSourceFields) If true, the set of fields given by the "default binding" (see DataBoundComponent.fields) is used, with any fields specified in component.fields acting as overrides that can suppress or modify the display of individual fields, without having to list the entire set of fields that should be shown. If component.fields contains fields that are not found in the DataSource, they will be shown after the most recently referred to DataSource field. If the new fields appear first, they will be shown first.- Parameters:
useAllDataSourceFields- useAllDataSourceFields
-
viewSelectedData
Displays the currently selected record(s) of the ListGrid in the detailViewer.- Parameters:
selectionComponent- the ListGrid whose currently selected record(s) is/are to be edited
-
viewSelectedData
Displays the currently selected record(s) of the ListGrid in the detailViewer.- Parameters:
selectionComponentID- the ID of a ListGrid whose currently selected record(s) is/are to be edited
-
setDataSource
Bind to a DataSource.Binding to a DataSource means that the component will use the DataSource to provide default data for its fields.
When binding to a new DataSource, if the component has any existing "fields" or has a dataset, these will be discarded by default, since it is assumed the new DataSource may represent a completely unrelated set of objects. If the old "fields" are still relevant, pass them to setDataSource().
- Parameters:
dataSource-fields-
-
getDataAsRecord
Deprecated.in favor ofgetDataAsRecordArray(). -
setDataPageSize
Description copied from interface:DataBoundComponentWhen usingdata paging, how many records to fetch at a time. If set to a positive integer,dataPageSizewill override the defaultresultSizefor ResultSets automatically created when you callfetchData()(and similarly for theresultSizeof ResultTrees). The default of 0 means to just use the default page size of the data container.Note that regardless of the
dataPageSizesetting, a component will always fetch all of data that it needs to draw. Settings such asshowAllRecords:true,drawAllMaxCellsanddrawAheadRatiocan cause more rows than the configureddataPageSizeto be fetched.- Specified by:
setDataPageSizein interfaceDataBoundComponent- Parameters:
dataPageSize- dataPageSize Default value is 0- Returns:
DataBoundComponentinstance, for chaining setter calls- See Also:
-
getDataPageSize
public int getDataPageSize()Description copied from interface:DataBoundComponentWhen usingdata paging, how many records to fetch at a time. If set to a positive integer,dataPageSizewill override the defaultresultSizefor ResultSets automatically created when you callfetchData()(and similarly for theresultSizeof ResultTrees). The default of 0 means to just use the default page size of the data container.Note that regardless of the
dataPageSizesetting, a component will always fetch all of data that it needs to draw. Settings such asshowAllRecords:true,drawAllMaxCellsanddrawAheadRatiocan cause more rows than the configureddataPageSizeto be fetched.- Specified by:
getDataPageSizein interfaceDataBoundComponent- Returns:
- int
- See Also:
-
setUseAllDataSourceFields
Description copied from interface:DataBoundComponentIf true, the set of fields given by the "default binding" (see 
fields) is used, with any fields specified in
component.fieldsacting as overrides that can suppress or modify the
 display of individual fields, without having to list the entire set of fields that
 should be shown.

 If
component.fieldscontains fields that are not found in the DataSource,
 they will be shown after the most recently referred to DataSource field. If the new
 fields appear first, they will be shown first.- Specified by:
setUseAllDataSourceFieldsin interfaceDataBoundComponent- Parameters:
useAllDataSourceFields- useAllDataSourceFields Default value is false- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getUseAllDataSourceFields
Description copied from interface:DataBoundComponentIf true, the set of fields given by the "default binding" (see 
fields) is used, with any fields specified in
component.fieldsacting as overrides that can suppress or modify the
 display of individual fields, without having to list the entire set of fields that
 should be shown.

 If
component.fieldscontains fields that are not found in the DataSource,
 they will be shown after the most recently referred to DataSource field. If the new
 fields appear first, they will be shown first.- Specified by:
getUseAllDataSourceFieldsin interfaceDataBoundComponent- Returns:
- Boolean
-
setSparseFieldState
Description copied from interface:DataBoundComponentIf true,ListGrid.getFieldState()andListGrid.setFieldState(java.lang.String)will omit state information for hidden fields by default.- Specified by:
setSparseFieldStatein interfaceDataBoundComponent- Parameters:
sparseFieldState- sparseFieldState Default value is false- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getSparseFieldState
Description copied from interface:DataBoundComponentIf true,ListGrid.getFieldState()andListGrid.setFieldState(java.lang.String)will omit state information for hidden fields by default.- Specified by:
getSparseFieldStatein interfaceDataBoundComponent- Returns:
- Boolean
-
setShowHiddenFields
Description copied from interface:DataBoundComponentWhether to show fields markedhidden:truewhen a DataBoundComponent is given a
 DataSource but nocomponent.fields.

 The
hiddenproperty is used on DataSource fields to mark fields that are
 never of meaning to an end user.- Specified by:
setShowHiddenFieldsin interfaceDataBoundComponent- Parameters:
showHiddenFields- showHiddenFields Default value is false- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getShowHiddenFields
Description copied from interface:DataBoundComponentWhether to show fields markedhidden:truewhen a DataBoundComponent is given a
 DataSource but nocomponent.fields.

 The
hiddenproperty is used on DataSource fields to mark fields that are
 never of meaning to an end user.- Specified by:
getShowHiddenFieldsin interfaceDataBoundComponent- Returns:
- Boolean
-
setShowComplexFields
Description copied from interface:DataBoundComponentWhether to show fields of non-atomic types when a DataBoundComponent is given a
 DataSource but nocomponent.fields.

 If true, the component will show fields that declare a complex type, for example, a
 field 'shippingAddress' that declares type 'Address', where 'Address' is the ID of a
 DataSource that declares the fields of a shipping address (city, street name, etc).


 Such fields may need custom formatters or editors in order to create a usable interface,
 for example, an Address field in a ListGrid might use a custom formatter to combine the
 relevant fields of an address into one column, and might use a pop-up dialog for
 editing.
Note : This is an advanced setting
- Specified by:
setShowComplexFieldsin interfaceDataBoundComponent- Parameters:
showComplexFields- showComplexFields Default value is true- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getShowComplexFields
Description copied from interface:DataBoundComponentWhether to show fields of non-atomic types when a DataBoundComponent is given a
 DataSource but nocomponent.fields.

 If true, the component will show fields that declare a complex type, for example, a
 field 'shippingAddress' that declares type 'Address', where 'Address' is the ID of a
 DataSource that declares the fields of a shipping address (city, street name, etc).


 Such fields may need custom formatters or editors in order to create a usable interface,
 for example, an Address field in a ListGrid might use a custom formatter to combine the
 relevant fields of an address into one column, and might use a pop-up dialog for
 editing.
- Specified by:
getShowComplexFieldsin interfaceDataBoundComponent- Returns:
- Boolean
-
setFetchOperation
Description copied from interface:DataBoundComponentOperation ID this component should use when performing fetch operations.- Specified by:
setFetchOperationin interfaceDataBoundComponent- Parameters:
fetchOperation- fetchOperation Default value is null- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getFetchOperation
Description copied from interface:DataBoundComponentOperation ID this component should use when performing fetch operations.- Specified by:
getFetchOperationin interfaceDataBoundComponent- Returns:
- String
-
setUpdateOperation
Description copied from interface:DataBoundComponentoperationIdthis component should use when performing update operations.- Specified by:
setUpdateOperationin interfaceDataBoundComponent- Parameters:
updateOperation- Default value is null- Returns:
DataBoundComponentinstance, for chaining setter calls- See Also:
-
getUpdateOperation
Description copied from interface:DataBoundComponentoperationIdthis component should use when performing update operations.- Specified by:
getUpdateOperationin interfaceDataBoundComponent- Returns:
- String
- See Also:
-
setAddOperation
Description copied from interface:DataBoundComponentoperationIdthis component should use when performing add operations.- Specified by:
setAddOperationin interfaceDataBoundComponent- Parameters:
addOperation- Default value is null- Returns:
DataBoundComponentinstance, for chaining setter calls- See Also:
-
getAddOperation
Description copied from interface:DataBoundComponentoperationIdthis component should use when performing add operations.- Specified by:
getAddOperationin interfaceDataBoundComponent- Returns:
- String
- See Also:
-
setRemoveOperation
Description copied from interface:DataBoundComponentoperationIdthis component should use when performing remove operations.- Specified by:
setRemoveOperationin interfaceDataBoundComponent- Parameters:
removeOperation- Default value is null- Returns:
DataBoundComponentinstance, for chaining setter calls- See Also:
-
getRemoveOperation
Description copied from interface:DataBoundComponentoperationIdthis component should use when performing remove operations.- Specified by:
getRemoveOperationin interfaceDataBoundComponent- Returns:
- String
- See Also:
-
setExportFields
Description copied from interface:DataBoundComponentThe list of field-names to export. If provided, the field-list in the exported output is 
 limited and sorted as per the list.

 If exportFields is not provided, the exported output includes all visible fields 
 from this component, sorted as they appear.
- Specified by:
setExportFieldsin interfaceDataBoundComponent- Parameters:
exportFields- exportFields Default value is null- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getExportFields
Description copied from interface:DataBoundComponentThe list of field-names to export. If provided, the field-list in the exported output is 
 limited and sorted as per the list.

 If exportFields is not provided, the exported output includes all visible fields 
 from this component, sorted as they appear.
- Specified by:
getExportFieldsin interfaceDataBoundComponent- Returns:
- the list of field-names to export.
-
setExportAll
Description copied from interface:DataBoundComponentSetting exportAll to true prevents the component from passing its list of fields to the 
 export call. The result is the export of all visible fields fromfields.

 If exportAll is false, an export operation will first consider 

exportFields, if it's set, and fall back on all visible fields from
fieldsotherwise.- Specified by:
setExportAllin interfaceDataBoundComponent- Parameters:
exportAll- exportAll Default value is false- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getExportAll
Description copied from interface:DataBoundComponentSetting exportAll to true prevents the component from passing its list of fields to the 
 export call. The result is the export of all visible fields fromfields.

 If exportAll is false, an export operation will first consider 

exportFields, if it's set, and fall back on all visible fields from
fieldsotherwise.- Specified by:
getExportAllin interfaceDataBoundComponent- Returns:
- Boolean
-
setExportIncludeSummaries
Description copied from interface:DataBoundComponentIf Summary rows exist for this component, whether to include them when exporting client data. Defaults to true if not set- Specified by:
setExportIncludeSummariesin interfaceDataBoundComponent- Parameters:
exportIncludeSummaries- exportIncludeSummaries Default value is true- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getExportIncludeSummaries
Description copied from interface:DataBoundComponentIf Summary rows exist for this component, whether to include them when exporting client data. Defaults to true if not set- Specified by:
getExportIncludeSummariesin interfaceDataBoundComponent- Returns:
- Boolean
-
setPreventDuplicates
Description copied from interface:DataBoundComponentIf set, detect and prevent duplicate records from being transferred to this component, either via
 drag and drop or viaDataBoundComponent.transferSelectedData(com.smartgwt.client.widgets.DataBoundComponent). When a duplicate transfer is detected,
 a dialog will appear showing theduplicateDragMessage.

 If the component either does not have a
DataSourceor has a DataSource with no
primaryKeydeclared, duplicate checking is off by
 default. If duplicate checking is enabled, it looks for an existing record in the dataset
 that has all of the properties of the dragged record, and considers that a duplicate.

 For
DragDataAction:"copy" where the target DataSource is related to the source
 DataSource by foreignKey, a duplicate means that the target list, as filtered by the current
 criteria, already has a record whose value for the foreignKey field matches the
 primaryKey of the record being transferred.

 For example, consider dragging "employees" to "teams", where "teams" has a field
 "teams.employeeId" which is a foreignKey pointing to "employees.id", and the target
 grid has search criteria causing it to show all the members of one team. A duplicate -
 adding an employee to the same team twice - is when the target grid's dataset contains an
 record with "employeeId" matching the "id" field of the dropped employee.
- Specified by:
setPreventDuplicatesin interfaceDataBoundComponent- Parameters:
preventDuplicates- preventDuplicates Default value is null- Returns:
DataBoundComponentinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getPreventDuplicates
Description copied from interface:DataBoundComponentIf set, detect and prevent duplicate records from being transferred to this component, either via
 drag and drop or viaDataBoundComponent.transferSelectedData(com.smartgwt.client.widgets.DataBoundComponent). When a duplicate transfer is detected,
 a dialog will appear showing theduplicateDragMessage.

 If the component either does not have a
DataSourceor has a DataSource with no
primaryKeydeclared, duplicate checking is off by
 default. If duplicate checking is enabled, it looks for an existing record in the dataset
 that has all of the properties of the dragged record, and considers that a duplicate.

 For
DragDataAction:"copy" where the target DataSource is related to the source
 DataSource by foreignKey, a duplicate means that the target list, as filtered by the current
 criteria, already has a record whose value for the foreignKey field matches the
 primaryKey of the record being transferred.

 For example, consider dragging "employees" to "teams", where "teams" has a field
 "teams.employeeId" which is a foreignKey pointing to "employees.id", and the target
 grid has search criteria causing it to show all the members of one team. A duplicate -
 adding an employee to the same team twice - is when the target grid's dataset contains an
 record with "employeeId" matching the "id" field of the dropped employee.
- Specified by:
getPreventDuplicatesin interfaceDataBoundComponent- Returns:
- Boolean
-
setDuplicateDragMessage
public DetailViewer setDuplicateDragMessage(String duplicateDragMessage) throws IllegalStateException Description copied from interface:DataBoundComponentMessage to show when a user attempts to transfer duplicate records into this component, and
preventDuplicatesis enabled. If set to null, duplicates will not be reported and the dragged duplicates will not be saved.- Specified by:
setDuplicateDragMessagein interfaceDataBoundComponent- Parameters:
duplicateDragMessage- duplicateDragMessage Default value is "Duplicates not allowed"- Returns:
DataBoundComponentinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getDuplicateDragMessage
Description copied from interface:DataBoundComponentMessage to show when a user attempts to transfer duplicate records into this component, and
preventDuplicatesis enabled. If set to null, duplicates will not be reported and the dragged duplicates will not be saved.- Specified by:
getDuplicateDragMessagein interfaceDataBoundComponent- Returns:
- String
-
setAddDropValues
Description copied from interface:DataBoundComponentIndicates whether to add "drop values" to items dropped on this component, if both the source and target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key. "Drop values" are properties of the dropped item that you wish to change (and persist) as a result of the item being dropped on this grid.If this value is true and this component is databound,
DataBoundComponent.getDropValues()will be called for every databound item dropped on this grid, and an update performed on the item- Specified by:
setAddDropValuesin interfaceDataBoundComponent- Parameters:
addDropValues- addDropValues Default value is true- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getAddDropValues
Description copied from interface:DataBoundComponentIndicates whether to add "drop values" to items dropped on this component, if both the source and target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key. "Drop values" are properties of the dropped item that you wish to change (and persist) as a result of the item being dropped on this grid.If this value is true and this component is databound,
DataBoundComponent.getDropValues()will be called for every databound item dropped on this grid, and an update performed on the item- Specified by:
getAddDropValuesin interfaceDataBoundComponent- Returns:
- Boolean
-
setDropValues
Description copied from interface:DataBoundComponentWhen an item is dropped on this component, andaddDropValuesis true and both the source and target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key, this object provides the "drop values" that Smart GWT will apply to the dropped object before updating it.If this property is not defined, Smart GWT defaults to returning the selection criteria currently in place for this component. Thus, any databound items (for example, rows from other grids bound to the same DataSource) dropped on the grid will, by default, be subjected to an update that makes them conform to the grid's current filter criteria.
Note : This is an advanced setting
- Specified by:
setDropValuesin interfaceDataBoundComponent- Parameters:
dropValues- dropValues Default value is null- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getDropValues
Description copied from interface:DataBoundComponentWhen an item is dropped on this component, andaddDropValuesis true and both the source and target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key, this object provides the "drop values" that Smart GWT will apply to the dropped object before updating it.If this property is not defined, Smart GWT defaults to returning the selection criteria currently in place for this component. Thus, any databound items (for example, rows from other grids bound to the same DataSource) dropped on the grid will, by default, be subjected to an update that makes them conform to the grid's current filter criteria.
Note : This is an advanced setting
- Specified by:
getDropValuesin interfaceDataBoundComponent- Returns:
- Returns the "drop values" to apply to a record dropped on this component prior to update. Only
 applicable to databound components - see
dropValuesfor more details. If multiple records 
 are being dropped, this method is called for each of them in turn.

 This method returns the following:

- 

- Nothing, if
addDropValuesis false 
 - dropValues, if that property is set. If the component's criteria object is applicable (as explained
 in the next item), it is merged into dropValues, with properties in dropValues taking precedence. 

- The component's criteria object, if the most recent textMatchStyle for the component was "exact" 
 and it is simple criteria (ie, not an AdvancedCriteria object) 

- Otherwise nothing 


 You can override this method if you need more complex setting of drop values than can be 
 provided by simply supplying a dropValues object.
 

- Nothing, if
-
setProgressiveLoading
Indicates whether or not this component will load its dataprogressively- Parameters:
progressiveLoading-- Returns:
DataBoundComponentinstance, for chaining setter calls- See Also:
-
getProgressiveLoading
Indicates whether or not this component will load its dataprogressively- Returns:
- See Also:
-
setUseFlatFields
Description copied from interface:DataBoundComponentTheuseFlatFieldsflag causes all simple type fields anywhere in a nested
 set of DataSources to be exposed as a flat list for form binding. 


useFlatFieldsis typically used with imported metadata, such as 
XMLTools.loadXMLSchema(java.lang.String, com.smartgwt.client.data.XSDLoadCallback)from a 
XMLTools.loadWSDL(java.lang.String, com.smartgwt.client.data.WSDLLoadCallback), as a means of eliminating levels of XML
 nesting that aren't meaningful in a user interface, without the cumbersome and fragile
 process of mapping form fields to XML structures.

 For example, having called
WebService.getInputDS(java.lang.String)to retrieve the input message
 schema for a web service operation whose input message looks like this:

 <FindServices>
 <searchFor>search text</searchFor>
 <Options>
 <caseSensitive>false</caseSensitive>
 </Options>
 <IncludeInSearch>
 <serviceName>true</serviceName>
 <documentation>true</documentation>
 <keywords>true</keywords>
 </IncludeInSearch>
 </FindServices>


 SettinguseFlatFieldson aDynamicFormthat is bound to this input
 message schema would result in 5FormItemreflecting the 5 simple type
 fields in the message.

 For this form, the result of
DynamicForm.getValues()might look
 like:


{
 searchFor: "search text",
 caseSensitive: false,
 serviceName: true,
 documentation : true,
 keywords : true
 }
 When contacting aWebService, these values can be automatically
 mapped to the structure of the input message for a web service operation by setting
 {@link com.smartgwt.client..WSRequest#getUseFlatFields useFlatFields} (for use withWebService.callOperation(java.lang.String, java.util.Map, java.lang.String, com.smartgwt.client.data.WebServiceCallback)) or by setting
useFlatFields(for use with aDataSourcethat is
'bound to a WSDL web service'via
wsOperation). 

 Using these two facilities in conjunction (component.useFlatFields and
 request.useFlatFields) allows gratuitous nesting to be consistently bypassed in both the user
 presentation and when providing the data for XML messages.


 You can also set
useFlatFieldsto automatically enable 
 "flattened" XML serialization (request.useFlatFields) for all DataSource requests of a
 particular operationType.

 Note that
useFlatFieldsis not generally recommended for use with structures
 where multiple simple type fields exist with the same name, however if used with such a
 structure, the first field to use a given name wins. "first" means the first field
 encountered in a depth first search. "wins" means only the first field will be present as a
 field when data binding.- Specified by:
setUseFlatFieldsin interfaceDataBoundComponent- Parameters:
useFlatFields- useFlatFields Default value is null- Returns:
DataBoundComponentinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getUseFlatFields
Description copied from interface:DataBoundComponentTheuseFlatFieldsflag causes all simple type fields anywhere in a nested
 set of DataSources to be exposed as a flat list for form binding. 


useFlatFieldsis typically used with imported metadata, such as 
XMLTools.loadXMLSchema(java.lang.String, com.smartgwt.client.data.XSDLoadCallback)from a 
XMLTools.loadWSDL(java.lang.String, com.smartgwt.client.data.WSDLLoadCallback), as a means of eliminating levels of XML
 nesting that aren't meaningful in a user interface, without the cumbersome and fragile
 process of mapping form fields to XML structures.

 For example, having called
WebService.getInputDS(java.lang.String)to retrieve the input message
 schema for a web service operation whose input message looks like this:

 <FindServices>
 <searchFor>search text</searchFor>
 <Options>
 <caseSensitive>false</caseSensitive>
 </Options>
 <IncludeInSearch>
 <serviceName>true</serviceName>
 <documentation>true</documentation>
 <keywords>true</keywords>
 </IncludeInSearch>
 </FindServices>


 SettinguseFlatFieldson aDynamicFormthat is bound to this input
 message schema would result in 5FormItemreflecting the 5 simple type
 fields in the message.

 For this form, the result of
DynamicForm.getValues()might look
 like:


{
 searchFor: "search text",
 caseSensitive: false,
 serviceName: true,
 documentation : true,
 keywords : true
 }
 When contacting aWebService, these values can be automatically
 mapped to the structure of the input message for a web service operation by setting
 {@link com.smartgwt.client..WSRequest#getUseFlatFields useFlatFields} (for use withWebService.callOperation(java.lang.String, java.util.Map, java.lang.String, com.smartgwt.client.data.WebServiceCallback)) or by setting
useFlatFields(for use with aDataSourcethat is
'bound to a WSDL web service'via
wsOperation). 

 Using these two facilities in conjunction (component.useFlatFields and
 request.useFlatFields) allows gratuitous nesting to be consistently bypassed in both the user
 presentation and when providing the data for XML messages.


 You can also set
useFlatFieldsto automatically enable 
 "flattened" XML serialization (request.useFlatFields) for all DataSource requests of a
 particular operationType.

 Note that
useFlatFieldsis not generally recommended for use with structures
 where multiple simple type fields exist with the same name, however if used with such a
 structure, the first field to use a given name wins. "first" means the first field
 encountered in a depth first search. "wins" means only the first field will be present as a
 field when data binding.- Specified by:
getUseFlatFieldsin interfaceDataBoundComponent- Returns:
- Boolean
-
setHiliteProperty
Description copied from interface:DataBoundComponentMarker that can be set on a record to flag that record as hilited. Should be set to a value
 that matches {@link com.smartgwt.client..Hilite#getId id} for a hilite defined on this component.- Specified by:
setHilitePropertyin interfaceDataBoundComponent- Parameters:
hiliteProperty- hiliteProperty Default value is "_hilite"- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getHiliteProperty
Description copied from interface:DataBoundComponentMarker that can be set on a record to flag that record as hilited. Should be set to a value
 that matches {@link com.smartgwt.client..Hilite#getId id} for a hilite defined on this component.- Specified by:
getHilitePropertyin interfaceDataBoundComponent- Returns:
- String
-
editFields
public void editFields()Shows a FieldPicker interface allowing end-users to rearrange the order and visibiility of the fields in the associated DataBoundComponent. -
editHilites
public void editHilites()Description copied from interface:DataBoundComponentShows a HiliteEditor interface allowing end-users to edit the data-hilites currently in use by this DataBoundComponent.- Specified by:
editHilitesin interfaceDataBoundComponent
-
getHiliteState
Description copied from interface:DataBoundComponentGet the current hilites encoded as a String, for saving.- Specified by:
getHiliteStatein interfaceDataBoundComponent- Returns:
- the hilite state
-
setHiliteState
Description copied from interface:DataBoundComponentSet the current hilites based on a hiliteState String previously returned from getHilitesState.- Specified by:
setHiliteStatein interfaceDataBoundComponent- Parameters:
hiliteState- hilites state encoded as a String- Returns:
DataBoundComponentinstance, for chaining setter calls
-
setHilites
Description copied from interface:DataBoundComponentAccepts an array of hilite objects and applies them to this DataBoundComponent. See alsogetHilitesfor a method of retrieving the hilite array for storage, including hilites manually added by the user.NOTE: This is only supported on
ListGridfor now.- Specified by:
setHilitesin interfaceDataBoundComponent- Parameters:
hilites- array of hilite objects- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getHilites
Description copied from interface:DataBoundComponentReturn the set of hilite-objects currently applied to this DataBoundComponent. These can be saved for storage and then restored to a component later via setHilites().- Specified by:
getHilitesin interfaceDataBoundComponent- Returns:
- array of hilite objects
-
setDragDataAction
Description copied from interface:DataBoundComponentIndicates what to do with data dragged into another DataBoundComponent. See
 DragDataAction type for details.- Specified by:
setDragDataActionin interfaceDataBoundComponent- Parameters:
dragDataAction- dragDataAction Default value is Canvas.MOVE- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getDragDataAction
Description copied from interface:DataBoundComponentIndicates what to do with data dragged into another DataBoundComponent. See
 DragDataAction type for details.- Specified by:
getDragDataActionin interfaceDataBoundComponent- Returns:
- DragDataAction
-
setDragTrackerStyle
Description copied from interface:DataBoundComponentCSS Style to apply to the drag tracker when dragging occurs on this component.- Specified by:
setDragTrackerStylein interfaceDataBoundComponent- Parameters:
dragTrackerStyle- dragTrackerStyle Default value is "gridDragTracker"- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getDragTrackerStyle
Description copied from interface:DataBoundComponentCSS Style to apply to the drag tracker when dragging occurs on this component.- Specified by:
getDragTrackerStylein interfaceDataBoundComponent- Returns:
- String
-
setCanAddFormulaFields
Description copied from interface:DataBoundComponentAdds an item to the header context menu allowing users to launch a dialog to define a new
 field based on values present in other fields, using the {@link com.smartgwt.client..FormulaBuilder}.

 User-added formula fields can be persisted via
ListGrid.getFieldState()and 
ListGrid.setFieldState(java.lang.String).- Specified by:
setCanAddFormulaFieldsin interfaceDataBoundComponent- Parameters:
canAddFormulaFields- canAddFormulaFields Default value is false- Returns:
DataBoundComponentinstance, for chaining setter calls
-
addSummaryField
public void addSummaryField()Description copied from interface:DataBoundComponentConvenience method to display a {@link com.smartgwt.client..SummaryBuilder} to create a new Summary Field. This 
 is equivalent to callingDataBoundComponentGen#editSummaryFieldwith 
 no parameter.

- Specified by:
addSummaryFieldin interfaceDataBoundComponent
-
addFormulaField
public void addFormulaField()Description copied from interface:DataBoundComponentConvenience method to display a {@link com.smartgwt.client..FormulaBuilder} to create a new Formula Field. This 
 is equivalent to callingDataBoundComponentGen#editFormulaFieldwith 
 no parameter.

- Specified by:
addFormulaFieldin interfaceDataBoundComponent
-
getCanAddFormulaFields
Description copied from interface:DataBoundComponentAdds an item to the header context menu allowing users to launch a dialog to define a new
 field based on values present in other fields, using the {@link com.smartgwt.client..FormulaBuilder}.

 User-added formula fields can be persisted via
ListGrid.getFieldState()and 
ListGrid.setFieldState(java.lang.String).- Specified by:
getCanAddFormulaFieldsin interfaceDataBoundComponent- Returns:
- Boolean
-
setAddFormulaFieldText
Description copied from interface:DataBoundComponentText for a menu item allowing users to add a formula field- Specified by:
setAddFormulaFieldTextin interfaceDataBoundComponent- Parameters:
addFormulaFieldText- addFormulaFieldText Default value is "Add formula column..."- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getAddFormulaFieldText
Description copied from interface:DataBoundComponentText for a menu item allowing users to add a formula field- Specified by:
getAddFormulaFieldTextin interfaceDataBoundComponent- Returns:
- String
-
setEditFormulaFieldText
Description copied from interface:DataBoundComponentText for a menu item allowing users to edit a formula field- Specified by:
setEditFormulaFieldTextin interfaceDataBoundComponent- Parameters:
editFormulaFieldText- editFormulaFieldText Default value is "Edit formula..."- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getEditFormulaFieldText
Description copied from interface:DataBoundComponentText for a menu item allowing users to edit a formula field- Specified by:
getEditFormulaFieldTextin interfaceDataBoundComponent- Returns:
- String
-
setCanAddSummaryFields
Description copied from interface:DataBoundComponentAdds an item to the header context menu allowing users to launch a dialog to define a new
 text field that can contain both user-defined text and the formatted values present in other 
 fields, using the {@link com.smartgwt.client..SummaryBuilder}.

 User-added summary fields can be persisted via
ListGrid.getFieldState()and 
ListGrid.setFieldState(java.lang.String).- Specified by:
setCanAddSummaryFieldsin interfaceDataBoundComponent- Parameters:
canAddSummaryFields- canAddSummaryFields Default value is false- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getCanAddSummaryFields
Description copied from interface:DataBoundComponentAdds an item to the header context menu allowing users to launch a dialog to define a new
 text field that can contain both user-defined text and the formatted values present in other 
 fields, using the {@link com.smartgwt.client..SummaryBuilder}.

 User-added summary fields can be persisted via
ListGrid.getFieldState()and 
ListGrid.setFieldState(java.lang.String).- Specified by:
getCanAddSummaryFieldsin interfaceDataBoundComponent- Returns:
- Boolean
-
setAddSummaryFieldText
Description copied from interface:DataBoundComponentText for a menu item allowing users to add a formula field- Specified by:
setAddSummaryFieldTextin interfaceDataBoundComponent- Parameters:
addSummaryFieldText- addSummaryFieldText Default value is "Add summary column..."- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getAddSummaryFieldText
Description copied from interface:DataBoundComponentText for a menu item allowing users to add a formula field- Specified by:
getAddSummaryFieldTextin interfaceDataBoundComponent- Returns:
- String
-
setEditSummaryFieldText
Description copied from interface:DataBoundComponentText for a menu item allowing users to edit the formatter for a field- Specified by:
setEditSummaryFieldTextin interfaceDataBoundComponent- Parameters:
editSummaryFieldText- editSummaryFieldText Default value is "Edit summary format..."- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getEditSummaryFieldText
Description copied from interface:DataBoundComponentText for a menu item allowing users to edit the formatter for a field- Specified by:
getEditSummaryFieldTextin interfaceDataBoundComponent- Returns:
- String
-
setSavedSearchId
Description copied from interface:DataBoundComponentOptional identifier for saved searches that should be applied to this component.By default
SavedSearchesare associated with a component via itslocal IDandDataSource ID. This property allows developers to override this behavior and explicitly associate a component with a set of saved searches. This can provide a couple of benefits:
Firstly this ensures that saved searches will be unambiguously associated with the particular component even if the page changes such that a stored minimal locator would no longer applied to the component, without requiring an explicitCanvas.ID.
Secondly this allows the same set of saved searches to be applied to more than one component on a page. This may be valueable for cases where the same information from the same dataSource is presented to users in multiple places.Note: This is an advanced setting.
- Specified by:
setSavedSearchIdin interfaceDataBoundComponent- Parameters:
savedSearchId- New savedSearchId value. Default value is null- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getSavedSearchId
Description copied from interface:DataBoundComponentOptional identifier for saved searches that should be applied to this component.By default
SavedSearchesare associated with a component via itslocal IDandDataSource ID. This property allows developers to override this behavior and explicitly associate a component with a set of saved searches. This can provide a couple of benefits:
Firstly this ensures that saved searches will be unambiguously associated with the particular component even if the page changes such that a stored minimal locator would no longer applied to the component, without requiring an explicitCanvas.ID.
Secondly this allows the same set of saved searches to be applied to more than one component on a page. This may be valueable for cases where the same information from the same dataSource is presented to users in multiple places.- Specified by:
getSavedSearchIdin interfaceDataBoundComponent- Returns:
- Current savedSearchId value. Default value is null
-
setShowSavedSearchesByDS
public DetailViewer setShowSavedSearchesByDS(boolean showSavedSearchesByDS) throws IllegalStateException Description copied from interface:DataBoundComponentWhether to associate saved searches by default with the currentDataSourceof a component when asavedSearchIdis not provided. If this property is true, then when the DataSource is changed, existing saved searches will disappear and only be available if the DataSource is set back to its original value.If this property is false, saved searches will persist across DataSource changes so that searches that aren't applicable to the current DataSource might still be shown.
Note: This is an advanced setting
- Specified by:
setShowSavedSearchesByDSin interfaceDataBoundComponent- Parameters:
showSavedSearchesByDS- New showSavedSearchesByDS value. Default value is true- Returns:
DataBoundComponentinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getShowSavedSearchesByDS
public boolean getShowSavedSearchesByDS()Description copied from interface:DataBoundComponentWhether to associate saved searches by default with the currentDataSourceof a component when asavedSearchIdis not provided. If this property is true, then when the DataSource is changed, existing saved searches will disappear and only be available if the DataSource is set back to its original value.If this property is false, saved searches will persist across DataSource changes so that searches that aren't applicable to the current DataSource might still be shown.
- Specified by:
getShowSavedSearchesByDSin interfaceDataBoundComponent- Returns:
- Current showSavedSearchesByDS value. Default value is true
-
findAll
Filters all objects according to the AdvancedCriteria passed- Parameters:
adCriteria- AdvancedCriteria to use to filter results- Returns:
- all matching Objects or null if none found
-
find
Filters all objects according to the AdvancedCriteria passed and returns the first matching object or null if not found- Parameters:
adCriteria- AdvancedCriteria to use to filter results- Returns:
- first matching object or null if not found
-
findIndex
Finds the index of the first Record that matches with the AdvacendCriteria passed.- Parameters:
adCriteria- AdvancedCriteria to use to filter results- Returns:
- index of the first matching Record or -1 if not found
-
findNextIndex
LikeRecordList.findIndex(java.util.Map), but considering the startIndex and endIndex parameters.- Parameters:
startIndex- first index to consideradCriteria- AdvancedCriteria to use to filter resultsendIndex- last index to consider- Returns:
- index of the first matching Record or -1 if not found
-
findNextIndex
LikeRecordList.findIndex(java.util.Map), but considering the startIndex parameter.- Parameters:
startIndex- first index to consideradCriteria- AdvancedCriteria to use to filter results- Returns:
- index of the first matching Record or -1 if not found
-
selectRecord
Description copied from interface:DataBoundComponentSelect/deselect aRecordpassed in explicitly, or by index.- Specified by:
selectRecordin interfaceDataBoundComponent- Parameters:
record- record (or row number) to select
-
selectRecord
public void selectRecord(int record) Description copied from interface:DataBoundComponentSelect/deselect aRecordpassed in explicitly, or by index.- Specified by:
selectRecordin interfaceDataBoundComponent- Parameters:
record- record (or row number) to select
-
selectRecord
public void selectRecord(int record, boolean newState) Description copied from interface:DataBoundComponentSelect/deselect aRecordpassed in explicitly, or by index.- Specified by:
selectRecordin interfaceDataBoundComponent- Parameters:
record- record (or row number) to selectnewState- new selection state (if null, defaults to true)
-
selectRecord
Description copied from interface:DataBoundComponentSelect/deselect aRecordpassed in explicitly, or by index.- Specified by:
selectRecordin interfaceDataBoundComponent- Parameters:
record- record (or row number) to selectnewState- new selection state (if null, defaults to true)
-
selectRecords
public void selectRecords(int[] records) Description copied from interface:DataBoundComponentSelect/deselect a list ofRecords passed in explicitly, or by index.- Specified by:
selectRecordsin interfaceDataBoundComponent- Parameters:
records- records (or row numbers) to select
-
selectRecords
public void selectRecords(int[] records, boolean newState) Description copied from interface:DataBoundComponentSelect/deselect a list ofRecords passed in explicitly, or by index.- Specified by:
selectRecordsin interfaceDataBoundComponent- Parameters:
records- records (or row numbers) to selectnewState- new selection state
-
selectRecords
Description copied from interface:DataBoundComponentSelect/deselect a list ofRecords passed in explicitly, or by index.- Specified by:
selectRecordsin interfaceDataBoundComponent- Parameters:
records- records (or row numbers) to select
-
selectRecords
Description copied from interface:DataBoundComponentSelect/deselect a list ofRecords passed in explicitly, or by index.- Specified by:
selectRecordsin interfaceDataBoundComponent- Parameters:
records- records (or row numbers) to selectnewState- new selection state (if null, defaults to true)
-
deselectRecord
Description copied from interface:DataBoundComponentDeselect aRecordpassed in explicitly, or by index.Synonym for
selectRecord(record, false)- Specified by:
deselectRecordin interfaceDataBoundComponent- Parameters:
record- record (or row number) to deselect
-
deselectRecord
public void deselectRecord(int record) Description copied from interface:DataBoundComponentDeselect aRecordpassed in explicitly, or by index.Synonym for
selectRecord(record, false)- Specified by:
deselectRecordin interfaceDataBoundComponent- Parameters:
record- record (or row number) to deselect
-
deselectRecords
public void deselectRecords(int[] records) Description copied from interface:DataBoundComponentDeselect a list ofRecords passed in explicitly, or by index.Synonym for
selectRecords(records, false)- Specified by:
deselectRecordsin interfaceDataBoundComponent- Parameters:
records- records (or row numbers) to deselect
-
deselectRecords
Description copied from interface:DataBoundComponentDeselect a list ofRecords passed in explicitly, or by index.Synonym for
selectRecords(records, false)- Specified by:
deselectRecordsin interfaceDataBoundComponent- Parameters:
records- records (or row numbers) to deselect
-
selectAllRecords
public void selectAllRecords()Description copied from interface:DataBoundComponentSelect all records

- Specified by:
selectAllRecordsin interfaceDataBoundComponent
-
deselectAllRecords
public void deselectAllRecords()Description copied from interface:DataBoundComponent
 Deselect all records

- Specified by:
deselectAllRecordsin interfaceDataBoundComponent
-
anySelected
Description copied from interface:DataBoundComponentWhether at least one item is selected
- Specified by:
anySelectedin interfaceDataBoundComponent- Returns:
- true == at least one item is selected false == nothing at all is selected
-
enableHilite
Description copied from interface:DataBoundComponentEnable / disable ahilites

- Specified by:
enableHilitein interfaceDataBoundComponent- Parameters:
hiliteID- ID of hilite to enable
-
enableHilite
Description copied from interface:DataBoundComponentEnable / disable ahilites

- Specified by:
enableHilitein interfaceDataBoundComponent- Parameters:
hiliteID- ID of hilite to enableenable- new enabled state to apply - if null, defaults to true
-
disableHilite
Description copied from interface:DataBoundComponentDisable a hilite

- Specified by:
disableHilitein interfaceDataBoundComponent- Parameters:
hiliteID- ID of hilite to disable
-
enableHiliting
public void enableHiliting()Description copied from interface:DataBoundComponentEnable all hilites.

- Specified by:
enableHilitingin interfaceDataBoundComponent
-
enableHiliting
public void enableHiliting(boolean enable) Description copied from interface:DataBoundComponentEnable all hilites.

- Specified by:
enableHilitingin interfaceDataBoundComponent- Parameters:
enable- new enabled state to apply - if null, defaults to true
-
disableHiliting
public void disableHiliting()Description copied from interface:DataBoundComponentDisable all hilites.

- Specified by:
disableHilitingin interfaceDataBoundComponent
-
getDragData
Description copied from interface:DataBoundComponentDuring a drag-and-drop interaction, this method returns the set of records being dragged out of the component. In the default implementation, this is the list of currently selected records.This method is consulted by

ListGrid.willAcceptDrop().- Specified by:
getDragDatain interfaceDataBoundComponent- Returns:
- Array of
Records that are currently selected.
-
transferSelectedData
Description copied from interface:DataBoundComponentSimulates a drag / drop type transfer of the selected records in some other component to this component, without requiring any user interaction. This method acts on the dropped records exactly as if they had been dropped in an actual drag / drop interaction, including any special databound behavior invoked by callingDataBoundComponent.getDropValues()for each dropped record.To transfer all data in, for example, a
ListGrid, call grid.selection.selectAll() first.Note that drag/drop type transfers of records between components are asynchronous operations: Smart GWT may need to perform server turnarounds to establish whether dropped records already exist in the target component. Therefore, it is possible to issue a call to
transferSelectedData()and/or thedrop()method of a databound component whilst a transfer is still active. When this happens, Smart GWT adds the second and subsequent transfer requests to a queue and runs them one after the other. If you want to be notified when a transfer process has actually completed, useHasDropCompleteHandlers.addDropCompleteHandler(com.smartgwt.client.widgets.events.DropCompleteHandler). See theDraggingdocumentation for an overview of list grid drag/drop data transfer.- Specified by:
transferSelectedDatain interfaceDataBoundComponent- Parameters:
source- source component from which the records will be tranferred
-
transferSelectedData
Description copied from interface:DataBoundComponentSimulates a drag / drop type transfer of the selected records in some other component to this component, without requiring any user interaction. This method acts on the dropped records exactly as if they had been dropped in an actual drag / drop interaction, including any special databound behavior invoked by callingDataBoundComponent.getDropValues()for each dropped record.To transfer all data in, for example, a
ListGrid, call grid.selection.selectAll() first.Note that drag/drop type transfers of records between components are asynchronous operations: Smart GWT may need to perform server turnarounds to establish whether dropped records already exist in the target component. Therefore, it is possible to issue a call to
transferSelectedData()and/or thedrop()method of a databound component whilst a transfer is still active. When this happens, Smart GWT adds the second and subsequent transfer requests to a queue and runs them one after the other. If you want to be notified when a transfer process has actually completed, useHasDropCompleteHandlers.addDropCompleteHandler(com.smartgwt.client.widgets.events.DropCompleteHandler). See theDraggingdocumentation for an overview of list grid drag/drop data transfer.- Specified by:
transferSelectedDatain interfaceDataBoundComponent- Parameters:
source- source component from which the records will be transferredindex- target index (drop position) of the rows within this grid.
-
getRecordIndex
Description copied from interface:DataBoundComponentGet the index of the provided record.

 Override in subclasses to provide more specific behaviour, for instance, when data holds a
 large number of records


- Specified by:
getRecordIndexin interfaceDataBoundComponent- Parameters:
record- the record whose index is to be retrieved- Returns:
- indexindex of the record, or -1 if not found
-
getTitleFieldValue
Description copied from interface:DataBoundComponentGet the value of the titleField for the passed record

 Override in subclasses 


- Specified by:
getTitleFieldValuein interfaceDataBoundComponent- Parameters:
record- the record whose index is to be retrieved- Returns:
- valuethe value of the titleField for the passed record
-
setTitleField
Description copied from interface:DataBoundComponentSets the best field to use for a user-visible title for an individual record from this component.- Specified by:
setTitleFieldin interfaceDataBoundComponent- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getTitleField
Description copied from interface:DataBoundComponentMethod to return the fieldName which represents the "title" for records in this
 Component.

 If this.titleField is explicitly specified it will always be used.
 Otherwise, default implementation will checktitleFieldfor databound
 components.

 For non databound components returns the first defined field name of"title", 
"name", or"id". If we dont find any field-names that match these
 titles, the first field in the component will be used instead.
- Specified by:
getTitleFieldin interfaceDataBoundComponent- Returns:
- fieldName the title field for this component.
-
getDataSource
Description copied from interface:DataBoundComponentThe DataSource that this component should bind to for default fields and for performingDataSource requests.- Specified by:
getDataSourcein interfaceDataBoundComponent- Returns:
- DataSource
-
setAutoFetchData
Description copied from interface:DataBoundComponentIf true, when this component is first drawn, automatically callDataBoundComponent.fetchData()orDataBoundComponent.filterData()depending onDataBoundComponent.getAutoFetchAsFilter(). Criteria for this fetch may be picked up frominitialCriteriaand textMatchStyle may be specified viaDataBoundComponent.getAutoFetchTextMatchStyle().NOTE: If autoFetchData is set, calling ListGrid.fetchData() before draw will cause two requests to be issued, one from the manual call to fetchData() and one from the autoFetchData setting. The second request will use only
initialCriteriaand not any other criteria or settings from the first request. Generally, turn off autoFetchData if you are going to manually call fetchData() at any time.- Specified by:
setAutoFetchDatain interfaceDataBoundComponent- Parameters:
autoFetchData- autoFetchData- Returns:
DataBoundComponentinstance, for chaining setter calls- Throws:
IllegalStateException
-
getAutoFetchData
Description copied from interface:DataBoundComponentIf true, when this component is first drawn, automatically callDataBoundComponent.fetchData()orDataBoundComponent.filterData()depending onDataBoundComponent.getAutoFetchAsFilter(). Criteria for this fetch may be picked up frominitialCriteriaand textMatchStyle may be specified viaDataBoundComponent.getAutoFetchTextMatchStyle().NOTE: If autoFetchData is set, calling ListGrid.fetchData() before draw will cause two requests to be issued, one from the manual call to fetchData() and one from the autoFetchData setting. The second request will use only
initialCriteriaand not any other criteria or settings from the first request. Generally, turn off autoFetchData if you are going to manually call fetchData() at any time.- Specified by:
getAutoFetchDatain interfaceDataBoundComponent- Returns:
- autoFetchData autoFetchData
-
setAutoFetchTextMatchStyle
public DetailViewer setAutoFetchTextMatchStyle(TextMatchStyle autoFetchTextMatchStyle) throws IllegalStateException Description copied from interface:DataBoundComponentIfautoFetchDataistrue, this attribute allows the developer to specify a textMatchStyle for the initialDataBoundComponent.fetchData()call.- Specified by:
setAutoFetchTextMatchStylein interfaceDataBoundComponent- Returns:
DataBoundComponentinstance, for chaining setter calls- Throws:
IllegalStateException
-
getAutoFetchTextMatchStyle
Description copied from interface:DataBoundComponentIfautoFetchDataistrue, this attribute allows the developer to specify a textMatchStyle for the initialDataBoundComponent.fetchData()call.- Specified by:
getAutoFetchTextMatchStylein interfaceDataBoundComponent- Returns:
- autoFetchTextMatchStyle autoFetchTextMatchStyle
-
setAutoFetchAsFilter
Description copied from interface:DataBoundComponentIfDataBoundComponent.setAutoFetchData(Boolean)is true, this attribute determines whether the initial fetch operation should be performed viaDataBoundComponent.fetchData()orDataBoundComponent.filterData()- Specified by:
setAutoFetchAsFilterin interfaceDataBoundComponent- Parameters:
autoFetchAsFilter- autoFetchAsFilter- Returns:
DataBoundComponentinstance, for chaining setter calls- Throws:
IllegalStateException
-
getAutoFetchAsFilter
Description copied from interface:DataBoundComponentIfDataBoundComponent.setAutoFetchData(Boolean)is true, this attribute determines whether the initial fetch operation should be performed viaDataBoundComponent.fetchData()orDataBoundComponent.filterData()- Specified by:
getAutoFetchAsFilterin interfaceDataBoundComponent- Returns:
- auto fetch as filter
-
setInitialCriteria
Description copied from interface:DataBoundComponentCriteria to use whenDataBoundComponent.setAutoFetchData(Boolean)is used.- Specified by:
setInitialCriteriain interfaceDataBoundComponent- Parameters:
initialCriteria- the initial criteria- Returns:
DataBoundComponentinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getInitialCriteria
Description copied from interface:DataBoundComponentCriteria to use whenDataBoundComponent.setAutoFetchData(Boolean)is used.- Specified by:
getInitialCriteriain interfaceDataBoundComponent- Returns:
- the criteria
-
setImplicitCriteria
Description copied from interface:DataBoundComponentCriteria that are never shown to or edited by the user and are cumulative with any criteria provided viaDataBoundComponent.initialCriteria,DataBoundComponent.setCriteria()etc.- Specified by:
setImplicitCriteriain interfaceDataBoundComponent- Parameters:
implicitCriteria- New implicitCriteria value. Default value is null- Returns:
DataBoundComponentinstance, for chaining setter calls
-
setImplicitCriteria
-
setImplicitCriteria
-
getImplicitCriteria
Description copied from interface:DataBoundComponentCriteria that are never shown to or edited by the user and are cumulative with any criteria provided viaDataBoundComponent.initialCriteria,DataBoundComponent.setCriteria()etc.- Specified by:
getImplicitCriteriain interfaceDataBoundComponent- Returns:
- Current implicitCriteria value. Default value is null
-
fetchData
public void fetchData()Description copied from interface:DataBoundComponentRetrieves data from the DataSource that matches the specified criteria.When
fetchData()is first called, if data has not already been provided viasetData(), this method will create aResultSet, which will be configured based on component settings such asfetchOperationanddataPageSize, as well as the general purposedataProperties. The created ResultSet will automatically send a DSRequest to retrieve data from the dataSource, and from then on will automatically manage paging through large datasets, as well as performing filtering and sorting operations inside the browser when possible - see the ResultSet docs for details.NOTE: do not use both
autoFetchDataand a call tofetchData()- this may result in two DSRequests to fetch data. Use eitherautoFetchDataandsetAutoFetchCriteria()or a manual call to fetchData() passing criteria.Whether a ResultSet was automatically created or provided via
setData(), subsequent calls to fetchData() will simply callresultSet.setCriteria().Changes to criteria may or may not result in a DSRequest to the server due to client-side filtering. You can call
willFetchData(criteria)to determine if new criteria will result in a server fetch.If you need to force data to be re-fetched, you can call
invalidateCache()and new data will automatically be fetched from the server using the current criteria and sort direction. NOTE: when usinginvalidateCache()there is no need to also callfetchData()and in fact this could produce unexpected results.This method takes an optional callback parameter (set to a
DSCallback) to fire when the fetch completes. Note that this callback will not fire if no server fetch is performed. In this case the data is updated synchronously, so as soon as this method completes you can interact with the new data. If necessary, you can useresultSet.willFetchData()to determine whether or not a server fetch will occur whenfetchData()is called with new criteria.In addition to the callback parameter for this method, developers can use
resultSet.addDataArrivedHandlerto be notified every time data is loaded.- Specified by:
fetchDatain interfaceDataBoundComponent
-
fetchData
Description copied from interface:DataBoundComponentRetrieves data from the DataSource that matches the specified criteria.When
fetchData()is first called, if data has not already been provided viasetData(), this method will create aResultSet, which will be configured based on component settings such asfetchOperationanddataPageSize, as well as the general purposedataProperties. The created ResultSet will automatically send a DSRequest to retrieve data from the dataSource, and from then on will automatically manage paging through large datasets, as well as performing filtering and sorting operations inside the browser when possible - see the ResultSet docs for details.NOTE: do not use both
autoFetchDataand a call tofetchData()- this may result in two DSRequests to fetch data. Use eitherautoFetchDataandsetAutoFetchCriteria()or a manual call to fetchData() passing criteria.Whether a ResultSet was automatically created or provided via
setData(), subsequent calls to fetchData() will simply callresultSet.setCriteria().Changes to criteria may or may not result in a DSRequest to the server due to client-side filtering. You can call
willFetchData(criteria)to determine if new criteria will result in a server fetch.If you need to force data to be re-fetched, you can call
invalidateCache()and new data will automatically be fetched from the server using the current criteria and sort direction. NOTE: when usinginvalidateCache()there is no need to also callfetchData()and in fact this could produce unexpected results.This method takes an optional callback parameter (set to a
DSCallback) to fire when the fetch completes. Note that this callback will not fire if no server fetch is performed. In this case the data is updated synchronously, so as soon as this method completes you can interact with the new data. If necessary, you can useresultSet.willFetchData()to determine whether or not a server fetch will occur whenfetchData()is called with new criteria.In addition to the callback parameter for this method, developers can use
resultSet.addDataArrivedHandlerto be notified every time data is loaded.- Specified by:
fetchDatain interfaceDataBoundComponent- Parameters:
criteria- Search criteria. If aDynamicFormis passed in as this argument instead of a raw criteria object, will be derived by callingDynamicForm.getValuesAsCriteria()
-
fetchData
Description copied from interface:DataBoundComponentRetrieves data from the DataSource that matches the specified criteria.When
fetchData()is first called, if data has not already been provided viasetData(), this method will create aResultSet, which will be configured based on component settings such asfetchOperationanddataPageSize, as well as the general purposedataProperties. The created ResultSet will automatically send a DSRequest to retrieve data from the dataSource, and from then on will automatically manage paging through large datasets, as well as performing filtering and sorting operations inside the browser when possible - see the ResultSet docs for details.NOTE: do not use both
autoFetchDataand a call tofetchData()- this may result in two DSRequests to fetch data. Use eitherautoFetchDataandsetAutoFetchCriteria()or a manual call to fetchData() passing criteria.Whether a ResultSet was automatically created or provided via
setData(), subsequent calls to fetchData() will simply callresultSet.setCriteria().Changes to criteria may or may not result in a DSRequest to the server due to client-side filtering. You can call
willFetchData(criteria)to determine if new criteria will result in a server fetch.If you need to force data to be re-fetched, you can call
invalidateCache()and new data will automatically be fetched from the server using the current criteria and sort direction. NOTE: when usinginvalidateCache()there is no need to also callfetchData()and in fact this could produce unexpected results.This method takes an optional callback parameter (set to a
DSCallback) to fire when the fetch completes. Note that this callback will not fire if no server fetch is performed. In this case the data is updated synchronously, so as soon as this method completes you can interact with the new data. If necessary, you can useresultSet.willFetchData()to determine whether or not a server fetch will occur whenfetchData()is called with new criteria.In addition to the callback parameter for this method, developers can use
resultSet.addDataArrivedHandlerto be notified every time data is loaded.- Specified by:
fetchDatain interfaceDataBoundComponent- Parameters:
criteria- Search criteria. If aDynamicFormis passed in as this argument instead of a raw criteria object, will be derived by callingDynamicForm.getValuesAsCriteria()callback- callback to invoke when a fetch is complete. Fires only if server contact was required
-
fetchData
Description copied from interface:DataBoundComponentRetrieves data from the DataSource that matches the specified criteria.When
fetchData()is first called, if data has not already been provided viasetData(), this method will create aResultSet, which will be configured based on component settings such asfetchOperationanddataPageSize, as well as the general purposedataProperties. The created ResultSet will automatically send a DSRequest to retrieve data from the dataSource, and from then on will automatically manage paging through large datasets, as well as performing filtering and sorting operations inside the browser when possible - see the ResultSet docs for details.NOTE: do not use both
autoFetchDataand a call tofetchData()- this may result in two DSRequests to fetch data. Use eitherautoFetchDataandsetAutoFetchCriteria()or a manual call to fetchData() passing criteria.Whether a ResultSet was automatically created or provided via
setData(), subsequent calls to fetchData() will simply callresultSet.setCriteria().Changes to criteria may or may not result in a DSRequest to the server due to client-side filtering. You can call
willFetchData(criteria)to determine if new criteria will result in a server fetch.If you need to force data to be re-fetched, you can call
invalidateCache()and new data will automatically be fetched from the server using the current criteria and sort direction. NOTE: when usinginvalidateCache()there is no need to also callfetchData()and in fact this could produce unexpected results.This method takes an optional callback parameter (set to a
DSCallback) to fire when the fetch completes. Note that this callback will not fire if no server fetch is performed. In this case the data is updated synchronously, so as soon as this method completes you can interact with the new data. If necessary, you can useresultSet.willFetchData()to determine whether or not a server fetch will occur whenfetchData()is called with new criteria.In addition to the callback parameter for this method, developers can use
resultSet.addDataArrivedHandlerto be notified every time data is loaded.- Specified by:
fetchDatain interfaceDataBoundComponent- Parameters:
criteria- Search criteria. If aDynamicFormis passed in as this argument instead of a raw criteria object, will be derived by callingDynamicForm.getValuesAsCriteria()callback- callback to invoke when a fetch is complete. Fires only if server contact was requiredrequestProperties- additional properties to set on the DSRequest that will be issued
-
filterData
public void filterData()Description copied from interface:DataBoundComponentRetrieves data that matches the provided criteria and displays the matching data in this component.This method behaves exactly like
ListGrid.fetchData()except thattextMatchStyleis automatically set to "substring" so that String-valued fields are matched by case-insensitive substring comparison.- Specified by:
filterDatain interfaceDataBoundComponent
-
filterData
Description copied from interface:DataBoundComponentRetrieves data that matches the provided criteria and displays the matching data in this component.This method behaves exactly like
ListGrid.fetchData()except thattextMatchStyleis automatically set to "substring" so that String-valued fields are matched by case-insensitive substring comparison.- Specified by:
filterDatain interfaceDataBoundComponent- Parameters:
criteria- Search criteria. If aDynamicFormis passed in as this argument instead of a raw criteria object, will be derived by callingDynamicForm.getValuesAsCriteria()
-
filterData
Description copied from interface:DataBoundComponentRetrieves data that matches the provided criteria and displays the matching data in this component.This method behaves exactly like
ListGrid.fetchData()except thattextMatchStyleis automatically set to "substring" so that String-valued fields are matched by case-insensitive substring comparison.- Specified by:
filterDatain interfaceDataBoundComponent- Parameters:
criteria- Search criteria. If aDynamicFormis passed in as this argument instead of a raw criteria object, will be derived by callingDynamicForm.getValuesAsCriteria()callback- callback to invoke when a fetch is complete. Fires only if server contact was required; seeDataBoundComponent.fetchData()for details
-
filterData
Description copied from interface:DataBoundComponentRetrieves data that matches the provided criteria and displays the matching data in this component.This method behaves exactly like
ListGrid.fetchData()except thattextMatchStyleis automatically set to "substring" so that String-valued fields are matched by case-insensitive substring comparison.- Specified by:
filterDatain interfaceDataBoundComponent- Parameters:
criteria- Search criteria. If aDynamicFormis passed in as this argument instead of a raw criteria object, will be derived by callingDynamicForm.getValuesAsCriteria()callback- callback to invoke when a fetch is complete. Fires only if server contact was required; seeDataBoundComponent.fetchData()for detailsrequestProperties- for databound components only - optional additional properties to set on the DSRequest that will be issued
-
invalidateCache
public void invalidateCache()Description copied from interface:DataBoundComponentInvalidate the current data cache for this databound component via a call to the dataset'sinvalidateCache()method, for example,ResultSet.invalidateCache().NOTE: there is no need to call
invalidateCache()when a save operation is performed on a DataSource. Automatic cache synchronization features will automatically update caches - seeResultSetfor details. If automatic cache synchronization isn't working, troubleshoot the problem using the steps suggested in the FAQ rather than just calling invalidateCache(). CallinginvalidateCache()unnecessarily causes extra server load and added code complexity.Calling
invalidateCache()will automatically cause a new fetch to be performed with the current set of criteria if data had been previously fetched and the component is currently drawn with data visible - there is no need to manually call fetchData() after invalidateCache() and this could result in duplicate fetches.While data is being re-loaded after a call to
invalidateCache(), the widget is in a state similar to initial data load - it doesn't know the total length of the dataset and any APIs that act on records or row indices will necessarily fail and should not be called. To detect that the widget is in this state, callResultSet.lengthIsKnown().invalidateCache()only has an effect if this component's dataset is a data manager class that manages a cache (eg ResultSet or ResultTree). If data was provided as a simple Array or List, invalidateCache() does nothing.- Specified by:
invalidateCachein interfaceDataBoundComponent- See Also:
-
getResultSet
Description copied from interface:DataBoundComponentReturn the underlying data of this DataBoundComponent as aResultSet.Note that this method should only be called after initial data has been fetched by this DataBoundComponent.
- Specified by:
getResultSetin interfaceDataBoundComponent- Returns:
- ResultSet, or null if the underlying data is not a ResultSet
- See Also:
-
getRecordList
Description copied from interface:DataBoundComponentReturn the underlying data of this DataBoundComponent as aRecordList.Depending on the component configuration, the actual JavaScript instance of the returned RecordList may be one of several types:
- If the component is not bound to a
DataSource, the instance is generally an Array ofRecord. - If the component is bound to a DataSource, the instance is a
ResultSet. - If the component is a grouped ListGrid, the instance is a
Tree. To access the ungrouped record list regardless of grouping status, useisGrouped() ? getOriginalRecordList() : getRecordList()
- If the component is a
TreeGrid, the instance is a ResultTree.
- Specified by:
getRecordListin interfaceDataBoundComponent- Returns:
- the RecordList
- If the component is not bound to a
-
getDataAsJSList
- Specified by:
getDataAsJSListin interfaceDataBoundComponent
-
exportData
public void exportData()Description copied from interface:DataBoundComponent- Specified by:
exportDatain interfaceDataBoundComponent
-
exportData
Description copied from interface:DataBoundComponent- Specified by:
exportDatain interfaceDataBoundComponent
-
exportData
Description copied from interface:DataBoundComponentUses a "fetch" operation on the currentDataSourceto retrieve data that matches the current filter and sort criteria for this component, then exports the resulting data to a file or window in the requested format.A variety of DSRequest settings, such as
exportAsandexportFilename, affect the exporting process: seeexportResultsfor further detail.Note that data exported via this method does not include any client-side formatting and relies on both the Smart GWT server and server-side DataSources. To export client-data with formatters applied, see
exportClientData, which still requires the Smart GWT server but does not rely on server-side DataSources.For more information on exporting data, see
DataSource.exportData.- Specified by:
exportDatain interfaceDataBoundComponent- Parameters:
requestProperties- additional properties to set on DSRequest that will be issuedcallback- Optional callback. Note that this parameter only applies if you specifyexportToClient: false in the request properties, because file downloads don't provide ordinary framework callbacks- See Also:
-
addFetchDataHandler
Add a fetchData handler.Notification function fired on fetchData() or filterData()
- Specified by:
addFetchDataHandlerin interfaceHasFetchDataHandlers- Parameters:
handler- the filterData handler- Returns:
HandlerRegistrationused to remove this handler
-
addDropCompleteHandler
Add acom.smartgwt.client.widgets.DropCompleteHandler. See that class's documentation for a definition of "drop complete", and how it differs from "drag complete" (com.smartgwt.client.widgets.DragCompleteHandler).- Specified by:
addDropCompleteHandlerin interfaceHasDropCompleteHandlers- Parameters:
handler- the DropCompleteHandler- Returns:
HandlerRegistrationused to remove this handler
-
addDragCompleteHandler
Add acom.smartgwt.client.widgets.DragCompleteHandler. See that class's documentation for a definition of "drag complete", and how it differs from "drop complete" (com.smartgwt.client.widgets.DropCompleteHandler).- Specified by:
addDragCompleteHandlerin interfaceHasDragCompleteHandlers- Parameters:
handler- the DropCompleteHandler- Returns:
HandlerRegistrationused to remove this handler
-
getFieldAlignments
Description copied from interface:DataBoundComponentReturna an array of field alignments for this grid- Specified by:
getFieldAlignmentsin interfaceDataBoundComponent- Returns:
- array of Alignments
-
getDeepCloneOnEdit
Description copied from interface:DataBoundComponentBefore we start editing values in this DataBoundComponent, should we perform a deep clone of the underlying values. SeeDataSource.getDeepCloneOnEdit()for details of what this means.If this value is not explicitly set, it defaults to the DataSource
deepCloneOnEditvalue. This value can also be overridden per-field withDataSourceField.setDeepCloneOnEdit(java.lang.Boolean).Like the other
deepCloneOnEditsettings, this flag only has an effect if you are editing a values object that contains nested objects or arrays, usingCanvas.setDataPath(java.lang.String)- Specified by:
getDeepCloneOnEditin interfaceDataBoundComponent
-
setDeepCloneOnEdit
Description copied from interface:DataBoundComponentBefore we start editing values in this DataBoundComponent, should we perform a deep clone of the underlying values. SeeDataSource.getDeepCloneOnEdit()for details of what this means.If this value is not explicitly set, it defaults to the DataSource
deepCloneOnEditvalue. This value can also be overridden per-field withDataSourceField.setDeepCloneOnEdit(java.lang.Boolean).Like the other
deepCloneOnEditsettings, this flag only has an effect if you are editing a values object that contains nested objects or arrays, usingCanvas.setDataPath(java.lang.String)- Specified by:
setDeepCloneOnEditin interfaceDataBoundComponent- Returns:
DataBoundComponentinstance, for chaining setter calls
-
setFields
Description copied from interface:DataBoundComponentField setter variant (alternative tosetFields(FormItem...),setFields(ListGridField...), etc.) that will accept an array of JavaScriptObject, rather than an array of SmartGWT Java wrappers of the field class type (e.g.FormItem,ListGridField, etc.) This is an advanced method and only for cases where you have the JavaScriptObject for each field but want to avoid having to create each associated SmartGWT Java wrapper.Note: use
toArray()to create a Java array of JavaScriptObject if you only have the array itself as a single JavaScriptObject.- Specified by:
setFieldsin interfaceDataBoundComponent- Parameters:
fields- the component fields- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getFieldsAsJavaScriptObjects
Description copied from interface:DataBoundComponentReturn the fields as JavaScriptObjects rather than as SmartGWT Java wrappers of the field class type (e.g.FormItem,ListGridField, etc.) This avoids building the SmartGWT Java wrappers for the fields in situations where they aren't needed - and for FormItems in particular - where there may not be enough information to determine the correct subclass, such as before the SmartClient instance underlying theDynamicFormhas been created.- Specified by:
getFieldsAsJavaScriptObjectsin interfaceDataBoundComponent- Returns:
- the component fields
-
getFieldCount
public int getFieldCount()Description copied from interface:DataBoundComponentReturn the number of fields.- Specified by:
getFieldCountin interfaceDataBoundComponent- Returns:
- the number of fields
-
transferRecords
public void transferRecords(Record[] records, Record targetRecord, Integer index, Canvas sourceWidget, TransferRecordsCallback callback) Description copied from interface:DataBoundComponentTransfer a list ofRecords from another component (does not have to be a databound component) into this component. This method is only applicable to list-type components, such asListGridorcom.smartgwt.client.widgets.tile.TileGridTileGrid. Notably, it does not apply toTreeGrid; the equivalent for treeGrids istransferNodes.This method implements the automatic drag-copy and drag-move behaviors of components like
ListGrid, and calling it is equivalent to completing a drag and drop of thedropRecords(the default record drop behavior is simply to calltransferRecords(), passing in the dropped nodes)Note that this method is asynchronous - it may need to perform server turnarounds to prevent duplicates in the target component's data. If you wish to be notified when the transfer process has completed, you can either pass a non-null callback to this method or add a
DropCompleteHandlerto this component.See also
transferSelectedData()- Specified by:
transferRecordsin interfaceDataBoundComponent- Parameters:
records- Recordss to transfer to this componenttargetRecord- The target record (eg, of a drop interaction), for contextindex- Insert point relative to the target record for the transferred recordssourceWidget- The databound or non-databound component from which the records are to be transferred.callback- optional TransferRecordsCallback to be fired when the transfer process has completed (pass null if your code does not need to be called back). The callback will be passed the list of records actually transferred to this component
-
setDragDataCustomizer
During a drag-and-drop interaction, this method returns the set of records being dragged out of the component. In the default implementation, this is the list of currently selected records.This method is consulted by
willAcceptDrop().- Parameters:
DragDataCustomizer- customizer- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getSort
Description copied from interface:DataBoundComponentReturns the currentSortSpecifiersfor this component. Will return null if this component has never been sorted, or the underlying SmartClient widget does not exist.- Specified by:
getSortin interfaceDataBoundComponent- Returns:
- current sort specifiers for this component (null if unsorted or no SC widget)
-
setSort
Description copied from interface:DataBoundComponentSort the component on one or more fields.Pass in an array of
SortSpecifiers to have the component's data sorted by the fields in eachspecifier.propertyand in the directions specified. The component can be sorted by any combination of fields, including fields specified in the fields array andunused fields from the underlying dataSource, if there is one.If setSort() is called on a component which doesn't yet have a SmartClient widget, the widget will be created. If
autoFetchDatais set and aDataSourcehas been set, this will result in data being fetched.- Specified by:
setSortin interfaceDataBoundComponent- Parameters:
sortSpecifiers- Array ofSortSpecifierobjects
-
setLogicalStructure
Setter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility. -
getLogicalStructure
Getter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.- Specified by:
getLogicalStructurein interfaceLogicalStructure- Overrides:
getLogicalStructurein classCanvas
-
getDataAsRecordArray().