com.smartgwt.client.widgets.calendar
Class Calendar

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.smartgwt.client.widgets.BaseWidget
              extended by com.smartgwt.client.widgets.Canvas
                  extended by com.smartgwt.client.widgets.calendar.Calendar
All Implemented Interfaces:
HasHandlers, com.google.gwt.user.client.EventListener, HasDateChangedHandlers, HasDayBodyClickHandlers, HasDayHeaderClickHandlers, HasEventAddedHandlers, HasEventChangedHandlers, HasEventClickHandlers, HasEventMovedHandlers, HasEventRemoveClickHandlers, HasEventRemovedHandlers, HasEventResizedHandlers, DataBoundComponent, HasClickHandlers, HasDoubleClickHandlers, HasDragMoveHandlers, HasDragRepositionMoveHandlers, HasDragRepositionStartHandlers, HasDragRepositionStopHandlers, HasDragResizeMoveHandlers, HasDragResizeStartHandlers, HasDragResizeStopHandlers, HasDragStartHandlers, HasDragStopHandlers, HasDropHandlers, HasDropMoveHandlers, HasDropOutHandlers, HasDropOverHandlers, HasFocusChangedHandlers, HasHoverHandlers, HasHoverHiddenHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseStillDownHandlers, HasMouseUpHandlers, HasMouseWheelHandlers, HasResizedHandlers, HasRightMouseDownHandlers, HasScrolledHandlers, HasShowContextMenuHandlers

public class Calendar
extends Canvas
implements DataBoundComponent, HasDayBodyClickHandlers, HasDayHeaderClickHandlers, HasEventChangedHandlers, HasEventClickHandlers, HasEventRemoveClickHandlers, HasEventMovedHandlers, HasEventAddedHandlers, HasEventRemovedHandlers, HasEventResizedHandlers, HasDateChangedHandlers

The Calendar component provides several different ways for a user to view and edit a set of events. Note that the ISC_Calendar.js module must be loaded to make use of the Calendar class.

CalendarEvents

Events are represented as ordinary JavaScript Objects (see CalendarEvent). The Calendar expects to be able to read and write a basic set of properties on events: name, startDate, endDate, description, etc, which can be stored under configurable property names (see eg startDateField.

Much like a ListGrid manages it's ListGridRecords, the Calendar can either be passed a ordinary Array of CalendarEvents or can fetch data from a DataSource.

If the calendar is bound to a DataSource, event changes by user action or by calling methods will be saved to the DataSource.

Navigation

The calendar supports a weekView, dayView and monthView by default. The user can navigate using back and forward buttons or via an attached dateChooser.

Event Manipulation

Events can be created via clicking on the day, week or month views, or via the "Add Event" button. In the day and week views, the user may click and drag to create an event of a specific duration.

Creating an event via click or click and drag pops up the eventDialog, which provides a simple form for quick event entry (only one field, the description, is required by default).

A separate editor called the eventEditor provides an interface for editing all possible properties of an event, including custom properties. The EventEditor is used whenever a pre-existing event is being edited, and can also be invoked by the user wherever the simpler EventDialog appears.

Events can also be programmatically addEvent(java.util.Date, java.util.Date, java.lang.String, java.lang.String), removeEvent(com.smartgwt.client.widgets.calendar.CalendarEvent), or updateEvent(com.smartgwt.client.widgets.calendar.CalendarEvent, java.util.Date, java.util.Date, java.lang.String, java.lang.String).


Nested Class Summary
 
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled
 
Field Summary
 
Fields inherited from class com.smartgwt.client.widgets.BaseWidget
config, configOnly, id, isElementSet
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
Calendar()
           
Calendar(com.google.gwt.core.client.JavaScriptObject jsObj)
           
 
Method Summary
 HandlerRegistration addDateChangedHandler(DateChangedHandler handler)
          Add a dateChanged handler.
 HandlerRegistration addDayBodyClickHandler(DayBodyClickHandler handler)
          Add a dayBodyClick handler.
 HandlerRegistration addDayHeaderClickHandler(DayHeaderClickHandler handler)
          Add a dayHeaderClick handler.
 void addEvent(java.util.Date startDate, java.util.Date endDate, java.lang.String name, java.lang.String description)
          Create a new event in this calendar instance.
 void addEvent(java.util.Date startDate, java.util.Date endDate, java.lang.String name, java.lang.String description, java.util.Map otherFields)
          Create a new event in this calendar instance.
 HandlerRegistration addEventAddedHandler(EventAddedHandler handler)
          Add a eventAdded handler.
 HandlerRegistration addEventChangedHandler(EventChangedHandler handler)
          Add a eventChanged handler.
 HandlerRegistration addEventClickHandler(EventClickHandler handler)
          Add a eventClick handler.
 HandlerRegistration addEventMovedHandler(EventMovedHandler handler)
          Add a eventMoved handler.
 HandlerRegistration addEventRemoveClickHandler(EventRemoveClickHandler handler)
          Add a eventRemoveClick handler.
 HandlerRegistration addEventRemovedHandler(EventRemovedHandler handler)
          Add a eventRemoved handler.
 HandlerRegistration addEventResizedHandler(EventResizedHandler handler)
          Add a eventResized handler.
 void addFormulaField()
          Convenience method to display a com.smartgwt.client..FormulaBuilder to create a new Formula Field.
 void addSummaryField()
          Convenience method to display a com.smartgwt.client..SummaryBuilder to create a new Summary Field.
 java.lang.Boolean anySelected()
          Whether at least one item is selected
protected  com.google.gwt.core.client.JavaScriptObject create()
           
 void deselectAllRecords()
           Deselect all records
 void deselectRecord(int record)
          Deselect a Record passed in explicitly, or by index.
 void deselectRecord(Record record)
          Deselect a Record passed in explicitly, or by index.
 void deselectRecords(int[] records)
          Deselect a list of Records passed in explicitly, or by index.
 void deselectRecords(Record[] records)
          Deselect a list of Records passed in explicitly, or by index.
 void disableHilite(java.lang.String hiliteID)
          Disable a hilite
 void disableHiliting()
          Disable all hilites.
 void enableHilite(java.lang.String hiliteID)
          Enable / disable a hilites
 void enableHilite(java.lang.String hiliteID, boolean enable)
          Enable / disable a hilites
 void enableHiliting()
          Enable all hilites.
 void enableHiliting(boolean enable)
          Enable all hilites.
 void fetchData()
          Uses a "fetch" operation on the current DataSource to retrieve data that matches the provided criteria, and displays the matching data in this component.
 void fetchData(Criteria criteria)
          Uses a "fetch" operation on the current DataSource to retrieve data that matches the provided criteria, and displays the matching data in this component.
 void fetchData(Criteria criteria, DSCallback callback)
          Uses a "fetch" operation on the current DataSource to retrieve data that matches the provided criteria, and displays the matching data in this component.
 void fetchData(Criteria criteria, DSCallback callback, DSRequest requestProperties)
          Uses a "fetch" operation on the current DataSource to retrieve data that matches the provided criteria, and displays the matching data in this component.
 void filterData()
          Retrieves data that matches the provided criteria and displays the matching data in this component.
 void filterData(Criteria criteria)
          Retrieves data that matches the provided criteria and displays the matching data in this component.
 void filterData(Criteria criteria, DSCallback callback)
          Retrieves data that matches the provided criteria and displays the matching data in this component.
 void filterData(Criteria criteria, DSCallback callback, DSRequest requestProperties)
          Retrieves data that matches the provided criteria and displays the matching data in this component.
 int getActiveDay()
          Gets the day of the week (0-6) that the mouse is currently over.
 java.util.Date getActiveTime()
          Gets a date object representing the date over which the mouse is hovering for the current selected view.
 java.lang.Boolean getAddDropValues()
          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.
 java.lang.String getAddFormulaFieldText()
          Text for a menu item allowing users to add a formula field
 java.lang.String getAddOperation()
          Operation ID this component should use when performing add operations.
 java.lang.String getAddSummaryFieldText()
          Text for a menu item allowing users to add a formula field
 java.lang.Boolean getAutoFetchAsFilter()
          If DataBoundComponent.setAutoFetchData(Boolean) is true, this attribute determines whether the initial fetch operation should be performed via DataBoundComponent.fetchData() or DataBoundComponent.filterData()
 java.lang.Boolean getAutoFetchData()
          If true, when this component is first drawn, automatically call DataBoundComponent.fetchData() or DataBoundComponent.filterData() depending on DataBoundComponent.getAutoFetchAsFilter() .
 java.lang.String getBaseStyle()
          The base name for the CSS class applied to the grid cells of the day and week views of the calendar.
 java.lang.Boolean getCanAddFormulaFields()
          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 com.smartgwt.client..FormulaBuilder.
 java.lang.Boolean getCanAddSummaryFields()
          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 com.smartgwt.client..SummaryBuilder.
 java.lang.Boolean getCanCreateEvents()
          If true, users can create new events
 java.lang.Boolean getCanDeleteEvents()
          If true, users can delete existing events.
 java.lang.Boolean getCanEditEvents()
          If true, users can edit existing events
 java.lang.String getCanEditField()
          Name of the field on each CalendarEvent that determines editability.
 java.util.Date getChosenDate()
          The date for which events are displayed in the day, week, and month tabs of the calendar. Default is today.
 java.lang.String getCurrentViewName()
          Get the name of the visible view.
 CalendarEvent[] getData()
           
 int getDataPageSize()
          When using data paging, how many records to fetch at a time.
 DataSource getDataSource()
          The DataSource that this component should bind to for default fields and for performing DSRequest.
 java.lang.String getDayBodyBaseStyle()
          The base name for the CSS class applied to the day body of the month view of the calendar.
protected  java.lang.String getDayBodyHTML(java.util.Date date, CalendarEvent[] events, Calendar calendar, int rowNum, int colNum)
           
 java.lang.String getDayHeaderBaseStyle()
          The base name for the CSS class applied to the day headers of the month view. This style will have "Dark", "Over", "Selected", or "Disabled" appended to it according to the state of the cell.
 java.lang.String getDescriptionField()
          The name of the description field in a CalendarEvent.
 java.lang.Boolean getDisableWeekends()
          If set, weekend days appear in disabled style and events cannot be created on weekends. Which days are considered weekends is controlled by com.smartgwt.client..Date#weekendDays.
 Record[] getDragData()
           During a drag-and-drop interaction, this method returns the set of records being dragged out of the component.
 DragDataAction getDragDataAction()
          Indicates what to do with data dragged into another DataBoundComponent.
 java.lang.String getDragTrackerStyle()
          CSS Style to apply to the drag tracker when dragging occurs on this component.
 java.util.Map getDropValues()
          When an item is dropped on this component, and addDropValues is 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 SmartGWT will apply to the dropped object before updating it.
 java.lang.String getDuplicateDragMessage()
          Message to show when a user attempts to transfer duplicate records into this component, and preventDuplicates is enabled.
 java.lang.String getEditFormulaFieldText()
          Text for a menu item allowing users to edit a formula field
 java.lang.String getEditSummaryFieldText()
          Text for a menu item allowing users to edit the formatter for a field
 java.lang.String getEndDateField()
          The name of the end date field in a CalendarEvent.
 java.lang.Boolean getEventAutoArrange()
          If set to true, enables the auto-arrangement of events that share time in the calendar.
 java.lang.Boolean getEventOverlap()
          When eventAutoArrange is true, setting eventOverlap to true causes events that share timeslots to overlap each other by a percentage of their width, specified by eventOverlapPercent.
 java.lang.Boolean getEventOverlapIdenticalStartTimes()
          When set to true, events that start at the same time will not overlap each other to prevent events having their close button hidden
 int getEventOverlapPercent()
          The size of the overlap, presented as a percentage of the width of events sharing timeslots
 int getEventSnapGap()
          Determines how many minutes an event can be moved or resized by.
 java.lang.String getEventTypeField()
          The name of the field which will determine the row in which this event will be displayed for the timelineView
 java.lang.String getEventWindowStyle()
          The base name for the CSS class applied to event windows within calendars. This style will have "Header", "HeaderLabel", and "Body" appended to it, according to which part of the event window is being styled.
 java.lang.String getEventWindowStyleField()
          The name of the field used to override eventWindowStyle for an individual CalendarEvent.
 java.lang.Boolean getExportAll()
          Setting exportAll to true prevents the component from passing it's list of fields to the export call.
 java.lang.String[] getExportFields()
          The list of field-names to export.
 java.lang.String getFetchOperation()
          Operation ID this component should use when performing fetch operations.
 int getFirstDayOfWeek()
          The numeric day (0-6) which the calendar should consider as the first day of the week
 java.lang.String getHiliteProperty()
          Marker that can be set on a record to flag that record as hilited.
 Criteria getInitialCriteria()
          Criteria to use when DataBoundComponent.setAutoFetchData(Boolean) is used.
 java.lang.Boolean getInvalidDateMessage()
          The message to display in the eventEditor when the 'To' date is greater than the 'From' date and a save is attempted.
 java.lang.String getLeadingDateField()
          The name of the end date field in a CalendarEvent.
 java.lang.String getNameField()
          The name of the name field in a CalendarEvent.
static Calendar getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
           
 java.lang.String getOtherDayBlankStyle()
          In the month CSS style applied to both the header and body of days from other months when showOtherDays is false.
 java.lang.String getOtherDayBodyBaseStyle()
          The base name for the CSS class applied to the day body of the month view of the calendar.
 java.lang.String getOtherDayHeaderBaseStyle()
          The base name for the CSS class applied to the day headers of the month view. This style will have "Dark", "Over", "Selected", or "Disabled" appended to it according to the state of the cell.
 java.lang.Boolean getPreventDuplicates()
          If set, detect and prevent duplicate records from being transferred to this component, either via drag and drop or via DataBoundComponent.transferSelectedData(com.smartgwt.client.widgets.DataBoundComponent).
 int getRecordIndex(Record record)
          Get the index of the provided record.
 java.lang.String getRemoveOperation()
          Operation ID this component should use when performing remove operations.
 java.lang.Boolean getScrollToWorkday()
          If set, causes the workdayStart to be sized to fill the available space in the day view and week view, and automatically scrolls these views to the start of the workday when the calendar is first displayed and whenever the user switches to a new day or week.
 java.lang.String getSelectedCellStyle()
          The base name for the CSS class applied to a cell that is selected via a mouse drag.
 java.lang.Boolean getShowComplexFields()
          Whether to show fields of non-atomic types when a DataBoundComponent is given a DataSource but no component.fields.
 java.lang.Boolean getShowDateChooser()
          Determines whether the dateChooser is displayed.
 java.lang.Boolean getShowDayHeaders()
          If false, the month view does not show day headers
 java.lang.Boolean getShowDetailFields()
          Whether to show fields marked detail:true when a DataBoundComponent is given a DataSource but no component.fields.
 java.lang.Boolean getShowHiddenFields()
          Whether to show fields marked hidden:true when a DataBoundComponent is given a DataSource but no component.fields.
 java.lang.Boolean getShowOtherDays()
          If set to true, in the month view, days that fall in an adjacent month are still shown with a header and body area, and are interactive.
 java.lang.Boolean getShowQuickEventDialog()
          Determines whether the quick event dialog is displayed when a time is clicked.
 java.lang.Boolean getShowTimelineView()
          if set to true, show the Timeline view.
 java.lang.Boolean getShowWeekends()
          Suppresses the display of weekend days in the week and month views, and disallows the creation of events on weekends.
 java.lang.Boolean getShowWorkday()
          If set, causes the calendar to use workdayBaseStyle for cells falling within the workday as defined by workdayStart and workdayEnd, in both the weekView and dayView.
 java.lang.String getStartDateField()
          The name of the start date field in a CalendarEvent.
 java.lang.String getTitleField()
          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 check titleField for databound compounds.
For non databound components returns the first defined field name of "title", "name", or "id".
 java.lang.String getTitleFieldValue(Record record)
          Get the value of the titleField for the passed record
 java.lang.String getTrailingDateField()
          The name of the end date field in a CalendarEvent.
 java.lang.String getUpdateOperation()
          Operation ID this component should use when performing update operations.
 java.lang.Boolean getUseAllDataSourceFields()
          If true, the set of fields given by the "default binding" (see 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.
 java.lang.Boolean getUseFlatFields()
          The useFlatFields flag causes all simple type fields anywhere in a nested set of DataSources to be exposed as a flat list for form binding.
 java.lang.Boolean getWeekEventBorderOverlap()
          Augments the width of week event windows slightly to avoid duplicate adjacent borders between events.
 java.lang.String getWorkdayBaseStyle()
          If showWorkday is set, style used for cells that are within the workday, as defined by workdayStart and workdayEnd.
 java.lang.String getWorkdayEnd()
          When using showWorkday:true, workdayStart and workdayEnd specify the time of day when the workday starts and ends, specified as a String acceptable to com.smartgwt.client..Time#parseInput.
 java.lang.String getWorkdayStart()
          When using showWorkday:true, workdayStart and workdayEnd specify the time of day when the workday starts and ends, specified as a String acceptable to com.smartgwt.client..Time#parseInput.
 void invalidateCache()
          Invalidate the current data cache for this databound component via a call to this.data.invalidateCache().
 void next()
          Move to the next day, week, or month, depending on which tab is selected.
protected  void onInit()
           
 void previous()
          Move to the previous day, week, or month, depending on which tab is selected.
 void removeEvent(CalendarEvent event)
          Remove an event from this calendar.
 void selectAllRecords()
          Select all records
 void selectRecord(int record)
          Select/deselect a Record passed in explicitly, or by index.
 void selectRecord(int record, boolean newState)
          Select/deselect a Record passed in explicitly, or by index.
 void selectRecord(Record record)
          Select/deselect a Record passed in explicitly, or by index.
 void selectRecord(Record record, boolean newState)
          Select/deselect a Record passed in explicitly, or by index.
 void selectRecords(int[] records)
          Select/deselect a list of Records passed in explicitly, or by index.
 void selectRecords(int[] records, boolean newState)
          Select/deselect a list of Records passed in explicitly, or by index.
 void selectRecords(Record[] records)
          Select/deselect a list of Records passed in explicitly, or by index.
 void selectRecords(Record[] records, boolean newState)
          Select/deselect a list of Records passed in explicitly, or by index.
 void setAddDropValues(java.lang.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.
 void setAddFormulaFieldText(java.lang.String addFormulaFieldText)
          Text for a menu item allowing users to add a formula field
 void setAddOperation(java.lang.String addOperation)
          Operation ID this component should use when performing add operations.
 void setAddSummaryFieldText(java.lang.String addSummaryFieldText)
          Text for a menu item allowing users to add a formula field
 void setAutoFetchAsFilter(java.lang.Boolean autoFetchAsFilter)
          If DataBoundComponent.setAutoFetchData(Boolean) is true, this attribute determines whether the initial fetch operation should be performed via DataBoundComponent.fetchData() or DataBoundComponent.filterData()
 void setAutoFetchData(java.lang.Boolean autoFetchData)
          If true, when this component is first drawn, automatically call DataBoundComponent.fetchData() or DataBoundComponent.filterData() depending on DataBoundComponent.getAutoFetchAsFilter() .
 void setBaseStyle(java.lang.String baseStyle)
          The base name for the CSS class applied to the grid cells of the day and week views of the calendar.
 void setCanAddFormulaFields(java.lang.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 com.smartgwt.client..FormulaBuilder.
 void setCanAddSummaryFields(java.lang.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 com.smartgwt.client..SummaryBuilder.
 void setCanCreateEvents(java.lang.Boolean canCreateEvents)
          If true, users can create new events
 void setCanDeleteEvents(java.lang.Boolean canDeleteEvents)
          If true, users can delete existing events.
 void setCanEditEvents(java.lang.Boolean canEditEvents)
          If true, users can edit existing events
 void setCanEditField(java.lang.String canEditField)
          Name of the field on each CalendarEvent that determines editability.
 void setChosenDate(java.util.Date chosenDate)
          The date for which events are displayed in the day, week, and month tabs of the calendar. Default is today.
 void setData(CalendarEvent[] data)
          A List of CalendarEvent objects, specifying the data to be used to populate the calendar.
 void setData(Record[] data)
          An array of Record objects, specifying the data to be used to populate the DataBoundComponent.
 void setDataPageSize(int dataPageSize)
          When using data paging, how many records to fetch at a time.
 void setDataSource(DataSource dataSource)
          The DataSource that this component should bind to for default fields and for performing DSRequest.
 void setDayBodyBaseStyle(java.lang.String dayBodyBaseStyle)
          The base name for the CSS class applied to the day body of the month view of the calendar.
 void setDayHeaderBaseStyle(java.lang.String dayHeaderBaseStyle)
          The base name for the CSS class applied to the day headers of the month view. This style will have "Dark", "Over", "Selected", or "Disabled" appended to it according to the state of the cell.
 void setDescriptionField(java.lang.String descriptionField)
          The name of the description field in a CalendarEvent.
 void setDisableWeekends(java.lang.Boolean disableWeekends)
          If set, weekend days appear in disabled style and events cannot be created on weekends. Which days are considered weekends is controlled by com.smartgwt.client..Date#weekendDays.
 void setDragDataAction(DragDataAction dragDataAction)
          Indicates what to do with data dragged into another DataBoundComponent.
 void setDragTrackerStyle(java.lang.String dragTrackerStyle)
          CSS Style to apply to the drag tracker when dragging occurs on this component.
 void setDropValues(java.util.Map dropValues)
          When an item is dropped on this component, and addDropValues is 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 SmartGWT will apply to the dropped object before updating it.
 void setDuplicateDragMessage(java.lang.String duplicateDragMessage)
          Message to show when a user attempts to transfer duplicate records into this component, and preventDuplicates is enabled.
 void setEditFormulaFieldText(java.lang.String editFormulaFieldText)
          Text for a menu item allowing users to edit a formula field
 void setEditSummaryFieldText(java.lang.String editSummaryFieldText)
          Text for a menu item allowing users to edit the formatter for a field
 void setEndDateField(java.lang.String endDateField)
          The name of the end date field in a CalendarEvent.
 void setEventAutoArrange(java.lang.Boolean eventAutoArrange)
          If set to true, enables the auto-arrangement of events that share time in the calendar.
 void setEventDialogFields(FormItem... eventDialogFields)
          The set of fields for the eventDialog.
 void setEventEditorFields(FormItem... eventEditorFields)
          The set of fields for the eventEditor.
 void setEventOverlap(java.lang.Boolean eventOverlap)
          When eventAutoArrange is true, setting eventOverlap to true causes events that share timeslots to overlap each other by a percentage of their width, specified by eventOverlapPercent.
 void setEventOverlapIdenticalStartTimes(java.lang.Boolean eventOverlapIdenticalStartTimes)
          When set to true, events that start at the same time will not overlap each other to prevent events having their close button hidden
 void setEventOverlapPercent(int eventOverlapPercent)
          The size of the overlap, presented as a percentage of the width of events sharing timeslots
 void setEventSnapGap(int eventSnapGap)
          Determines how many minutes an event can be moved or resized by.
 void setEventTypeField(java.lang.String eventTypeField)
          The name of the field which will determine the row in which this event will be displayed for the timelineView
 void setEventWindowStyle(java.lang.String eventWindowStyle)
          The base name for the CSS class applied to event windows within calendars. This style will have "Header", "HeaderLabel", and "Body" appended to it, according to which part of the event window is being styled.
 void setEventWindowStyleField(java.lang.String eventWindowStyleField)
          The name of the field used to override eventWindowStyle for an individual CalendarEvent.
 void setExportAll(java.lang.Boolean exportAll)
          Setting exportAll to true prevents the component from passing it's list of fields to the export call.
 void setExportFields(java.lang.String[] exportFields)
          The list of field-names to export.
 void setFetchOperation(java.lang.String fetchOperation)
          Operation ID this component should use when performing fetch operations.
 void setFirstDayOfWeek(int firstDayOfWeek)
          The numeric day (0-6) which the calendar should consider as the first day of the week
 void setHiliteProperty(java.lang.String hiliteProperty)
          Marker that can be set on a record to flag that record as hilited.
 void setInitialCriteria(Criteria initialCriteria)
          Criteria to use when DataBoundComponent.setAutoFetchData(Boolean) is used.
 void setInvalidDateMessage(java.lang.Boolean invalidDateMessage)
          The message to display in the eventEditor when the 'To' date is greater than the 'From' date and a save is attempted.
 void setLeadingDateField(java.lang.String leadingDateField)
          The name of the end date field in a CalendarEvent.
 void setNameField(java.lang.String nameField)
          The name of the name field in a CalendarEvent.
 void setOtherDayBlankStyle(java.lang.String otherDayBlankStyle)
          In the month CSS style applied to both the header and body of days from other months when showOtherDays is false.
 void setOtherDayBodyBaseStyle(java.lang.String otherDayBodyBaseStyle)
          The base name for the CSS class applied to the day body of the month view of the calendar.
 void setOtherDayHeaderBaseStyle(java.lang.String otherDayHeaderBaseStyle)
          The base name for the CSS class applied to the day headers of the month view. This style will have "Dark", "Over", "Selected", or "Disabled" appended to it according to the state of the cell.
 void setPreventDuplicates(java.lang.Boolean preventDuplicates)
          If set, detect and prevent duplicate records from being transferred to this component, either via drag and drop or via DataBoundComponent.transferSelectedData(com.smartgwt.client.widgets.DataBoundComponent).
 void setRemoveOperation(java.lang.String removeOperation)
          Operation ID this component should use when performing remove operations.
 void setScrollToWorkday(java.lang.Boolean scrollToWorkday)
          If set, causes the workdayStart to be sized to fill the available space in the day view and week view, and automatically scrolls these views to the start of the workday when the calendar is first displayed and whenever the user switches to a new day or week.
 void setSelectedCellStyle(java.lang.String selectedCellStyle)
          The base name for the CSS class applied to a cell that is selected via a mouse drag.
 void setShowAddEventButton(java.lang.Boolean showAddEventButton)
           
 void setShowComplexFields(java.lang.Boolean showComplexFields)
          Whether to show fields of non-atomic types when a DataBoundComponent is given a DataSource but no component.fields.
 void setShowDateChooser(java.lang.Boolean showDateChooser)
          Determines whether the dateChooser is displayed.
 void setShowDatePickerButton(java.lang.Boolean showDatePickerButton)
           
 void setShowDayHeaders(java.lang.Boolean showDayHeaders)
          If false, the month view does not show day headers
 void setShowDayView(java.lang.Boolean showDayView)
           
 void setShowDetailFields(java.lang.Boolean showDetailFields)
          Whether to show fields marked detail:true when a DataBoundComponent is given a DataSource but no component.fields.
 void setShowHiddenFields(java.lang.Boolean showHiddenFields)
          Whether to show fields marked hidden:true when a DataBoundComponent is given a DataSource but no component.fields.
 void setShowMonthView(java.lang.Boolean showMonthView)
           
 void setShowOtherDays(java.lang.Boolean showOtherDays)
          If set to true, in the month view, days that fall in an adjacent month are still shown with a header and body area, and are interactive.
 void setShowQuickEventDialog(java.lang.Boolean showQuickEventDialog)
          Determines whether the quick event dialog is displayed when a time is clicked.
 void setShowTimelineView(java.lang.Boolean showTimelineView)
          if set to true, show the Timeline view.
 void setShowWeekends(java.lang.Boolean showWeekends)
          Suppresses the display of weekend days in the week and month views, and disallows the creation of events on weekends.
 void setShowWeekView(java.lang.Boolean showWeekView)
           
 void setShowWorkday(java.lang.Boolean showWorkday)
          If set, causes the calendar to use workdayBaseStyle for cells falling within the workday as defined by workdayStart and workdayEnd, in both the weekView and dayView.
 void setStartDateField(java.lang.String startDateField)
          The name of the start date field in a CalendarEvent.
 void setTitleField(java.lang.String titleField)
           
 void setTrailingDateField(java.lang.String trailingDateField)
          The name of the end date field in a CalendarEvent.
 void setUpdateOperation(java.lang.String updateOperation)
          Operation ID this component should use when performing update operations.
 void setUseAllDataSourceFields(java.lang.Boolean useAllDataSourceFields)
          If true, the set of fields given by the "default binding" (see 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.
 void setUseFlatFields(java.lang.Boolean useFlatFields)
          The useFlatFields flag causes all simple type fields anywhere in a nested set of DataSources to be exposed as a flat list for form binding.
 void setWeekEventBorderOverlap(java.lang.Boolean weekEventBorderOverlap)
          Augments the width of week event windows slightly to avoid duplicate adjacent borders between events.
 void setWorkdayBaseStyle(java.lang.String workdayBaseStyle)
          If showWorkday is set, style used for cells that are within the workday, as defined by workdayStart and workdayEnd.
 void setWorkdayEnd(java.lang.String workdayEnd)
          When using showWorkday:true, workdayStart and workdayEnd specify the time of day when the workday starts and ends, specified as a String acceptable to com.smartgwt.client..Time#parseInput.
 void setWorkdayStart(java.lang.String workdayStart)
          When using showWorkday:true, workdayStart and workdayEnd specify the time of day when the workday starts and ends, specified as a String acceptable to com.smartgwt.client..Time#parseInput.
 void transferSelectedData(DataBoundComponent source)
          Simulates a drag / drop type transfer of the selected records in some other component to this component, without requiring any user interaction.
 void transferSelectedData(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.
 void updateEvent(CalendarEvent event, java.util.Date startDate, java.util.Date endDate, java.lang.String name, java.lang.String description)
          update an event in this calendar.
 
Methods inherited from class com.smartgwt.client.widgets.Canvas
addChild, addChild, addChild, 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, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addScrolledHandler, addShowContextMenuHandler, addStyleName, adjustForContent, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, blur, bringToFront, clear, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsFocus, containsPoint, containsPoint, convertToCanvasArray, disable, enable, focus, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowTime, getAnimateTime, getAppImgDir, getAutoShowParent, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getCanAcceptDrop, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getChildren, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getContents, getContextMenu, getCursor, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragOpacity, getDragRepositionCursor, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getExtraSpace, getGroupTitle, getHeight, getHeightAsString, getHoverAlign, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlPosition, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getLeft, getMargin, getMatchElement, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOverflow, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getParentElement, getPercentBox, getPosition, getPrefix, getPrompt, getRect, getRedrawOnResize, getResizeBarTarget, getRight, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowDepth, getShadowImage, getShadowOffset, getShadowSoftness, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowResizeBar, getShowShadow, getSkinImgDir, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapResizeToGrid, getSnapTo, getSnapToGrid, getSnapVDirection, getSnapVGap, getStyleName, getTabIndex, getTitle, getTooltip, getTop, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isDrawn, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, parentResized, redraw, redraw, removeChild, removeChild, resizeBy, resizeBy, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAlign, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowTime, setAnimateTime, setAppImgDir, setAutoHeight, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setContents, setContextMenu, setCursor, setDefaultHeight, setDefaultWidth, setDisabled, setDisabledCursor, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragOpacity, setDragRepositionCursor, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setExtraSpace, setGroupTitle, setHeight, setHeight, setHeight100, setHoverAlign, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlPosition, setImage, setImage, setIsGroup, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeft, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNoDoubleClicks, setOpacity, setOverflow, setPadding, setPageLeft, setPageTop, setParentElement, setPercentBox, setPosition, setPrefix, setPrompt, setRect, setRect, setRedrawOnResize, setResizeBarTarget, setResizeFrom, setRight, setScrollbarSize, setShadowDepth, setShadowImage, setShadowOffset, setShadowSoftness, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowResizeBar, setShowShadow, setSkinImgDir, setSmoothFade, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToGrid, setSnapTo, setSnapToGrid, setSnapVDirection, setSnapVGap, setStyleName, setTabIndex, setTitle, setTooltip, setTop, setVisibility, setVisible, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showNextTo, showNextTo, showPrintPreview, updateHover, updateHover, updateShadow, visibleAtPoint, visibleAtPoint, willAcceptDrop
 
Methods inherited from class com.smartgwt.client.widgets.BaseWidget
addDrawHandler, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getElement, getElement, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, hashCode, isConfigOnly, isCreated, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDragTracker, setElement, setHtmlElement, setID, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, toString
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
doAttachChildren, doDetachChildren, getParent, isAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setPixelSize, setSize, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkEvents, unsinkEvents
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.smartgwt.client.widgets.DataBoundComponent
getOrCreateJsObj
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 

Constructor Detail

Calendar

public Calendar()

Calendar

public Calendar(com.google.gwt.core.client.JavaScriptObject jsObj)
Method Detail

getOrCreateRef

public static Calendar getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)

create

protected com.google.gwt.core.client.JavaScriptObject create()
Overrides:
create in class Canvas

setChosenDate

public void setChosenDate(java.util.Date chosenDate)
                   throws java.lang.IllegalStateException
The date for which events are displayed in the day, week, and month tabs of the calendar. Default is today. Set the current date for which the calendar will display events.

Parameters:
chosenDate - the new date to set as the current date. Default value is 'Today'
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getChosenDate

public java.util.Date getChosenDate()
The date for which events are displayed in the day, week, and month tabs of the calendar. Default is today.

Returns:
java.util.Date

setFirstDayOfWeek

public void setFirstDayOfWeek(int firstDayOfWeek)
The numeric day (0-6) which the calendar should consider as the first day of the week

Parameters:
firstDayOfWeek - firstDayOfWeek Default value is 0

getFirstDayOfWeek

public int getFirstDayOfWeek()
The numeric day (0-6) which the calendar should consider as the first day of the week

Returns:
int

setBaseStyle

public void setBaseStyle(java.lang.String baseStyle)
The base name for the CSS class applied to the grid cells of the day and week views of the calendar. This style will have "Dark", "Over", "Selected", or "Disabled" appended to it according to the state of the cell.

Parameters:
baseStyle - baseStyle Default value is "calendar"

getBaseStyle

public java.lang.String getBaseStyle()
The base name for the CSS class applied to the grid cells of the day and week views of the calendar. This style will have "Dark", "Over", "Selected", or "Disabled" appended to it according to the state of the cell.

Returns:
String

setDayHeaderBaseStyle

public void setDayHeaderBaseStyle(java.lang.String dayHeaderBaseStyle)
The base name for the CSS class applied to the day headers of the month view. This style will have "Dark", "Over", "Selected", or "Disabled" appended to it according to the state of the cell.

Parameters:
dayHeaderBaseStyle - dayHeaderBaseStyle Default value is "calMonthDayHeader"

getDayHeaderBaseStyle

public java.lang.String getDayHeaderBaseStyle()
The base name for the CSS class applied to the day headers of the month view. This style will have "Dark", "Over", "Selected", or "Disabled" appended to it according to the state of the cell.

Returns:
String

setDayBodyBaseStyle

public void setDayBodyBaseStyle(java.lang.String dayBodyBaseStyle)
The base name for the CSS class applied to the day body of the month view of the calendar. This style will have "Dark", "Over", "Selected", or "Disabled" appended to it according to the state of the cell.

Parameters:
dayBodyBaseStyle - dayBodyBaseStyle Default value is "calMonthDayBody"

getDayBodyBaseStyle

public java.lang.String getDayBodyBaseStyle()
The base name for the CSS class applied to the day body of the month view of the calendar. This style will have "Dark", "Over", "Selected", or "Disabled" appended to it according to the state of the cell.

Returns:
String

setOtherDayHeaderBaseStyle

public void setOtherDayHeaderBaseStyle(java.lang.String otherDayHeaderBaseStyle)
The base name for the CSS class applied to the day headers of the month view. This style will have "Dark", "Over", "Selected", or "Disabled" appended to it according to the state of the cell.

Parameters:
otherDayHeaderBaseStyle - otherDayHeaderBaseStyle Default value is "calMonthDayHeader"

getOtherDayHeaderBaseStyle

public java.lang.String getOtherDayHeaderBaseStyle()
The base name for the CSS class applied to the day headers of the month view. This style will have "Dark", "Over", "Selected", or "Disabled" appended to it according to the state of the cell.

Returns:
String

setOtherDayBodyBaseStyle

public void setOtherDayBodyBaseStyle(java.lang.String otherDayBodyBaseStyle)
The base name for the CSS class applied to the day body of the month view of the calendar. This style will have "Dark", "Over", "Selected", or "Disabled" appended to it according to the state of the cell.

Parameters:
otherDayBodyBaseStyle - otherDayBodyBaseStyle Default value is "calMonthDayBody"

getOtherDayBodyBaseStyle

public java.lang.String getOtherDayBodyBaseStyle()
The base name for the CSS class applied to the day body of the month view of the calendar. This style will have "Dark", "Over", "Selected", or "Disabled" appended to it according to the state of the cell.

Returns:
String

setOtherDayBlankStyle

public void setOtherDayBlankStyle(java.lang.String otherDayBlankStyle)
                           throws java.lang.IllegalStateException
In the month CSS style applied to both the header and body of days from other months when showOtherDays is false.

Parameters:
otherDayBlankStyle - otherDayBlankStyle Default value is "calMonthOtherDayBlank"
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getOtherDayBlankStyle

public java.lang.String getOtherDayBlankStyle()
In the month CSS style applied to both the header and body of days from other months when showOtherDays is false.

Returns:
String

setSelectedCellStyle

public void setSelectedCellStyle(java.lang.String selectedCellStyle)
The base name for the CSS class applied to a cell that is selected via a mouse drag.

Parameters:
selectedCellStyle - selectedCellStyle Default value is "calendarCellSelected"

getSelectedCellStyle

public java.lang.String getSelectedCellStyle()
The base name for the CSS class applied to a cell that is selected via a mouse drag.

Returns:
String

setEventWindowStyle

public void setEventWindowStyle(java.lang.String eventWindowStyle)
The base name for the CSS class applied to event windows within calendars. This style will have "Header", "HeaderLabel", and "Body" appended to it, according to which part of the event window is being styled. For example, to style the header, define a css class called 'eventWindowHeader'.

Parameters:
eventWindowStyle - eventWindowStyle Default value is "eventWindow"

getEventWindowStyle

public java.lang.String getEventWindowStyle()
The base name for the CSS class applied to event windows within calendars. This style will have "Header", "HeaderLabel", and "Body" appended to it, according to which part of the event window is being styled. For example, to style the header, define a css class called 'eventWindowHeader'.

Returns:
String

setWorkdayBaseStyle

public void setWorkdayBaseStyle(java.lang.String workdayBaseStyle)
                         throws java.lang.IllegalStateException
If showWorkday is set, style used for cells that are within the workday, as defined by workdayStart and workdayEnd.

Parameters:
workdayBaseStyle - workdayBaseStyle Default value is "calendarWorkday"
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getWorkdayBaseStyle

public java.lang.String getWorkdayBaseStyle()
If showWorkday is set, style used for cells that are within the workday, as defined by workdayStart and workdayEnd.

Returns:
String

setWorkdayStart

public void setWorkdayStart(java.lang.String workdayStart)
                     throws java.lang.IllegalStateException
When using showWorkday:true, workdayStart and workdayEnd specify the time of day when the workday starts and ends, specified as a String acceptable to com.smartgwt.client..Time#parseInput.

Both start and end time must fall on a 30 minute increment (eg 9:30, but not 9:45).

Parameters:
workdayStart - workdayStart Default value is "9:00am"
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getWorkdayStart

public java.lang.String getWorkdayStart()
When using showWorkday:true, workdayStart and workdayEnd specify the time of day when the workday starts and ends, specified as a String acceptable to com.smartgwt.client..Time#parseInput.

Both start and end time must fall on a 30 minute increment (eg 9:30, but not 9:45).

Returns:
String

setWorkdayEnd

public void setWorkdayEnd(java.lang.String workdayEnd)
                   throws java.lang.IllegalStateException
When using showWorkday:true, workdayStart and workdayEnd specify the time of day when the workday starts and ends, specified as a String acceptable to com.smartgwt.client..Time#parseInput.

Both start and end time must fall on a 30 minute increment (eg 9:30, but not 9:45).

Parameters:
workdayEnd - workdayEnd Default value is "5:00pm"
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getWorkdayEnd

public java.lang.String getWorkdayEnd()
When using showWorkday:true, workdayStart and workdayEnd specify the time of day when the workday starts and ends, specified as a String acceptable to com.smartgwt.client..Time#parseInput.

Both start and end time must fall on a 30 minute increment (eg 9:30, but not 9:45).

Returns:
String

setShowWorkday

public void setShowWorkday(java.lang.Boolean showWorkday)
                    throws java.lang.IllegalStateException
If set, causes the calendar to use workdayBaseStyle for cells falling within the workday as defined by workdayStart and workdayEnd, in both the weekView and dayView.

Parameters:
showWorkday - showWorkday Default value is false
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getShowWorkday

public java.lang.Boolean getShowWorkday()
If set, causes the calendar to use workdayBaseStyle for cells falling within the workday as defined by workdayStart and workdayEnd, in both the weekView and dayView.

Returns:
Boolean

setScrollToWorkday

public void setScrollToWorkday(java.lang.Boolean scrollToWorkday)
                        throws java.lang.IllegalStateException
If set, causes the workdayStart to be sized to fill the available space in the day view and week view, and automatically scrolls these views to the start of the workday when the calendar is first displayed and whenever the user switches to a new day or week.

Parameters:
scrollToWorkday - scrollToWorkday Default value is false
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getScrollToWorkday

public java.lang.Boolean getScrollToWorkday()
If set, causes the workdayStart to be sized to fill the available space in the day view and week view, and automatically scrolls these views to the start of the workday when the calendar is first displayed and whenever the user switches to a new day or week.

Returns:
Boolean

setNameField

public void setNameField(java.lang.String nameField)
                  throws java.lang.IllegalStateException
The name of the name field in a CalendarEvent.

Parameters:
nameField - nameField Default value is "name"
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getNameField

public java.lang.String getNameField()
The name of the name field in a CalendarEvent.

Returns:
String

setDescriptionField

public void setDescriptionField(java.lang.String descriptionField)
                         throws java.lang.IllegalStateException
The name of the description field in a CalendarEvent.

Parameters:
descriptionField - descriptionField Default value is "description"
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getDescriptionField

public java.lang.String getDescriptionField()
The name of the description field in a CalendarEvent.

Returns:
String

setStartDateField

public void setStartDateField(java.lang.String startDateField)
                       throws java.lang.IllegalStateException
The name of the start date field in a CalendarEvent.

Parameters:
startDateField - startDateField Default value is "startDate"
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getStartDateField

public java.lang.String getStartDateField()
The name of the start date field in a CalendarEvent.

Returns:
String

setEndDateField

public void setEndDateField(java.lang.String endDateField)
                     throws java.lang.IllegalStateException
The name of the end date field in a CalendarEvent.

Parameters:
endDateField - endDateField Default value is "endDate"
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getEndDateField

public java.lang.String getEndDateField()
The name of the end date field in a CalendarEvent.

Returns:
String

setLeadingDateField

public void setLeadingDateField(java.lang.String leadingDateField)
                         throws java.lang.IllegalStateException
The name of the end date field in a CalendarEvent.

Parameters:
leadingDateField - leadingDateField Default value is "leadingDate"
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getLeadingDateField

public java.lang.String getLeadingDateField()
The name of the end date field in a CalendarEvent.

Returns:
String

setTrailingDateField

public void setTrailingDateField(java.lang.String trailingDateField)
                          throws java.lang.IllegalStateException
The name of the end date field in a CalendarEvent.

Parameters:
trailingDateField - trailingDateField Default value is "trailingDate"
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getTrailingDateField

public java.lang.String getTrailingDateField()
The name of the end date field in a CalendarEvent.

Returns:
String

setEventTypeField

public void setEventTypeField(java.lang.String eventTypeField)
                       throws java.lang.IllegalStateException
The name of the field which will determine the row in which this event will be displayed for the timelineView

Parameters:
eventTypeField - eventTypeField Default value is "eventType"
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getEventTypeField

public java.lang.String getEventTypeField()
The name of the field which will determine the row in which this event will be displayed for the timelineView

Returns:
String

setEventWindowStyleField

public void setEventWindowStyleField(java.lang.String eventWindowStyleField)
                              throws java.lang.IllegalStateException
The name of the field used to override eventWindowStyle for an individual CalendarEvent. See eventWindowStyle.

Parameters:
eventWindowStyleField - eventWindowStyleField Default value is "eventWindowStyle"
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getEventWindowStyleField

public java.lang.String getEventWindowStyleField()
The name of the field used to override eventWindowStyle for an individual CalendarEvent. See eventWindowStyle.

Returns:
String

setCanEditField

public void setCanEditField(java.lang.String canEditField)
                     throws java.lang.IllegalStateException
Name of the field on each CalendarEvent that determines editability.

Parameters:
canEditField - canEditField Default value is "canEdit"
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getCanEditField

public java.lang.String getCanEditField()
Name of the field on each CalendarEvent that determines editability.

Returns:
String

setWeekEventBorderOverlap

public void setWeekEventBorderOverlap(java.lang.Boolean weekEventBorderOverlap)
                               throws java.lang.IllegalStateException
Augments the width of week event windows slightly to avoid duplicate adjacent borders between events.

Parameters:
weekEventBorderOverlap - weekEventBorderOverlap Default value is false
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getWeekEventBorderOverlap

public java.lang.Boolean getWeekEventBorderOverlap()
Augments the width of week event windows slightly to avoid duplicate adjacent borders between events.

Returns:
Boolean

setEventSnapGap

public void setEventSnapGap(int eventSnapGap)
                     throws java.lang.IllegalStateException
Determines how many minutes an event can be moved or resized by.

Parameters:
eventSnapGap - eventSnapGap Default value is 30
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getEventSnapGap

public int getEventSnapGap()
Determines how many minutes an event can be moved or resized by.

Returns:
int

setShowQuickEventDialog

public void setShowQuickEventDialog(java.lang.Boolean showQuickEventDialog)
                             throws java.lang.IllegalStateException
Determines whether the quick event dialog is displayed when a time is clicked. If this is false, the full event editor is displayed.

Parameters:
showQuickEventDialog - showQuickEventDialog Default value is true
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getShowQuickEventDialog

public java.lang.Boolean getShowQuickEventDialog()
Determines whether the quick event dialog is displayed when a time is clicked. If this is false, the full event editor is displayed.

Returns:
Boolean

setCanCreateEvents

public void setCanCreateEvents(java.lang.Boolean canCreateEvents)
                        throws java.lang.IllegalStateException
If true, users can create new events

Parameters:
canCreateEvents - canCreateEvents Default value is true
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getCanCreateEvents

public java.lang.Boolean getCanCreateEvents()
If true, users can create new events

Returns:
Boolean

setCanEditEvents

public void setCanEditEvents(java.lang.Boolean canEditEvents)
                      throws java.lang.IllegalStateException
If true, users can edit existing events

Parameters:
canEditEvents - canEditEvents Default value is true
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getCanEditEvents

public java.lang.Boolean getCanEditEvents()
If true, users can edit existing events

Returns:
Boolean

setCanDeleteEvents

public void setCanDeleteEvents(java.lang.Boolean canDeleteEvents)
                        throws java.lang.IllegalStateException
If true, users can delete existing events. Defaults to canEditEvents

Parameters:
canDeleteEvents - canDeleteEvents Default value is true
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getCanDeleteEvents

public java.lang.Boolean getCanDeleteEvents()
If true, users can delete existing events. Defaults to canEditEvents

Returns:
Boolean

setShowDateChooser

public void setShowDateChooser(java.lang.Boolean showDateChooser)
                        throws java.lang.IllegalStateException
Determines whether the dateChooser is displayed.

Parameters:
showDateChooser - showDateChooser Default value is true
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getShowDateChooser

public java.lang.Boolean getShowDateChooser()
Determines whether the dateChooser is displayed.

Returns:
Boolean

setDisableWeekends

public void setDisableWeekends(java.lang.Boolean disableWeekends)
                        throws java.lang.IllegalStateException
If set, weekend days appear in disabled style and events cannot be created on weekends. Which days are considered weekends is controlled by com.smartgwt.client..Date#weekendDays.

Parameters:
disableWeekends - disableWeekends Default value is true
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getDisableWeekends

public java.lang.Boolean getDisableWeekends()
If set, weekend days appear in disabled style and events cannot be created on weekends. Which days are considered weekends is controlled by com.smartgwt.client..Date#weekendDays.

Returns:
Boolean

setShowWeekends

public void setShowWeekends(java.lang.Boolean showWeekends)
                     throws java.lang.IllegalStateException
Suppresses the display of weekend days in the week and month views, and disallows the creation of events on weekends. Which days are considered weekends is controlled by com.smartgwt.client..Date#weekendDays. Setter for showWeekends to change this property at runtime.

Parameters:
showWeekends - showWeekends Default value is true
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getShowWeekends

public java.lang.Boolean getShowWeekends()
Suppresses the display of weekend days in the week and month views, and disallows the creation of events on weekends. Which days are considered weekends is controlled by com.smartgwt.client..Date#weekendDays.

Returns:
Boolean

setShowDayHeaders

public void setShowDayHeaders(java.lang.Boolean showDayHeaders)
                       throws java.lang.IllegalStateException
If false, the month view does not show day headers

Parameters:
showDayHeaders - showDayHeaders Default value is true
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getShowDayHeaders

public java.lang.Boolean getShowDayHeaders()
If false, the month view does not show day headers

Returns:
Boolean

setShowOtherDays

public void setShowOtherDays(java.lang.Boolean showOtherDays)
                      throws java.lang.IllegalStateException
If set to true, in the month view, days that fall in an adjacent month are still shown with a header and body area, and are interactive. Otherwise days from other months are rendered in the otherDayBlankStyle and are non-interactive.

Parameters:
showOtherDays - showOtherDays Default value is true
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getShowOtherDays

public java.lang.Boolean getShowOtherDays()
If set to true, in the month view, days that fall in an adjacent month are still shown with a header and body area, and are interactive. Otherwise days from other months are rendered in the otherDayBlankStyle and are non-interactive.

Returns:
Boolean

setInvalidDateMessage

public void setInvalidDateMessage(java.lang.Boolean invalidDateMessage)
                           throws java.lang.IllegalStateException
The message to display in the eventEditor when the 'To' date is greater than the 'From' date and a save is attempted.

Parameters:
invalidDateMessage - invalidDateMessage Default value is "From must be before To"
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getInvalidDateMessage

public java.lang.Boolean getInvalidDateMessage()
The message to display in the eventEditor when the 'To' date is greater than the 'From' date and a save is attempted.

Returns:
Boolean

setEventAutoArrange

public void setEventAutoArrange(java.lang.Boolean eventAutoArrange)
                         throws java.lang.IllegalStateException
If set to true, enables the auto-arrangement of events that share time in the calendar. The default is true.

Parameters:
eventAutoArrange - eventAutoArrange Default value is true
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getEventAutoArrange

public java.lang.Boolean getEventAutoArrange()
If set to true, enables the auto-arrangement of events that share time in the calendar. The default is true.

Returns:
Boolean

setEventOverlap

public void setEventOverlap(java.lang.Boolean eventOverlap)
                     throws java.lang.IllegalStateException
When eventAutoArrange is true, setting eventOverlap to true causes events that share timeslots to overlap each other by a percentage of their width, specified by eventOverlapPercent. The default is true.

Parameters:
eventOverlap - eventOverlap Default value is true
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getEventOverlap

public java.lang.Boolean getEventOverlap()
When eventAutoArrange is true, setting eventOverlap to true causes events that share timeslots to overlap each other by a percentage of their width, specified by eventOverlapPercent. The default is true.

Returns:
Boolean

setEventOverlapPercent

public void setEventOverlapPercent(int eventOverlapPercent)
                            throws java.lang.IllegalStateException
The size of the overlap, presented as a percentage of the width of events sharing timeslots

Parameters:
eventOverlapPercent - eventOverlapPercent Default value is 10
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getEventOverlapPercent

public int getEventOverlapPercent()
The size of the overlap, presented as a percentage of the width of events sharing timeslots

Returns:
int

setEventOverlapIdenticalStartTimes

public void setEventOverlapIdenticalStartTimes(java.lang.Boolean eventOverlapIdenticalStartTimes)
                                        throws java.lang.IllegalStateException
When set to true, events that start at the same time will not overlap each other to prevent events having their close button hidden

Parameters:
eventOverlapIdenticalStartTimes - eventOverlapIdenticalStartTimes Default value is false
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getEventOverlapIdenticalStartTimes

public java.lang.Boolean getEventOverlapIdenticalStartTimes()
When set to true, events that start at the same time will not overlap each other to prevent events having their close button hidden

Returns:
Boolean

setShowTimelineView

public void setShowTimelineView(java.lang.Boolean showTimelineView)
if set to true, show the Timeline view.

Parameters:
showTimelineView - showTimelineView Default value is false

getShowTimelineView

public java.lang.Boolean getShowTimelineView()
if set to true, show the Timeline view.

Returns:
Boolean

getCurrentViewName

public java.lang.String getCurrentViewName()
Get the name of the visible view. Either 'day', 'week', or 'month'.

Returns:
The name of the visible view.

next

public void next()
Move to the next day, week, or month, depending on which tab is selected.


previous

public void previous()
Move to the previous day, week, or month, depending on which tab is selected.


addDayBodyClickHandler

public HandlerRegistration addDayBodyClickHandler(DayBodyClickHandler handler)
Add a dayBodyClick handler.

Called when the body area of a day in the month view is clicked on, outside of any links to a particular event.

By default, if the user can add events, shows a dialog for adding a new event for that day. Return false to cancel this action.

Not called if the day falls outside the current month and showOtherDays is false.

Specified by:
addDayBodyClickHandler in interface HasDayBodyClickHandlers
Parameters:
handler - the dayBodyClick handler
Returns:
HandlerRegistration used to remove this handler

addDayHeaderClickHandler

public HandlerRegistration addDayHeaderClickHandler(DayHeaderClickHandler handler)
Add a dayHeaderClick handler.

Called when the header area of a day in the month view is clicked on.

By default, moves to the day tab and shows the clicked days events. Return false to cancel this action.

Not called if the day falls outside the current month and showOtherDays is false.

Specified by:
addDayHeaderClickHandler in interface HasDayHeaderClickHandlers
Parameters:
handler - the dayHeaderClick handler
Returns:
HandlerRegistration used to remove this handler

addEventChangedHandler

public HandlerRegistration addEventChangedHandler(EventChangedHandler handler)
Add a eventChanged handler.

Notification fired whenever a user changes an event, whether by dragging the event or by editing it in a dialog.

In a calendar with a DataSource, eventChanged() fires after the updated event has been successfully saved to the server

Specified by:
addEventChangedHandler in interface HasEventChangedHandlers
Parameters:
handler - the eventChanged handler
Returns:
HandlerRegistration used to remove this handler

addEventRemovedHandler

public HandlerRegistration addEventRemovedHandler(EventRemovedHandler handler)
Add a eventRemoved handler.

Notification fired whenever a user removes an event

In a calendar with a DataSource, eventRemoved() fires after the event has been successfully removed from the server

Specified by:
addEventRemovedHandler in interface HasEventRemovedHandlers
Parameters:
handler - the eventRemoved handler
Returns:
HandlerRegistration used to remove this handler

addEventAddedHandler

public HandlerRegistration addEventAddedHandler(EventAddedHandler handler)
Add a eventAdded handler.

Notification fired whenever a user adds an event.

In a calendar with a DataSource, eventAdded() fires after the event has been successfully added to the server

Specified by:
addEventAddedHandler in interface HasEventAddedHandlers
Parameters:
handler - the eventAdded handler
Returns:
HandlerRegistration used to remove this handler

addEventClickHandler

public HandlerRegistration addEventClickHandler(EventClickHandler handler)
Add a eventClick handler.

Called whenever an event is clicked on in the day, week or month views.

By default a dialog appears showing details for the event, and offering the ability to edit events which are editable. Return false to cancel the default action. This is a good place to, for example, show a completely customized event dialog instead of the default one.

Specified by:
addEventClickHandler in interface HasEventClickHandlers
Parameters:
handler - the eventClick handler
Returns:
HandlerRegistration used to remove this handler

addEventRemoveClickHandler

public HandlerRegistration addEventRemoveClickHandler(EventRemoveClickHandler handler)
Add a eventRemoveClick handler.

Called whenever the close icon of an event is clicked within the day or week view. Return false to cancel the removal, or true to allow it.

Implement this method to do something like, for example, showing a confirmation dialog before an event is removed.

Specified by:
addEventRemoveClickHandler in interface HasEventRemoveClickHandlers
Parameters:
handler - the eventRemoveClick handler
Returns:
HandlerRegistration used to remove this handler

addEventMovedHandler

public HandlerRegistration addEventMovedHandler(EventMovedHandler handler)
Add a eventMoved handler.

Called when an event is moved via dragging by a user. Return false to disallow the move.

Specified by:
addEventMovedHandler in interface HasEventMovedHandlers
Parameters:
handler - the eventMoved handler
Returns:
HandlerRegistration used to remove this handler

addEventResizedHandler

public HandlerRegistration addEventResizedHandler(EventResizedHandler handler)
Add a eventResized handler.

Called when an event is resized via dragging by a user. Return false to disallow the resize.

Specified by:
addEventResizedHandler in interface HasEventResizedHandlers
Parameters:
handler - the eventResized handler
Returns:
HandlerRegistration used to remove this handler

addDateChangedHandler

public HandlerRegistration addDateChangedHandler(DateChangedHandler handler)
Add a dateChanged handler.

Fires whenever the user changes the current date, including picking a specific date or navigating to a new week or month.

Specified by:
addDateChangedHandler in interface HasDateChangedHandlers
Parameters:
handler - the dateChanged handler
Returns:
HandlerRegistration used to remove this handler

getActiveDay

public int getActiveDay()
Gets the day of the week (0-6) that the mouse is currently over.

Returns:
the day that the mouse is currently over

getActiveTime

public java.util.Date getActiveTime()
Gets a date object representing the date over which the mouse is hovering for the current selected view. For month view, the time will be set to midnight of the active day. For dayview and week view, the time will be the rounded to the closest half hour relative to the mouse position.

Returns:
the date that the mouse is over

onInit

protected void onInit()
Overrides:
onInit in class BaseWidget

getDayBodyHTML

protected java.lang.String getDayBodyHTML(java.util.Date date,
                                          CalendarEvent[] events,
                                          Calendar calendar,
                                          int rowNum,
                                          int colNum)

setEventEditorFields

public void setEventEditorFields(FormItem... eventEditorFields)
                          throws java.lang.IllegalStateException
The set of fields for the eventEditor.

The default set of fields are:

    {name: "startHours", title: "From", type: "select", width: 60},
 {name: "startMinutes", showTitle: false, type: "select", width: 60},    {name: "startAMPM", showTitle: false,
 type: "select", width: 60},    {name: "invalidDate", type: "blurb", colSpan: 4, visible: false}    {name:
 "endHours", title: "To", type: "select", width: 60},    {name: "endMinutes", showTitle: false, type: "select",
 width: 60},    {name: "endAMPM", showTitle: false, type: "select", width: 60},    {name: "name", title: "Name",
 type: "text", colSpan: 4},    {name: "description", title: "Description", type: "textArea", colSpan: 4, height:
 50} 
See the Customized Binding example below for more information on altering default datasource fields within forms.

Parameters:
eventEditorFields - eventEditorFields Default value is see below
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

setEventDialogFields

public void setEventDialogFields(FormItem... eventDialogFields)
                          throws java.lang.IllegalStateException
The set of fields for the eventDialog.

The default set of fields are:

    {name: "name", title: "Event Name", type: nameType, width: 250 },
 {name: "save", title: "Save Event", type: "SubmitItem", endRow: false},    {name: "details", title: "Edit
 Details", type: "button", startRow: false} 
See the Customized Binding example below for more information on altering default datasource fields within forms.

Parameters:
eventDialogFields - eventDialogFields Default value is see below
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

setData

public void setData(CalendarEvent[] data)
A List of CalendarEvent objects, specifying the data to be used to populate the calendar.

This property will typically not be explicitly specified for databound Calendars, where the data is returned from the server via databound component methods such as fetchData(). In this case the data objects will be set to a com.smartgwt.client.data.ResultSet rather than a simple array. Initialize the data object with the given array. Observes methods of the data object so that when the data changes, the calendar will redraw automatically.

Parameters:
data - data to show in the list. Default value is null

setData

public void setData(Record[] data)
An array of Record objects, specifying the data to be used to populate the DataBoundComponent. Note that not all DataBoundComponents observe the changes to the data to redraw themselves. Refer to the version of setData that accepts component specific records.

Parameters:
data - array of Record objects.
See Also:
setData(CalendarEvent[])

addEvent

public void addEvent(java.util.Date startDate,
                     java.util.Date endDate,
                     java.lang.String name,
                     java.lang.String description)
Create a new event in this calendar instance.

Parameters:
startDate - start date of event
endDate - end date of event
name - name of event
description - description of event

addEvent

public void addEvent(java.util.Date startDate,
                     java.util.Date endDate,
                     java.lang.String name,
                     java.lang.String description,
                     java.util.Map otherFields)
Create a new event in this calendar instance.

Parameters:
startDate - start date of event
endDate - end date of event
name - name of event
description - description of event
otherFields - new values of additional fields to be updated

removeEvent

public void removeEvent(CalendarEvent event)
Remove an event from this calendar.

Parameters:
event - The event object to remove from the calendar

updateEvent

public void updateEvent(CalendarEvent event,
                        java.util.Date startDate,
                        java.util.Date endDate,
                        java.lang.String name,
                        java.lang.String description)
update an event in this calendar.

Parameters:
event - The event object to remove from the calendar
startDate - start date of event
endDate - end date of event
name - name of event
description - description of event

setShowDayView

public void setShowDayView(java.lang.Boolean showDayView)
                    throws java.lang.IllegalStateException
Throws:
java.lang.IllegalStateException

setShowWeekView

public void setShowWeekView(java.lang.Boolean showWeekView)
                     throws java.lang.IllegalStateException
Throws:
java.lang.IllegalStateException

setShowMonthView

public void setShowMonthView(java.lang.Boolean showMonthView)
                      throws java.lang.IllegalStateException
Throws:
java.lang.IllegalStateException

setShowDatePickerButton

public void setShowDatePickerButton(java.lang.Boolean showDatePickerButton)
                             throws java.lang.IllegalStateException
Throws:
java.lang.IllegalStateException

setShowAddEventButton

public void setShowAddEventButton(java.lang.Boolean showAddEventButton)
                           throws java.lang.IllegalStateException
Throws:
java.lang.IllegalStateException

getData

public CalendarEvent[] getData()

setDataPageSize

public void setDataPageSize(int dataPageSize)
Description copied from interface: DataBoundComponent
When using data paging, how many records to fetch at a time. The value of this attribute is passed on to the auto-constructed com.smartgwt.client.data.ResultSet object for this component. In effect, this gives you control over the resultSize attribute for this component.

Note that regardless of the dataPageSize setting, a component will always fetch all of data that it needs to draw. Settings such as showAllRecords, drawAllMaxCells and drawAheadRatio can cause more rows than the configured dataPageSize to be fetched.

Specified by:
setDataPageSize in interface DataBoundComponent
Parameters:
dataPageSize - dataPageSize Default value is 75

getDataPageSize

public int getDataPageSize()
Description copied from interface: DataBoundComponent
When using data paging, how many records to fetch at a time. The value of this attribute is passed on to the auto-constructed com.smartgwt.client.data.ResultSet object for this component. In effect, this gives you control over the resultSize attribute for this component.

Note that regardless of the dataPageSize setting, a component will always fetch all of data that it needs to draw. Settings such as showAllRecords, drawAllMaxCells and drawAheadRatio can cause more rows than the configured dataPageSize to be fetched.

Specified by:
getDataPageSize in interface DataBoundComponent
Returns:
int

setUseAllDataSourceFields

public void setUseAllDataSourceFields(java.lang.Boolean useAllDataSourceFields)
Description copied from interface: DataBoundComponent
If true, the set of fields given by the "default binding" (see 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.

${isc.DocUtils.linkForExampleId('validationFieldBinding', 'This example')} shows a mixture of component fields and DataSource fields, and how they interact for validation.

Specified by:
setUseAllDataSourceFields in interface DataBoundComponent
Parameters:
useAllDataSourceFields - useAllDataSourceFields Default value is false

getUseAllDataSourceFields

public java.lang.Boolean getUseAllDataSourceFields()
Description copied from interface: DataBoundComponent
If true, the set of fields given by the "default binding" (see 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.

${isc.DocUtils.linkForExampleId('validationFieldBinding', 'This example')} shows a mixture of component fields and DataSource fields, and how they interact for validation.

Specified by:
getUseAllDataSourceFields in interface DataBoundComponent
Returns:
Boolean

setShowHiddenFields

public void setShowHiddenFields(java.lang.Boolean showHiddenFields)
Description copied from interface: DataBoundComponent
Whether to show fields marked hidden:true when a DataBoundComponent is given a DataSource but no component.fields.

The hidden property is used on DataSource fields to mark fields that are never of meaning to an end user.

Specified by:
setShowHiddenFields in interface DataBoundComponent
Parameters:
showHiddenFields - showHiddenFields Default value is false

getShowHiddenFields

public java.lang.Boolean getShowHiddenFields()
Description copied from interface: DataBoundComponent
Whether to show fields marked hidden:true when a DataBoundComponent is given a DataSource but no component.fields.

The hidden property is used on DataSource fields to mark fields that are never of meaning to an end user.

Specified by:
getShowHiddenFields in interface DataBoundComponent
Returns:
Boolean

setShowDetailFields

public void setShowDetailFields(java.lang.Boolean showDetailFields)
Description copied from interface: DataBoundComponent
Whether to show fields marked detail:true when a DataBoundComponent is given a DataSource but no component.fields.

The detail property 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:
setShowDetailFields in interface DataBoundComponent
Parameters:
showDetailFields - showDetailFields Default value is false

getShowDetailFields

public java.lang.Boolean getShowDetailFields()
Description copied from interface: DataBoundComponent
Whether to show fields marked detail:true when a DataBoundComponent is given a DataSource but no component.fields.

The detail property 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:
getShowDetailFields in interface DataBoundComponent
Returns:
Boolean

setShowComplexFields

public void setShowComplexFields(java.lang.Boolean showComplexFields)
Description copied from interface: DataBoundComponent
Whether to show fields of non-atomic types when a DataBoundComponent is given a DataSource but no component.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:
setShowComplexFields in interface DataBoundComponent
Parameters:
showComplexFields - showComplexFields Default value is true

getShowComplexFields

public java.lang.Boolean getShowComplexFields()
Description copied from interface: DataBoundComponent
Whether to show fields of non-atomic types when a DataBoundComponent is given a DataSource but no component.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:
getShowComplexFields in interface DataBoundComponent
Returns:
Boolean

setFetchOperation

public void setFetchOperation(java.lang.String fetchOperation)
Description copied from interface: DataBoundComponent
Operation ID this component should use when performing fetch operations.

Specified by:
setFetchOperation in interface DataBoundComponent
Parameters:
fetchOperation - fetchOperation Default value is null

getFetchOperation

public java.lang.String getFetchOperation()
Description copied from interface: DataBoundComponent
Operation ID this component should use when performing fetch operations.

Specified by:
getFetchOperation in interface DataBoundComponent
Returns:
String

setUpdateOperation

public void setUpdateOperation(java.lang.String updateOperation)
Description copied from interface: DataBoundComponent
Operation ID this component should use when performing update operations.

Specified by:
setUpdateOperation in interface DataBoundComponent
Parameters:
updateOperation - updateOperation Default value is null

getUpdateOperation

public java.lang.String getUpdateOperation()
Description copied from interface: DataBoundComponent
Operation ID this component should use when performing update operations.

Specified by:
getUpdateOperation in interface DataBoundComponent
Returns:
String

setAddOperation

public void setAddOperation(java.lang.String addOperation)
Description copied from interface: DataBoundComponent
Operation ID this component should use when performing add operations.

Specified by:
setAddOperation in interface DataBoundComponent
Parameters:
addOperation - addOperation Default value is null

getAddOperation

public java.lang.String getAddOperation()
Description copied from interface: DataBoundComponent
Operation ID this component should use when performing add operations.

Specified by:
getAddOperation in interface DataBoundComponent
Returns:
String

setRemoveOperation

public void setRemoveOperation(java.lang.String removeOperation)
Description copied from interface: DataBoundComponent
Operation ID this component should use when performing remove operations.

Specified by:
setRemoveOperation in interface DataBoundComponent
Parameters:
removeOperation - removeOperation Default value is null

getRemoveOperation

public java.lang.String getRemoveOperation()
Description copied from interface: DataBoundComponent
Operation ID this component should use when performing remove operations.

Specified by:
getRemoveOperation in interface DataBoundComponent
Returns:
String

setExportFields

public void setExportFields(java.lang.String[] exportFields)
Description copied from interface: DataBoundComponent
The 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:
setExportFields in interface DataBoundComponent
Parameters:
exportFields - exportFields Default value is null

getExportFields

public java.lang.String[] getExportFields()
Description copied from interface: DataBoundComponent
The 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:
getExportFields in interface DataBoundComponent
Returns:
the list of field-names to export.

setExportAll

public void setExportAll(java.lang.Boolean exportAll)
Description copied from interface: DataBoundComponent
Setting exportAll to true prevents the component from passing it's list of fields to the export call. The result is the export of all visible fields from fields.

If exportAll is false, an export operation will first consider exportFields, if it's set, and fall back on all visible fields from fields otherwise.

Specified by:
setExportAll in interface DataBoundComponent
Parameters:
exportAll - exportAll Default value is false

getExportAll

public java.lang.Boolean getExportAll()
Description copied from interface: DataBoundComponent
Setting exportAll to true prevents the component from passing it's list of fields to the export call. The result is the export of all visible fields from fields.

If exportAll is false, an export operation will first consider exportFields, if it's set, and fall back on all visible fields from fields otherwise.

Specified by:
getExportAll in interface DataBoundComponent
Returns:
Boolean

setPreventDuplicates

public void setPreventDuplicates(java.lang.Boolean preventDuplicates)
                          throws java.lang.IllegalStateException
Description copied from interface: DataBoundComponent
If set, detect and prevent duplicate records from being transferred to this component, either via drag and drop or via DataBoundComponent.transferSelectedData(com.smartgwt.client.widgets.DataBoundComponent). When a duplicate transfer is detected, a dialog will appear showing the duplicateDragMessage.

If the component either does not have a DataSource or has a DataSource with no primaryKey declared, 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:
setPreventDuplicates in interface DataBoundComponent
Parameters:
preventDuplicates - preventDuplicates Default value is null
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getPreventDuplicates

public java.lang.Boolean getPreventDuplicates()
Description copied from interface: DataBoundComponent
If set, detect and prevent duplicate records from being transferred to this component, either via drag and drop or via DataBoundComponent.transferSelectedData(com.smartgwt.client.widgets.DataBoundComponent). When a duplicate transfer is detected, a dialog will appear showing the duplicateDragMessage.

If the component either does not have a DataSource or has a DataSource with no primaryKey declared, 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:
getPreventDuplicates in interface DataBoundComponent
Returns:
Boolean

setDuplicateDragMessage

public void setDuplicateDragMessage(java.lang.String duplicateDragMessage)
                             throws java.lang.IllegalStateException
Description copied from interface: DataBoundComponent
Message to show when a user attempts to transfer duplicate records into this component, and preventDuplicates is enabled.

Specified by:
setDuplicateDragMessage in interface DataBoundComponent
Parameters:
duplicateDragMessage - duplicateDragMessage Default value is "Duplicates not allowed"
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getDuplicateDragMessage

public java.lang.String getDuplicateDragMessage()
Description copied from interface: DataBoundComponent
Message to show when a user attempts to transfer duplicate records into this component, and preventDuplicates is enabled.

Specified by:
getDuplicateDragMessage in interface DataBoundComponent
Returns:
String

setAddDropValues

public void setAddDropValues(java.lang.Boolean addDropValues)
Description copied from interface: DataBoundComponent
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. "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:
setAddDropValues in interface DataBoundComponent
Parameters:
addDropValues - addDropValues Default value is true

getAddDropValues

public java.lang.Boolean getAddDropValues()
Description copied from interface: DataBoundComponent
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. "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:
getAddDropValues in interface DataBoundComponent
Returns:
Boolean

setDropValues

public void setDropValues(java.util.Map dropValues)
Description copied from interface: DataBoundComponent
When an item is dropped on this component, and addDropValues is 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 SmartGWT will apply to the dropped object before updating it.

If this property is not defined, SmartGWT 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:
setDropValues in interface DataBoundComponent
Parameters:
dropValues - dropValues Default value is null

getDropValues

public java.util.Map getDropValues()
Description copied from interface: DataBoundComponent
When an item is dropped on this component, and addDropValues is 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 SmartGWT will apply to the dropped object before updating it.

If this property is not defined, SmartGWT 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.

Specified by:
getDropValues in interface DataBoundComponent
Returns:
Returns the "drop values" to apply to a record dropped on this component prior to update. Only applicable to databound components - see dropValues for 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 addDropValues is 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.


setUseFlatFields

public void setUseFlatFields(java.lang.Boolean useFlatFields)
                      throws java.lang.IllegalStateException
Description copied from interface: DataBoundComponent
The useFlatFields flag causes all simple type fields anywhere in a nested set of DataSources to be exposed as a flat list for form binding.

useFlatFields is 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>
 
Setting useFlatFields on a DynamicForm that is bound to this input message schema would result in 5 FormItem reflecting 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 a WebService, these values can be automatically mapped to the structure of the input message for a web service operation by setting useFlatFields (for use with WebService.callOperation(java.lang.String, java.util.Map, java.lang.String, com.smartgwt.client.data.WebServiceCallback)) or by setting useFlatFields (for use with a DataSource that 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 useFlatFields to automatically enable "flattened" XML serialization (request.useFlatFields) for all DataSource requests of a particular operationType.

Note that useFlatFields is 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:
setUseFlatFields in interface DataBoundComponent
Parameters:
useFlatFields - useFlatFields Default value is null
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getUseFlatFields

public java.lang.Boolean getUseFlatFields()
Description copied from interface: DataBoundComponent
The useFlatFields flag causes all simple type fields anywhere in a nested set of DataSources to be exposed as a flat list for form binding.

useFlatFields is 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>
 
Setting useFlatFields on a DynamicForm that is bound to this input message schema would result in 5 FormItem reflecting 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 a WebService, these values can be automatically mapped to the structure of the input message for a web service operation by setting useFlatFields (for use with WebService.callOperation(java.lang.String, java.util.Map, java.lang.String, com.smartgwt.client.data.WebServiceCallback)) or by setting useFlatFields (for use with a DataSource that 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 useFlatFields to automatically enable "flattened" XML serialization (request.useFlatFields) for all DataSource requests of a particular operationType.

Note that useFlatFields is 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:
getUseFlatFields in interface DataBoundComponent
Returns:
Boolean

setHiliteProperty

public void setHiliteProperty(java.lang.String hiliteProperty)
Description copied from interface: DataBoundComponent
Marker that can be set on a record to flag that record as hilited. Should be set to a value that matches id for a hilite defined on this component.

Specified by:
setHiliteProperty in interface DataBoundComponent
Parameters:
hiliteProperty - hiliteProperty Default value is "_hilite"

getHiliteProperty

public java.lang.String getHiliteProperty()
Description copied from interface: DataBoundComponent
Marker that can be set on a record to flag that record as hilited. Should be set to a value that matches id for a hilite defined on this component.

Specified by:
getHiliteProperty in interface DataBoundComponent
Returns:
String

setDragDataAction

public void setDragDataAction(DragDataAction dragDataAction)
Description copied from interface: DataBoundComponent
Indicates what to do with data dragged into another DataBoundComponent. See DragDataAction type for details.

Specified by:
setDragDataAction in interface DataBoundComponent
Parameters:
dragDataAction - dragDataAction Default value is Canvas.MOVE

getDragDataAction

public DragDataAction getDragDataAction()
Description copied from interface: DataBoundComponent
Indicates what to do with data dragged into another DataBoundComponent. See DragDataAction type for details.

Specified by:
getDragDataAction in interface DataBoundComponent
Returns:
DragDataAction

setDragTrackerStyle

public void setDragTrackerStyle(java.lang.String dragTrackerStyle)
Description copied from interface: DataBoundComponent
CSS Style to apply to the drag tracker when dragging occurs on this component.

Specified by:
setDragTrackerStyle in interface DataBoundComponent
Parameters:
dragTrackerStyle - dragTrackerStyle Default value is "gridDragTracker"

getDragTrackerStyle

public java.lang.String getDragTrackerStyle()
Description copied from interface: DataBoundComponent
CSS Style to apply to the drag tracker when dragging occurs on this component.

Specified by:
getDragTrackerStyle in interface DataBoundComponent
Returns:
String

setCanAddFormulaFields

public void setCanAddFormulaFields(java.lang.Boolean canAddFormulaFields)
Description copied from interface: DataBoundComponent
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 com.smartgwt.client..FormulaBuilder.

User-added formula fields can be persisted via ListGrid.getFieldState() and ListGrid.setFieldState(java.lang.String).

Specified by:
setCanAddFormulaFields in interface DataBoundComponent
Parameters:
canAddFormulaFields - canAddFormulaFields Default value is false

addSummaryField

public void addSummaryField()
Description copied from interface: DataBoundComponent
Convenience method to display a com.smartgwt.client..SummaryBuilder to create a new Summary Field. This is equivalent to calling DataBoundComponentGen#editSummaryField with no paramater.

Specified by:
addSummaryField in interface DataBoundComponent

addFormulaField

public void addFormulaField()
Description copied from interface: DataBoundComponent
Convenience method to display a com.smartgwt.client..FormulaBuilder to create a new Formula Field. This is equivalent to calling DataBoundComponentGen#editFormulaField with no paramater.

Specified by:
addFormulaField in interface DataBoundComponent

getCanAddFormulaFields

public java.lang.Boolean getCanAddFormulaFields()
Description copied from interface: DataBoundComponent
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 com.smartgwt.client..FormulaBuilder.

User-added formula fields can be persisted via ListGrid.getFieldState() and ListGrid.setFieldState(java.lang.String).

Specified by:
getCanAddFormulaFields in interface DataBoundComponent
Returns:
Boolean

setAddFormulaFieldText

public void setAddFormulaFieldText(java.lang.String addFormulaFieldText)
Description copied from interface: DataBoundComponent
Text for a menu item allowing users to add a formula field

Specified by:
setAddFormulaFieldText in interface DataBoundComponent
Parameters:
addFormulaFieldText - addFormulaFieldText Default value is "Add formula column..."

getAddFormulaFieldText

public java.lang.String getAddFormulaFieldText()
Description copied from interface: DataBoundComponent
Text for a menu item allowing users to add a formula field

Specified by:
getAddFormulaFieldText in interface DataBoundComponent
Returns:
String

setEditFormulaFieldText

public void setEditFormulaFieldText(java.lang.String editFormulaFieldText)
Description copied from interface: DataBoundComponent
Text for a menu item allowing users to edit a formula field

Specified by:
setEditFormulaFieldText in interface DataBoundComponent
Parameters:
editFormulaFieldText - editFormulaFieldText Default value is "Edit formula..."

getEditFormulaFieldText

public java.lang.String getEditFormulaFieldText()
Description copied from interface: DataBoundComponent
Text for a menu item allowing users to edit a formula field

Specified by:
getEditFormulaFieldText in interface DataBoundComponent
Returns:
String

setCanAddSummaryFields

public void setCanAddSummaryFields(java.lang.Boolean canAddSummaryFields)
Description copied from interface: DataBoundComponent
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 com.smartgwt.client..SummaryBuilder.

User-added summary fields can be persisted via ListGrid.getFieldState() and ListGrid.setFieldState(java.lang.String).

Specified by:
setCanAddSummaryFields in interface DataBoundComponent
Parameters:
canAddSummaryFields - canAddSummaryFields Default value is false

getCanAddSummaryFields

public java.lang.Boolean getCanAddSummaryFields()
Description copied from interface: DataBoundComponent
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 com.smartgwt.client..SummaryBuilder.

User-added summary fields can be persisted via ListGrid.getFieldState() and ListGrid.setFieldState(java.lang.String).

Specified by:
getCanAddSummaryFields in interface DataBoundComponent
Returns:
Boolean

setAddSummaryFieldText

public void setAddSummaryFieldText(java.lang.String addSummaryFieldText)
Description copied from interface: DataBoundComponent
Text for a menu item allowing users to add a formula field

Specified by:
setAddSummaryFieldText in interface DataBoundComponent
Parameters:
addSummaryFieldText - addSummaryFieldText Default value is "Add summary column..."

getAddSummaryFieldText

public java.lang.String getAddSummaryFieldText()
Description copied from interface: DataBoundComponent
Text for a menu item allowing users to add a formula field

Specified by:
getAddSummaryFieldText in interface DataBoundComponent
Returns:
String

setEditSummaryFieldText

public void setEditSummaryFieldText(java.lang.String editSummaryFieldText)
Description copied from interface: DataBoundComponent
Text for a menu item allowing users to edit the formatter for a field

Specified by:
setEditSummaryFieldText in interface DataBoundComponent
Parameters:
editSummaryFieldText - editSummaryFieldText Default value is "Edit summary format..."

getEditSummaryFieldText

public java.lang.String getEditSummaryFieldText()
Description copied from interface: DataBoundComponent
Text for a menu item allowing users to edit the formatter for a field

Specified by:
getEditSummaryFieldText in interface DataBoundComponent
Returns:
String

selectRecord

public void selectRecord(Record record)
Description copied from interface: DataBoundComponent
Select/deselect a Record passed in explicitly, or by index.

Specified by:
selectRecord in interface DataBoundComponent
Parameters:
record - record (or row number) to select

selectRecord

public void selectRecord(int record)
Description copied from interface: DataBoundComponent
Select/deselect a Record passed in explicitly, or by index.

Specified by:
selectRecord in interface DataBoundComponent
Parameters:
record - record (or row number) to select

selectRecord

public void selectRecord(int record,
                         boolean newState)
Description copied from interface: DataBoundComponent
Select/deselect a Record passed in explicitly, or by index.

Specified by:
selectRecord in interface DataBoundComponent
Parameters:
record - record (or row number) to select
newState - new selection state (if null, defaults to true)

selectRecord

public void selectRecord(Record record,
                         boolean newState)
Description copied from interface: DataBoundComponent
Select/deselect a Record passed in explicitly, or by index.

Specified by:
selectRecord in interface DataBoundComponent
Parameters:
record - record (or row number) to select
newState - new selection state (if null, defaults to true)

selectRecords

public void selectRecords(int[] records)
Description copied from interface: DataBoundComponent
Select/deselect a list of Records passed in explicitly, or by index.

Specified by:
selectRecords in interface DataBoundComponent
Parameters:
records - records (or row numbers) to select

selectRecords

public void selectRecords(int[] records,
                          boolean newState)
Description copied from interface: DataBoundComponent
Select/deselect a list of Records passed in explicitly, or by index.

Specified by:
selectRecords in interface DataBoundComponent
Parameters:
records - records (or row numbers) to select
newState - new selection state

selectRecords

public void selectRecords(Record[] records)
Description copied from interface: DataBoundComponent
Select/deselect a list of Records passed in explicitly, or by index.

Specified by:
selectRecords in interface DataBoundComponent
Parameters:
records - records (or row numbers) to select

selectRecords

public void selectRecords(Record[] records,
                          boolean newState)
Description copied from interface: DataBoundComponent
Select/deselect a list of Records passed in explicitly, or by index.

Specified by:
selectRecords in interface DataBoundComponent
Parameters:
records - records (or row numbers) to select
newState - new selection state (if null, defaults to true)

deselectRecord

public void deselectRecord(Record record)
Description copied from interface: DataBoundComponent
Deselect a Record passed in explicitly, or by index.

Synonym for selectRecord(record, false)

Specified by:
deselectRecord in interface DataBoundComponent
Parameters:
record - record (or row number) to deselect

deselectRecord

public void deselectRecord(int record)
Description copied from interface: DataBoundComponent
Deselect a Record passed in explicitly, or by index.

Synonym for selectRecord(record, false)

Specified by:
deselectRecord in interface DataBoundComponent
Parameters:
record - record (or row number) to deselect

deselectRecords

public void deselectRecords(int[] records)
Description copied from interface: DataBoundComponent
Deselect a list of Records passed in explicitly, or by index.

Synonym for selectRecords(records, false)

Specified by:
deselectRecords in interface DataBoundComponent
Parameters:
records - records (or row numbers) to deselect

deselectRecords

public void deselectRecords(Record[] records)
Description copied from interface: DataBoundComponent
Deselect a list of Records passed in explicitly, or by index.

Synonym for selectRecords(records, false)

Specified by:
deselectRecords in interface DataBoundComponent
Parameters:
records - records (or row numbers) to deselect

selectAllRecords

public void selectAllRecords()
Description copied from interface: DataBoundComponent
Select all records

Specified by:
selectAllRecords in interface DataBoundComponent

deselectAllRecords

public void deselectAllRecords()
Description copied from interface: DataBoundComponent
Deselect all records

Specified by:
deselectAllRecords in interface DataBoundComponent

anySelected

public java.lang.Boolean anySelected()
Description copied from interface: DataBoundComponent
Whether at least one item is selected

Specified by:
anySelected in interface DataBoundComponent
Returns:
true == at least one item is selected false == nothing at all is selected

enableHilite

public void enableHilite(java.lang.String hiliteID)
Description copied from interface: DataBoundComponent
Enable / disable a hilites

Specified by:
enableHilite in interface DataBoundComponent
Parameters:
hiliteID - ID of hilite to enable

enableHilite

public void enableHilite(java.lang.String hiliteID,
                         boolean enable)
Description copied from interface: DataBoundComponent
Enable / disable a hilites

Specified by:
enableHilite in interface DataBoundComponent
Parameters:
hiliteID - ID of hilite to enable
enable - new enabled state to apply - if null, defaults to true

disableHilite

public void disableHilite(java.lang.String hiliteID)
Description copied from interface: DataBoundComponent
Disable a hilite

Specified by:
disableHilite in interface DataBoundComponent
Parameters:
hiliteID - ID of hilite to disable

enableHiliting

public void enableHiliting()
Description copied from interface: DataBoundComponent
Enable all hilites.

Specified by:
enableHiliting in interface DataBoundComponent

enableHiliting

public void enableHiliting(boolean enable)
Description copied from interface: DataBoundComponent
Enable all hilites.

Specified by:
enableHiliting in interface DataBoundComponent
Parameters:
enable - new enabled state to apply - if null, defaults to true

disableHiliting

public void disableHiliting()
Description copied from interface: DataBoundComponent
Disable all hilites.

Specified by:
disableHiliting in interface DataBoundComponent

getDragData

public Record[] getDragData()
Description copied from interface: DataBoundComponent
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 generally called by com.smartgwt.client.widgets.DataBoundComponent#transferDragData and is consulted by ListGrid.willAcceptDrop().

Specified by:
getDragData in interface DataBoundComponent
Returns:
Array of Records that are currently selected.

transferSelectedData

public void transferSelectedData(DataBoundComponent source)
Description copied from interface: DataBoundComponent
Simulates 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 calling DataBoundComponent.getDropValues() for each dropped record.

To transfer all data in, for example, a ListGrid, call grid.selection.selectAll() first.

See the Dragging documentation for an overview of list grid drag/drop data transfer.

Specified by:
transferSelectedData in interface DataBoundComponent
Parameters:
source - source component from which the records will be tranferred

transferSelectedData

public void transferSelectedData(DataBoundComponent source,
                                 int index)
Description copied from interface: DataBoundComponent
Simulates 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 calling DataBoundComponent.getDropValues() for each dropped record.

To transfer all data in, for example, a ListGrid, call grid.selection.selectAll() first.

See the Dragging documentation for an overview of list grid drag/drop data transfer.

Specified by:
transferSelectedData in interface DataBoundComponent
Parameters:
source - source component from which the records will be tranferred
index - target index (drop position) of the rows within this grid.

getRecordIndex

public int getRecordIndex(Record record)
Description copied from interface: DataBoundComponent
Get 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:
getRecordIndex in interface DataBoundComponent
Parameters:
record - the record whose index is to be retrieved
Returns:
indexindex of the record, or -1 if not found

getTitleFieldValue

public java.lang.String getTitleFieldValue(Record record)
Description copied from interface: DataBoundComponent
Get the value of the titleField for the passed record

Override in subclasses

Specified by:
getTitleFieldValue in interface DataBoundComponent
Parameters:
record - the record whose index is to be retrieved
Returns:
valuethe value of the titleField for the passed record

setTitleField

public void setTitleField(java.lang.String titleField)
Specified by:
setTitleField in interface DataBoundComponent

getTitleField

public java.lang.String getTitleField()
Description copied from interface: DataBoundComponent
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 check titleField for databound compounds.
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:
getTitleField in interface DataBoundComponent
Returns:
fieldName for title field for this component.

setDataSource

public void setDataSource(DataSource dataSource)
Description copied from interface: DataBoundComponent
The DataSource that this component should bind to for default fields and for performing DSRequest.

Can be specified as either a DataSource instance or the String ID of a DataSource. Bind to a new DataSource.

Like passing the "dataSource" property on creation, 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().

Specified by:
setDataSource in interface DataBoundComponent
Parameters:
dataSource - DataSource to bind to. Default value is null

getDataSource

public DataSource getDataSource()
Description copied from interface: DataBoundComponent
The DataSource that this component should bind to for default fields and for performing DSRequest.

Can be specified as either a DataSource instance or the String ID of a DataSource.

Specified by:
getDataSource in interface DataBoundComponent
Returns:
DataSource

setAutoFetchData

public void setAutoFetchData(java.lang.Boolean autoFetchData)
                      throws java.lang.IllegalStateException
Description copied from interface: DataBoundComponent
If true, when this component is first drawn, automatically call DataBoundComponent.fetchData() or DataBoundComponent.filterData() depending on DataBoundComponent.getAutoFetchAsFilter() . Criteria for this fetch may be picked up from initialCriteria.

Specified by:
setAutoFetchData in interface DataBoundComponent
Parameters:
autoFetchData - autoFetchData
Throws:
java.lang.IllegalStateException

getAutoFetchData

public java.lang.Boolean getAutoFetchData()
Description copied from interface: DataBoundComponent
If true, when this component is first drawn, automatically call DataBoundComponent.fetchData() or DataBoundComponent.filterData() depending on DataBoundComponent.getAutoFetchAsFilter() . Criteria for this fetch may be picked up from initialCriteria.

Specified by:
getAutoFetchData in interface DataBoundComponent
Returns:
auto fetch data

setAutoFetchAsFilter

public void setAutoFetchAsFilter(java.lang.Boolean autoFetchAsFilter)
                          throws java.lang.IllegalStateException
Description copied from interface: DataBoundComponent
If DataBoundComponent.setAutoFetchData(Boolean) is true, this attribute determines whether the initial fetch operation should be performed via DataBoundComponent.fetchData() or DataBoundComponent.filterData()

Specified by:
setAutoFetchAsFilter in interface DataBoundComponent
Parameters:
autoFetchAsFilter - autoFetchAsFilter
Throws:
java.lang.IllegalStateException

getAutoFetchAsFilter

public java.lang.Boolean getAutoFetchAsFilter()
Description copied from interface: DataBoundComponent
If DataBoundComponent.setAutoFetchData(Boolean) is true, this attribute determines whether the initial fetch operation should be performed via DataBoundComponent.fetchData() or DataBoundComponent.filterData()

Specified by:
getAutoFetchAsFilter in interface DataBoundComponent
Returns:
auto fetch as filter

setInitialCriteria

public void setInitialCriteria(Criteria initialCriteria)
                        throws java.lang.IllegalStateException
Description copied from interface: DataBoundComponent
Criteria to use when DataBoundComponent.setAutoFetchData(Boolean) is used.

Specified by:
setInitialCriteria in interface DataBoundComponent
Parameters:
initialCriteria - the initial criteria
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getInitialCriteria

public Criteria getInitialCriteria()
Description copied from interface: DataBoundComponent
Criteria to use when DataBoundComponent.setAutoFetchData(Boolean) is used.

Specified by:
getInitialCriteria in interface DataBoundComponent
Returns:
the criteria

fetchData

public void fetchData()
Description copied from interface: DataBoundComponent
Uses a "fetch" operation on the current DataSource to retrieve data that matches the provided criteria, and displays the matching data in this component.

If there are a large number of matching records, paging will automatically be enabled, so that initially a smaller number of records will be retrieved and further records will be fetched as the user navigates the dataset.

When first called, this method will create a com.smartgwt.client.data.ResultSet, which will be configured based on component settings such as fetchOperation and dataPageSize, as well as the general purpose dataProperties. The ResultSet is then available as component.data.

Subsequent calls to fetchData() will simply call com.smartgwt.client.data.ResultSet#setCriteria on the created ResultSet with the passed criteria.

In some cases fetchData() will not need to context the server as the new criteria can be satisfied by performing a client-side filter against the currently cached set of data. You can determine whether criteria will cause a fetch by calling com.smartgwt.client.data.ResultSet#willFetchData.

If you need to force a server fetch, you can call com.smartgwt.client.data.ResultSet#invalidateCache via component.data.invalidateCache() to do so.

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 we recomment using com.smartgwt.client.data.ResultSet#willFetchData before calling this method to determine whether or not a server fetch will occur.

In addition to the callback parameter for this method, developers can use com.smartgwt.client.data.ResultSet#dataArrived to be notified every time ResultSet data is loaded. A dataArrived method can be installed in the automatically created ResultSet by adding it to dataProperties.

Specified by:
fetchData in interface DataBoundComponent

fetchData

public void fetchData(Criteria criteria)
Description copied from interface: DataBoundComponent
Uses a "fetch" operation on the current DataSource to retrieve data that matches the provided criteria, and displays the matching data in this component.

If there are a large number of matching records, paging will automatically be enabled, so that initially a smaller number of records will be retrieved and further records will be fetched as the user navigates the dataset.

When first called, this method will create a com.smartgwt.client.data.ResultSet, which will be configured based on component settings such as fetchOperation and dataPageSize, as well as the general purpose dataProperties. The ResultSet is then available as component.data.

Subsequent calls to fetchData() will simply call com.smartgwt.client.data.ResultSet#setCriteria on the created ResultSet with the passed criteria.

In some cases fetchData() will not need to context the server as the new criteria can be satisfied by performing a client-side filter against the currently cached set of data. You can determine whether criteria will cause a fetch by calling com.smartgwt.client.data.ResultSet#willFetchData.

If you need to force a server fetch, you can call com.smartgwt.client.data.ResultSet#invalidateCache via component.data.invalidateCache() to do so.

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 we recomment using com.smartgwt.client.data.ResultSet#willFetchData before calling this method to determine whether or not a server fetch will occur.

In addition to the callback parameter for this method, developers can use com.smartgwt.client.data.ResultSet#dataArrived to be notified every time ResultSet data is loaded. A dataArrived method can be installed in the automatically created ResultSet by adding it to dataProperties.

Specified by:
fetchData in interface DataBoundComponent
Parameters:
criteria - Search criteria. If a DynamicForm is passed in as this argument instead of a raw criteria object, will be derived by calling DynamicForm.getValuesAsCriteria()

fetchData

public void fetchData(Criteria criteria,
                      DSCallback callback)
Description copied from interface: DataBoundComponent
Uses a "fetch" operation on the current DataSource to retrieve data that matches the provided criteria, and displays the matching data in this component.

If there are a large number of matching records, paging will automatically be enabled, so that initially a smaller number of records will be retrieved and further records will be fetched as the user navigates the dataset.

When first called, this method will create a com.smartgwt.client.data.ResultSet, which will be configured based on component settings such as fetchOperation and dataPageSize, as well as the general purpose dataProperties. The ResultSet is then available as component.data.

Subsequent calls to fetchData() will simply call com.smartgwt.client.data.ResultSet#setCriteria on the created ResultSet with the passed criteria.

In some cases fetchData() will not need to context the server as the new criteria can be satisfied by performing a client-side filter against the currently cached set of data. You can determine whether criteria will cause a fetch by calling com.smartgwt.client.data.ResultSet#willFetchData.

If you need to force a server fetch, you can call com.smartgwt.client.data.ResultSet#invalidateCache via component.data.invalidateCache() to do so.

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 we recomment using com.smartgwt.client.data.ResultSet#willFetchData before calling this method to determine whether or not a server fetch will occur.

In addition to the callback parameter for this method, developers can use com.smartgwt.client.data.ResultSet#dataArrived to be notified every time ResultSet data is loaded. A dataArrived method can be installed in the automatically created ResultSet by adding it to dataProperties.

Specified by:
fetchData in interface DataBoundComponent
Parameters:
criteria - Search criteria. If a DynamicForm is passed in as this argument instead of a raw criteria object, will be derived by calling DynamicForm.getValuesAsCriteria()
callback - callback to invoke when a fetch is complete. Fires only if server contact was required

fetchData

public void fetchData(Criteria criteria,
                      DSCallback callback,
                      DSRequest requestProperties)
Description copied from interface: DataBoundComponent
Uses a "fetch" operation on the current DataSource to retrieve data that matches the provided criteria, and displays the matching data in this component.

If there are a large number of matching records, paging will automatically be enabled, so that initially a smaller number of records will be retrieved and further records will be fetched as the user navigates the dataset.

When first called, this method will create a com.smartgwt.client.data.ResultSet, which will be configured based on component settings such as fetchOperation and dataPageSize, as well as the general purpose dataProperties. The ResultSet is then available as component.data.

Subsequent calls to fetchData() will simply call com.smartgwt.client.data.ResultSet#setCriteria on the created ResultSet with the passed criteria.

In some cases fetchData() will not need to context the server as the new criteria can be satisfied by performing a client-side filter against the currently cached set of data. You can determine whether criteria will cause a fetch by calling com.smartgwt.client.data.ResultSet#willFetchData.

If you need to force a server fetch, you can call com.smartgwt.client.data.ResultSet#invalidateCache via component.data.invalidateCache() to do so.

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 we recomment using com.smartgwt.client.data.ResultSet#willFetchData before calling this method to determine whether or not a server fetch will occur.

In addition to the callback parameter for this method, developers can use com.smartgwt.client.data.ResultSet#dataArrived to be notified every time ResultSet data is loaded. A dataArrived method can be installed in the automatically created ResultSet by adding it to dataProperties.

Specified by:
fetchData in interface DataBoundComponent
Parameters:
criteria - Search criteria. If a DynamicForm is passed in as this argument instead of a raw criteria object, will be derived by calling DynamicForm.getValuesAsCriteria()
callback - callback to invoke when a fetch is complete. Fires only if server contact was required
requestProperties - additional properties to set on the DSRequest that will be issued

filterData

public void filterData()
Description copied from interface: DataBoundComponent
Retrieves data that matches the provided criteria and displays the matching data in this component.

This method behaves exactly like ListGrid.fetchData() except that textMatchStyle is automatically set to "substring" so that String-valued fields are matched by case-insensitive substring comparison.

Specified by:
filterData in interface DataBoundComponent

filterData

public void filterData(Criteria criteria)
Description copied from interface: DataBoundComponent
Retrieves data that matches the provided criteria and displays the matching data in this component.

This method behaves exactly like ListGrid.fetchData() except that textMatchStyle is automatically set to "substring" so that String-valued fields are matched by case-insensitive substring comparison.

Specified by:
filterData in interface DataBoundComponent
Parameters:
criteria - Search criteria. If a DynamicForm is passed in as this argument instead of a raw criteria object, will be derived by calling DynamicForm.getValuesAsCriteria()

filterData

public void filterData(Criteria criteria,
                       DSCallback callback)
Description copied from interface: DataBoundComponent
Retrieves data that matches the provided criteria and displays the matching data in this component.

This method behaves exactly like ListGrid.fetchData() except that textMatchStyle is automatically set to "substring" so that String-valued fields are matched by case-insensitive substring comparison.

Specified by:
filterData in interface DataBoundComponent
Parameters:
criteria - Search criteria. If a DynamicForm is passed in as this argument instead of a raw criteria object, will be derived by calling DynamicForm.getValuesAsCriteria()
callback - callback to invoke when a fetch is complete. Fires only if server contact was required; see DataBoundComponent.fetchData() for details

filterData

public void filterData(Criteria criteria,
                       DSCallback callback,
                       DSRequest requestProperties)
Description copied from interface: DataBoundComponent
Retrieves data that matches the provided criteria and displays the matching data in this component.

This method behaves exactly like ListGrid.fetchData() except that textMatchStyle is automatically set to "substring" so that String-valued fields are matched by case-insensitive substring comparison.

Specified by:
filterData in interface DataBoundComponent
Parameters:
criteria - Search criteria. If a DynamicForm is passed in as this argument instead of a raw criteria object, will be derived by calling DynamicForm.getValuesAsCriteria()
callback - callback to invoke when a fetch is complete. Fires only if server contact was required; see DataBoundComponent.fetchData() for details
requestProperties - for databound components only - optional additional properties to set on the DSRequest that will be issued

invalidateCache

public void invalidateCache()
Description copied from interface: DataBoundComponent
Invalidate the current data cache for this databound component via a call to this.data.invalidateCache(). If necessary, this will cause a new fetch to be performed with the current set of criteria for this component.

Has no effect if this component is not showing a set of filtered data.

Specified by:
invalidateCache in interface DataBoundComponent