public class Calendar extends Canvas implements DataBoundComponent, HasBackgroundClickHandlers, HasBackgroundMouseDownHandlers, HasBackgroundMouseUpHandlers, HasCurrentViewChangedHandlers, HasDateChangedHandlers, HasDayBodyClickHandlers, HasDayHeaderClickHandlers, HasEventAddedHandlers, HasEventChangedHandlers, HasEventClickHandlers, HasEventRemoveClickHandlers, HasEventRemovedHandlers, HasEventRepositionMoveHandlers, HasEventRepositionStopHandlers, HasEventResizeMoveHandlers, HasEventResizeStopHandlers, HasIndicatorClickHandlers, HasZoneClickHandlers
Calendar 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 an
ordinary Array of CalendarEvents or can fetch data from a DataSource. When this is the case, if the DataSource does
not contain fields with the configured property names, an attempt is made to auto-detect likely-looking fields from
those that are present. To see logs indicating that this has happened, switch default logging preferences to INFO
level in the Developer Console.
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 number of views by
default: day
, week
, month
and timeline
. The user can navigate using back and forward
buttons or via an attached DateChooser
.
Event Manipulation
Events can be created by clicking directly onto one of the views, or via the Add Event
button. In the day, week and timeline 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 (for normal events, only the description is required by default - for events that
are shown in a lane
, that field is also required).
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 added
, removed
, or updated
.
config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassName
Constructor and Description |
---|
Calendar() |
Calendar(com.google.gwt.core.client.JavaScriptObject jsObj) |
Modifier and Type | Method and Description |
---|---|
com.google.gwt.event.shared.HandlerRegistration |
addBackgroundClickHandler(BackgroundClickHandler handler)
Add a backgroundClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addBackgroundMouseDownHandler(BackgroundMouseDownHandler handler)
Add a backgroundMouseDown handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addBackgroundMouseUpHandler(BackgroundMouseUpHandler handler)
Add a backgroundMouseUp handler.
|
void |
addCalendarEvent(CalendarEvent event)
Create a new event in this calendar.
|
void |
addCalendarEvent(CalendarEvent event,
java.util.Map customValues)
Create a new event in this calendar.
|
com.google.gwt.event.shared.HandlerRegistration |
addCurrentViewChangedHandler(CurrentViewChangedHandler handler)
Add a currentViewChanged handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addDateChangedHandler(DateChangedHandler handler)
Add a dateChanged handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addDayBodyClickHandler(DayBodyClickHandler handler)
Add a dayBodyClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addDayHeaderClickHandler(DayHeaderClickHandler handler)
Add a dayHeaderClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addDragCompleteHandler(DragCompleteHandler handler)
Add a
com.smartgwt.client.widgets.DragCompleteHandler . |
com.google.gwt.event.shared.HandlerRegistration |
addDropCompleteHandler(DropCompleteHandler handler)
Add a
com.smartgwt.client.widgets.DropCompleteHandler . |
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.
|
com.google.gwt.event.shared.HandlerRegistration |
addEventAddedHandler(EventAddedHandler handler)
Add a eventAdded handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addEventChangedHandler(EventChangedHandler handler)
Add a eventChanged handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addEventClickHandler(EventClickHandler handler)
Add a eventClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addEventRemoveClickHandler(EventRemoveClickHandler handler)
Add a eventRemoveClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addEventRemovedHandler(EventRemovedHandler handler)
Add a eventRemoved handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addEventRepositionMoveHandler(EventRepositionMoveHandler handler)
Add a eventRepositionMove handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addEventRepositionStopHandler(EventRepositionStopHandler handler)
Add a eventRepositionStop handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addEventResizeMoveHandler(EventResizeMoveHandler handler)
Add a eventResizeMove handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addEventResizeStopHandler(EventResizeStopHandler handler)
Add a eventResizeStop handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addFetchDataHandler(FetchDataHandler handler)
Add a fetchData handler.
|
void |
addFormulaField()
Convenience method to display a
com.smartgwt.client..FormulaBuilder to create a new Formula Field. |
void |
addIndicator(CalendarEvent indicator)
Adds a new
indicator to the calendar. |
com.google.gwt.event.shared.HandlerRegistration |
addIndicatorClickHandler(IndicatorClickHandler handler)
Add a indicatorClick handler.
|
void |
addLane(Lane lane)
Adds a new
Lane to the calendar, for display in the timeline view , and in the day view if showDayLanes is true. |
void |
addLaneEvent(Lane laneName,
java.util.Date startDate)
Deprecated.
in favor of
addCalendarEvent() |
void |
addLaneEvent(Lane laneName,
java.util.Date startDate,
java.util.Date endDate) |
void |
addLaneEvent(Lane laneName,
java.util.Date startDate,
java.util.Date endDate,
java.lang.String name) |
void |
addLaneEvent(Lane laneName,
java.util.Date startDate,
java.util.Date endDate,
java.lang.String name,
java.lang.String description) |
void |
addLaneEvent(Lane laneName,
java.util.Date startDate,
java.util.Date endDate,
java.lang.String name,
java.lang.String description,
java.lang.Object otherFields)
Deprecated.
in favor of
addCalendarEvent() |
void |
addSummaryField()
Convenience method to display a
com.smartgwt.client..SummaryBuilder to create a new Summary Field. |
void |
addZone(CalendarEvent zone)
Adds a new
zone to the calendar. |
com.google.gwt.event.shared.HandlerRegistration |
addZoneClickHandler(ZoneClickHandler handler)
Add a zoneClick handler.
|
java.lang.Boolean |
anySelected()
Whether at least one item is selected
|
static boolean |
calendarLoaded()
Static method indicating whether the optional Calendar module is loaded for the page.
|
void |
cancelEditing()
Cancels the current edit-session, closing the builtin event
dialog or editor and clearing any visible edit-selection from the
current CalendarView . |
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
Changes the defaults for Canvas AutoChildren named
autoChildName . |
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
Changes the defaults for FormItem AutoChildren named
autoChildName . |
protected com.google.gwt.core.client.JavaScriptObject |
create() |
boolean |
dateIsWorkday(java.util.Date date)
Should the parameter date be considered a workday? By default this method tries to find the
parameter date day in
workdays ,
and returns true if found. |
void |
deselectAllRecords()
Deselect all records
|
java.lang.Boolean |
deselectEvent(CalendarEvent event)
Removes an event from the list of selected events in the current view, clearing its selected style.
|
java.lang.Boolean |
deselectEvents(CalendarEvent... events)
Removes one or more events from the list of selected events in the current view, clearing their selected styles.
|
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
Record s passed in explicitly, or by index. |
void |
deselectRecords(Record[] records)
Deselect a list of
Record s passed in explicitly, or by index. |
void |
disableHilite(java.lang.String hiliteID)
Disable a hilite
|
void |
disableHiliting()
Disable all hilites.
|
void |
editFields()
Shows a FieldPicker interface allowing end-users to rearrange the order and visibiility
of the fields in the associated DataBoundComponent.
|
void |
editHilites()
Shows a HiliteEditor interface allowing end-users to edit the data-hilites currently in use by this DataBoundComponent.
|
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.
|
boolean |
eventMoved(java.util.Date newDate,
CalendarEvent event,
java.lang.String newLane)
Deprecated.
in favor of
Calendar.eventRepositionStop() |
boolean |
eventResized(java.util.Date newDate,
CalendarEvent event)
Deprecated.
in favor of
Calendar.eventResizeStop() |
void |
eventsRendered()
A notification method fired when the events in the current view have been refreshed.
|
void |
exportData()
|
void |
exportData(DSRequest requestProperties)
|
void |
exportData(DSRequest requestProperties,
RPCCallback callback)
Uses a "fetch" operation on the current
DataSource
to retrieve data that matches the current filter and sort criteria for this component,
then exports the resulting data to a file or window in the requested format. |
void |
fetchData()
Retrieves data from the DataSource that matches the specified criteria.
|
void |
fetchData(Criteria criteria)
Retrieves data from the DataSource that matches the specified criteria.
|
void |
fetchData(Criteria criteria,
DSCallback callback)
Retrieves data from the DataSource that matches the specified criteria.
|
void |
fetchData(Criteria criteria,
DSCallback callback,
DSRequest requestProperties)
Retrieves data from the DataSource that matches the specified criteria.
|
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.
|
Record |
find(AdvancedCriteria adCriteria)
Filters all objects according to the AdvancedCriteria passed and returns the first matching object or null if not found
|
Record[] |
findAll(AdvancedCriteria adCriteria)
Filters all objects according to the AdvancedCriteria passed
|
int |
findIndex(AdvancedCriteria adCriteria)
Finds the index of the first Record that matches with the AdvacendCriteria passed.
|
int |
findNextIndex(int startIndex,
AdvancedCriteria adCriteria)
Like
RecordList.findIndex(java.util.Map) , but considering the startIndex parameter. |
int |
findNextIndex(int startIndex,
AdvancedCriteria adCriteria,
int endIndex)
Like
RecordList.findIndex(java.util.Map) , but considering the startIndex and endIndex parameters. |
java.lang.Integer |
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.
|
ImgButton |
getAddEventButton()
|
java.lang.String |
getAddEventButtonHoverText()
The text to be displayed when a user hovers over the
add event toolbar button |
java.lang.String |
getAddFormulaFieldText()
Text for a menu item allowing users to add a formula field
|
java.lang.String |
getAddOperation()
operationId 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 |
getAllowDurationEvents()
When set to true, allows events to be managed by duration, as well as by end date.
|
java.lang.Boolean |
getAlternateLaneStyles()
When showing a
Timeline , or a day view when showDayLanes is true, whether to make lane boundaries
more obvious by showing alternate lanes in a different color. |
java.lang.Boolean |
getAlwaysShowEventHovers()
By default, EventCanvases show their content in hovers, and will only show a hover if the content is clipped.
|
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() . |
TextMatchStyle |
getAutoFetchTextMatchStyle()
If
autoFetchData is true , this attribute allows the developer to specify a textMatchStyle
for the initial DataBoundComponent.fetchData() call. |
java.lang.String |
getBackButtonTitle()
The title of the
month on Handsets when the month view is the current visible view. |
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 |
getBringEventsToFront()
If set to true, clicking an event will bring it to the front of the zorder.
|
java.lang.String |
getCalMonthEventLinkStyle()
The base name for the CSS class applied to the links rendered by
getDayBodyHTML() . |
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 .
|
IButton |
getCancelButton()
An
com.smartgwt.client.types.AutoChild of type IButton , used to cancel
editing of an event and close the eventEditor . |
java.lang.String |
getCancelButtonTitle()
The title for the
Cancel button in the event editor . |
java.lang.Boolean |
getCanCreateEvents()
If true, users can create new events.
|
java.lang.Boolean |
getCanDeleteEvents()
Deprecated.
in favor of
canRemoveEvents |
java.lang.Boolean |
getCanDragCreateEvents()
A boolean value controlling whether new events of varying length can be created by dragging the cursor.
|
java.lang.String |
getCanDragEventField()
Name of the field on each
CalendarEvent that determines whether an EventCanvas can be moved or resized by dragging with the mouse. |
java.lang.Boolean |
getCanDragEvents()
A boolean value controlling whether users can drag-reposition 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 whether it can be
edited in the event editor . |
java.lang.Boolean |
getCanEditLane()
Can events be moved between lanes? If so, the event can be dragged to a different
lane , and the event quick dialog and editor allow a lane to be selected with a drop-down
chooser. |
java.lang.String |
getCanEditLaneField()
Name of the field on each
CalendarEvent that determines whether that event
can be moved between lanes. |
java.lang.Boolean |
getCanEditSublane()
Can events be moved between sublanes?
|
java.lang.String |
getCanEditSublaneField()
Name of the field on each
CalendarEvent that determines whether that event
can be moved between individual sublanes in a Lane . |
java.lang.Boolean |
getCanGroupLanes()
If true, allows the lanes in a Timeline to be grouped by providing a value for
laneGroupByField . |
java.lang.Boolean |
getCanRemoveEvents()
If true, users can remove existing events.
|
java.lang.String |
getCanRemoveField()
Name of the field on each
CalendarEvent that determines whether an event
shows a remove button. |
java.lang.Boolean |
getCanReorderLanes()
If true, lanes can be reordered by dragging their
laneFields with the mouse. |
java.lang.String |
getCanResizeEventField()
Name of the field on each
CalendarEvent that determines whether an event
can be resized by dragging. |
java.lang.Boolean |
getCanResizeEvents()
Can
events be resized by dragging appropriate edges of the
canvas ? Only has an effect when both canEditEvents and canDragEvents are true. |
java.lang.Boolean |
getCanResizeTimelineEvents()
Deprecated.
in favor of
canResizeEvents ; |
java.lang.Boolean |
getCanSelectEvents()
When set to true, makes individual
event canvases selectable. |
java.util.Date |
getCellDate()
Return the Date instance associated with the passed co-ordinates in the passed or selected view.
|
java.util.Date |
getCellDate(java.lang.Integer rowNum) |
java.util.Date |
getCellDate(java.lang.Integer rowNum,
java.lang.Integer colNum) |
java.util.Date |
getCellDate(java.lang.Integer rowNum,
java.lang.Integer colNum,
CalendarView view)
Return the Date instance associated with the passed co-ordinates in the passed or selected view.
|
java.lang.String |
getCellHoverHTML(CalendarView view,
Record record,
java.lang.Integer rowNum,
java.lang.Integer colNum,
java.util.Date date,
java.lang.String defaultValue)
Returns the hover HTML for the cell at the passed co-ordinates in the passed view.
|
java.util.Date |
getChosenDate()
The date for which events are displayed in the day, week, and month tabs of the calendar.
|
java.lang.Integer |
getColumnsPerPage()
When using the Next and Previous arrows to scroll a Timeline, this is the number of columns of the
timelineGranularity to scroll by. |
HLayout |
getControlsBar()
An
HLayout shown above the Calendar views and displaying a set of
controls for interacting with the current view - namely, the next , previous and add buttons, the date label and the date-picker icon. |
ViewName |
getCurrentViewName()
The name of the view that should be visible initially by default.
|
CalendarEvent[] |
getData()
A List of CalendarEvent objects, specifying the data to be used to populate the calendar.
|
com.google.gwt.core.client.JavaScriptObject |
getDataAsJSList() |
FetchMode |
getDataFetchMode()
How to fetch and manage records retrieve from the server.
|
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
DataSource requests . |
java.lang.String |
getDateCellAlign(java.util.Date date,
java.lang.Integer rowNum,
java.lang.Integer colNum,
CalendarView view)
When
getDateHTML returns a value, this method returns
the horizontal alignment for that value in its cell, in the passed view. |
java.lang.String |
getDateCellVAlign(java.util.Date date,
java.lang.Integer rowNum,
java.lang.Integer colNum,
CalendarView view)
When
getDateHTML returns a value, this method returns
the vertical alignment for that value in its cell, in the passed view. |
DateChooser |
getDateChooser()
DateChooser used to select the date for which events will be displayed. |
java.lang.String |
getDateCSSText(java.util.Date date,
java.lang.Integer rowNum,
java.lang.Integer colNum,
CalendarView view)
Return CSS text for styling the cell associated with the passed date and/or rowNum & colNum, which will be applied in
addition to the CSS class for the cell, as overrides.
|
DateEditingStyle |
getDateEditingStyle()
Indicates the type of controls to use in event-windows.
|
DateDisplayFormat |
getDateFormatter()
Date formatter for displaying events.
|
java.util.Date |
getDateFromPoint()
Returns a Date instance representing the point at the passed offsets into the body of the current view.
|
java.util.Date |
getDateFromPoint(java.lang.Integer x) |
java.util.Date |
getDateFromPoint(java.lang.Integer x,
java.lang.Integer y) |
java.util.Date |
getDateFromPoint(java.lang.Integer x,
java.lang.Integer y,
java.lang.Boolean snapOffsets) |
java.util.Date |
getDateFromPoint(java.lang.Integer x,
java.lang.Integer y,
java.lang.Boolean snapOffsets,
CalendarView view)
Returns a Date instance representing the point at the passed offsets into the body of the current view.
|
java.lang.String |
getDateHeaderTitle(java.util.Date date,
int dayOfWeek,
java.lang.String defaultValue,
CalendarView view)
Return the title text to display in the header-button of the ListGridField showing the passed date, in the passed view.
|
java.lang.String |
getDateHTML(java.util.Date date,
java.lang.Integer rowNum,
java.lang.Integer colNum,
CalendarView view)
Return the HTML to be displayed in the associated date-cell in the passed view.
|
Label |
getDateLabel()
The
com.smartgwt.client.types.AutoChild Label used to display the current
date or range above the selected calendar view. |
java.lang.String |
getDateLabelText(java.lang.String viewName,
java.util.Date startDate,
java.util.Date endDate)
Returns the text to display with the navigation buttons above the Calendar - indicates the visible date range.
|
ImgButton |
getDatePickerButton()
An
ImgButton that appears above the various views of the calendar and
offers alternative access to a DateChooser to pick the current day. |
java.lang.String |
getDatePickerHoverText()
The text to be displayed when a user hovers over the
date picker toolbar button |
java.lang.String |
getDateStyle(java.util.Date date,
java.lang.Integer rowNum,
java.lang.Integer colNum,
CalendarView view)
Return the CSS styleName for the associated date-cell in the passed view.
|
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)
Return the HTML to be shown in the body of a day in the month view.
|
java.lang.String |
getDayHeaderBaseStyle()
The base name for the CSS class applied to the day headers of the month view.
|
CalendarView |
getDayView()
CalendarView used to display events that pertain to a given day. |
java.lang.String |
getDayViewTitle()
The title for the
day view . |
java.lang.Boolean |
getDeepCloneOnEdit()
Before we start editing values in this DataBoundComponent, should we perform a deep clone
of the underlying values.
|
int |
getDefaultTimelineColumnSpan()
The number of columns of the
timelineGranularity to give the timeline by default if no endDate is provided. |
java.lang.String |
getDescriptionField()
The name of the description field on a
CalendarEvent . |
java.lang.String |
getDetailsButtonTitle()
The title for the edit button in the quick
quick
event dialog . |
java.lang.Boolean |
getDisableWeekends()
If true, weekend days appear in a disabled style and events cannot be created on weekends.
|
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 |
getDragHoverHTML(CalendarView view,
CalendarEvent event,
java.lang.String defaultValue)
Returns the HTML to show in a hover when an existing event is dragged, or when a new event is being created by dragging
with the mouse.
|
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
Smart GWT 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 |
getDurationField()
The name of the
duration field on a CalendarEvent . |
java.lang.String |
getDurationUnitField()
The name of the
durationUnit field on a
CalendarEvent . |
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.util.Date |
getEndDate()
The end date of the calendar timeline view.
|
java.lang.String |
getEndDateField()
The name of the end date field on a
CalendarEvent . |
java.lang.Boolean |
getEventAutoArrange()
If set to true, enables the auto-arrangement of events that share time in the calendar.
|
java.lang.String |
getEventBodyHTML(CalendarEvent event)
Returns the description text for the passed event, for display in the body area of an event canvas.
|
java.lang.String |
getEventBodyHTML(CalendarEvent event,
CalendarView view)
Returns the description text for the passed event, for display in the body area of an event canvas.
|
EventCanvas |
getEventCanvas()
Note : This API is non-functional (always returns null) and exists only to make
you aware that this MultiAutoChild exists.
|
HLayout |
getEventCanvasButtonLayout()
|
ImgButton |
getEventCanvasCloseButton()
The close button that snaps to the top-right of an event canvas on rollover and allows an event to be removed from a
CalendarView . |
ImgButton |
getEventCanvasContextButton()
The context button that snaps to the top-right of an event canvas on rollover and shows a custom
context menu when clicked. |
Menu |
getEventCanvasContextMenu()
Context menu displayed when an
event canvas is right-clicked,
or when the rollover context button is
clicked. |
Img |
getEventCanvasGripper()
Note : This API is non-functional (always returns null) and exists only to make
you aware that this MultiAutoChild exists.
|
Img |
getEventCanvasHResizer()
Note : This API is non-functional (always returns null) and exists only to make
you aware that this MultiAutoChild exists.
|
Label |
getEventCanvasLabel()
Note : This API is non-functional (always returns null) and exists only to make
you aware that this MultiAutoChild exists.
|
MenuItem[] |
getEventCanvasMenuItems(EventCanvas canvas)
If this method returns a value, it is expected to return an array of
items applicable to the passed canvas and its event. |
java.lang.String |
getEventCanvasStyle(CalendarEvent event)
|
java.lang.String |
getEventCanvasStyle(CalendarEvent event,
CalendarView view)
|
Img |
getEventCanvasVResizer()
Note : This API is non-functional (always returns null) and exists only to make
you aware that this MultiAutoChild exists.
|
java.lang.String |
getEventDescriptionFieldTitle()
|
Window |
getEventDialog()
An
com.smartgwt.client.types.AutoChild of type Window that displays a quick
event entry form in a popup window. |
java.lang.Integer |
getEventDragGap()
The number of pixels to leave to the right of events so overlapping events can still be added using the mouse.
|
java.lang.String |
getEventDurationFieldTitle()
|
java.lang.String |
getEventDurationUnitFieldTitle()
|
DynamicForm |
getEventEditor()
|
HLayout |
getEventEditorButtonLayout()
An
com.smartgwt.client.types.AutoChild of type HLayout which houses
the Save , Remove and Cancel buttons in the eventEditor . |
Window |
getEventEditorLayout()
|
java.util.Date |
getEventEndDate(CalendarEvent event)
Returns the
end date of the passed event. |
java.lang.String |
getEventEndDateFieldTitle()
|
int |
getEventHeaderHeight()
When
eventHeaderWrap is false and showEventDescriptions is true, this is the fixed
height for the header area in event canvases. |
java.lang.String |
getEventHeaderHTML(CalendarEvent event)
Returns the title text for the passed event, which is displayed in the header area of an eventCanvas rendered in a
vertical or horizontal view, or as a clickable link in a cell in a
Month view . |
java.lang.String |
getEventHeaderHTML(CalendarEvent event,
CalendarView view)
Returns the title text for the passed event, which is displayed in the header area of an eventCanvas rendered in a
vertical or horizontal view, or as a clickable link in a cell in a
Month view . |
boolean |
getEventHeaderWrap()
When rendering the
canvas for an event, whether to
allow the content of the header area to wrap to
multiple lines. |
java.lang.String |
getEventHoverHTML(CalendarEvent event,
EventCanvas eventCanvas,
CalendarView view)
Gets the hover HTML for an event being hovered over.
|
java.lang.String |
getEventHoverHTML(CalendarEvent event,
EventCanvas eventCanvas,
CalendarView view,
java.lang.String defaultValue)
Gets the hover HTML for an event being hovered over.
|
Lane |
getEventLane(CalendarEvent event)
Returns the
lane associated with the passed event, in the passed view |
Lane |
getEventLane(CalendarEvent event,
CalendarView view)
Returns the
lane associated with the passed event, in the passed view |
java.lang.String |
getEventLaneFieldTitle()
|
void |
getEventLength(CalendarEvent event)
|
void |
getEventLength(CalendarEvent event,
TimeUnit unit)
|
java.lang.String |
getEventNameFieldTitle()
|
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.
|
java.lang.Integer |
getEventSnapGap()
The number of minutes that determines the positions to which events will snap when rendered, and when moved or resized
with the mouse.
|
java.util.Date |
getEventStartDate(CalendarEvent event)
Returns the
start date of the passed event. |
java.lang.String |
getEventStartDateFieldTitle()
|
java.lang.String |
getEventStyleName()
The base name for the CSS class applied to
events
when they're rendered in calendar views. |
java.lang.String |
getEventStyleNameField()
The name of the field used to override
eventStyleName for an individual CalendarEvent.styleName . |
Lane |
getEventSublane(CalendarEvent event)
Returns the
sublane associated with the passed event, in
the passed view |
Lane |
getEventSublane(CalendarEvent event,
CalendarView view)
Returns the
sublane associated with the passed event, in
the passed view |
java.lang.String |
getEventSublaneFieldTitle()
|
EventWindow |
getEventWindow()
Deprecated.
in favor of
eventCanvas |
java.lang.String |
getEventWindowStyle()
Deprecated.
in favor of
eventStyleName |
java.lang.String |
getEventWindowStyleField()
Deprecated.
in favor of
eventStyleNameField |
java.lang.Boolean |
getExportAll()
Setting exportAll to true prevents the component from passing its list of fields to the
export call.
|
java.lang.String[] |
getExportFields()
The list of field-names to export.
|
java.lang.Boolean |
getExportIncludeSummaries()
If Summary rows exist for this component, whether to include them when exporting client data.
|
java.lang.String |
getFetchOperation()
Operation ID this component should use when performing fetch operations.
|
Alignment[] |
getFieldAlignments()
Returna an array of field alignments for this grid
|
int |
getFieldCount()
Return the number of fields.
|
com.google.gwt.core.client.JavaScriptObject[] |
getFieldsAsJavaScriptObjects()
Return the fields as JavaScriptObjects rather than as SmartGWT Java wrappers of the field
class type
(e.g.
|
java.lang.Integer |
getFirstDayOfWeek()
The numeric day (0-6, Sunday-Saturday) which the calendar should consider as the first day of the week in multi-day
views, and in the popup
DateChooser . |
java.lang.String |
getHeaderHoverHTML(CalendarView view,
HeaderLevel headerLevel,
java.util.Date startDate,
java.util.Date endDate,
java.lang.String defaultValue)
Returns the hover HTML to show in a hover when the mouse moves over the header area.
|
HeaderLevel[] |
getHeaderLevels()
Configures the levels of
headers shown above the event area,
and their time units. |
java.lang.Boolean |
getHideUnusedLanes()
When set to true, hides any
lane that doesn't have any
active events in the current dataset. |
java.lang.String |
getHiliteProperty()
Marker that can be set on a record to flag that record as hilited.
|
Hilite[] |
getHilites()
Return the set of hilite-objects currently applied to this DataBoundComponent.
|
java.lang.String |
getHiliteState()
Get the current hilites encoded as a String, for saving.
|
Criteria |
getImplicitCriteria()
Criteria that are never shown to or edited by the user and are cumulative with any
criteria provided via
DataBoundComponent.initialCriteria ,
DataBoundComponent.setCriteria() etc. |
IndicatorCanvas |
getIndicatorCanvas()
Note : This API is non-functional (always returns null) and exists only to make
you aware that this MultiAutoChild exists.
|
java.lang.String |
getIndicatorCanvasStyle(CalendarEvent indicator)
|
java.lang.String |
getIndicatorCanvasStyle(CalendarEvent indicator,
CalendarView view)
|
java.lang.String |
getIndicatorHoverHTML(CalendarEvent indicator,
IndicatorCanvas indicatorCanvas,
CalendarView view,
java.lang.String defaultValue)
Gets the hover HTML for an
indicator being hovered
over. |
CalendarEvent[] |
getIndicators()
An array of CalendarEvent instances representing instants in time, to be highlighted in
timeline views . |
java.lang.String |
getIndicatorStyleName()
|
Criteria |
getInitialCriteria()
Criteria to use when
DataBoundComponent.setAutoFetchData(Boolean) is used. |
java.lang.String |
getInvalidDateMessage()
The message to display in the
eventEditor when the
'To' date is greater than the 'From' date and a save is attempted. |
Lane |
getLane(java.lang.String lane)
Returns the
lane with the passed name, in the passed view |
Lane |
getLane(java.lang.String lane,
CalendarView view)
Returns the
lane with the passed name, in the passed view |
java.lang.Integer |
getLaneEventPadding()
|
CalendarEvent[] |
getLaneEvents(Lane lane)
For views that support
lanes , returns the array of events
in the current dataset that apply to the passed lane in the passed or current view. |
CalendarEvent[] |
getLaneEvents(Lane lane,
CalendarView view)
For views that support
lanes , returns the array of events
in the current dataset that apply to the passed lane in the passed or current view. |
CalendarEvent[] |
getLaneEvents(java.lang.String lane)
For views that support
lanes , returns the array of events
in the current dataset that apply to the passed lane in the passed or current view. |
ListGridField[] |
getLaneFields()
Field definitions for the frozen area of the
timelineView , which shows data about the timeline lanes . |
Lane |
getLaneFromPoint()
Returns the
Lane at the passed co-ordinates. |
Lane |
getLaneFromPoint(java.lang.Integer x) |
Lane |
getLaneFromPoint(java.lang.Integer x,
java.lang.Integer y) |
Lane |
getLaneFromPoint(java.lang.Integer x,
java.lang.Integer y,
CalendarView view)
Returns the
Lane at the passed co-ordinates. |
java.lang.String |
getLaneGroupByField()
For timelines with
canGroupLanes set to true,
this is a field name or array of field names on which to group the lanes in a timeline. |
java.lang.String[] |
getLaneGroupByFieldAsString()
Deprecated.
in favor of
getLaneGroupByFieldAsStringArray() . |
java.lang.String[] |
getLaneGroupByFieldAsStringArray()
For timelines with
canGroupLanes set to true,
this is a field name or array of field names on which to group the lanes in a timeline. |
java.lang.String |
getLaneNameField()
The name of the field which will determine the
lane in
which this event will be displayed in Timeline s and in the day view , if showDayLanes is true. |
java.lang.Integer |
getLanePadding()
For views that support
lanes , returns the padding to
apply to events rendered in lanes in the passed or current view. |
java.lang.Integer |
getLanePadding(CalendarView view)
For views that support
lanes , returns the padding to
apply to events rendered in lanes in the passed or current view. |
Lane[] |
getLanes()
An array of
Lane definitions that represent the rows of the timelineView , or the columns of the dayView if showDayLanes is true. |
java.lang.String |
getLeadingDateField()
The name of the leading date field for each event.
|
com.smartgwt.logicalstructure.core.LogicalStructureObject |
getLogicalStructure()
Getter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
TabSet |
getMainView()
|
boolean |
getMinimalUI()
A boolean value controlling whether the Calendar shows tabs for available calendar views.
|
java.lang.Integer |
getMinimumDayHeight()
In the
month view when showDayHeaders is true, this is the minimum height
applied to a day cell and its header combined. |
java.lang.Integer |
getMinLaneWidth()
When showing
vertical lanes in the dayView , this attribute sets the minimum width of each column
or field. |
java.lang.Integer |
getMinutesPerRow()
|
NavigationButton |
getMonthButton()
A
NavigationButton that appears to the left of other navigation controls in the
controls bar on Handset devices. |
java.lang.String |
getMonthButtonTitle()
The title of the
month button , used for showing and
hiding the month view on Handsets. |
java.lang.String |
getMonthMoreEventsLinkTitle()
The title of the link shown in a cell of a
month view
when there are too many events to be displayed at once. |
Menu |
getMonthMoreEventsMenu()
AutoChild Menu, shown when a user clicks the
more events link in a cell of the monthView . |
CalendarView |
getMonthView()
CalendarView used to display events that pertain to a given month. |
java.lang.String |
getMonthViewHoverHTML(java.util.Date date,
CalendarEvent... events)
This method returns the hover HTML to be displayed when the user hovers over a cell displayed in the calendar month view
tab.
|
java.lang.String |
getMonthViewTitle()
The title for the
month view . |
java.lang.String |
getNameField()
The name of the name field on a
CalendarEvent . |
ImgButton |
getNextButton()
An
ImgButton that appears above the week/day/month views of the calendar and allows
the user to move the calendar forwards in time. |
java.lang.String |
getNextButtonHoverText()
The text to be displayed when a user hovers over the
next toolbar button |
static Calendar |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
java.lang.String |
getOtherDayBlankStyle()
The CSS style applied to both the header and body of days from other months in the
month view , 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.
|
SortSpecifier[] |
getOverlapSortSpecifiers()
A set of
sort-specifiers for customizing the render order of events that
overlap. |
java.util.Date |
getPeriodEndDate()
Returns the end of the period selected in the passed, or current, calendar view.
|
java.util.Date |
getPeriodEndDate(CalendarView view)
Returns the end of the period selected in the passed, or current, calendar view.
|
java.util.Date |
getPeriodStartDate()
Returns the start of the selected week or month depending on the current calendar view.
|
java.util.Date |
getPeriodStartDate(CalendarView view)
Returns the start of the selected week or month depending on the current calendar view.
|
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) . |
ImgButton |
getPreviousButton()
An
ImgButton that appears above the week/day/month views of the calendar and allows
the user to move the calendar backwards in time. |
java.lang.String |
getPreviousButtonHoverText()
The text to be displayed when a user hovers over the
previous toolbar button. |
java.lang.Boolean |
getProgressiveLoading()
Indicates whether or not this component will load its data
progressively |
int |
getRecordIndex(Record record)
Get the index of the provided record.
|
RecordList |
getRecordList()
Return the underlying data of this DataBoundComponent as a
RecordList . |
IButton |
getRemoveButton()
An
com.smartgwt.client.types.AutoChild of type IButton , used to permanently
remove an event from the eventEditor . |
java.lang.String |
getRemoveButtonTitle()
The title for the
Remove button in the event editor . |
java.lang.String |
getRemoveOperation()
operationId this component
should use when performing remove operations. |
boolean |
getRenderEventsOnDemand()
When set to true, the default, each
event is rendered as it
appears in the viewport. |
ResultSet |
getResultSet()
Return the underlying data of this DataBoundComponent as a
ResultSet . |
int |
getRowHeight()
The height of time-slots in the calendar.
|
java.lang.Integer |
getRowTitleFrequency()
|
IButton |
getSaveButton()
|
java.lang.String |
getSaveButtonTitle()
|
java.lang.Boolean |
getScrollToWorkday()
If set, causes the
workday hours 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.Boolean |
getSelectChosenDate()
When true, shows the current
chosenDate in a
selected style in the month view Has no effect in
other views. |
java.lang.String |
getSelectedCellStyle()
The base name for the CSS class applied to a cell that is selected via a mouse drag.
|
CalendarEvent |
getSelectedEvent()
Returns the currently selected
event , or the first one if
more than one is selected. |
CalendarEvent[] |
getSelectedEvents()
Returns the currently selected list of
events . |
CalendarView |
getSelectedView()
Returns the currently selected
view . |
java.lang.Boolean |
getShowAddEventButton()
Set to false to hide the
Add Event button. |
java.lang.Boolean |
getShowCellHovers()
When
showViewHovers is true, dictates whether to
display hover prompts when the mouse rolls over the normal cells in the body of CalendarViews. |
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 |
getShowControlsBar()
If false the controls bar at the top of the calendar will not be displayed - this means that the
controlsBar will be hidden, so the autoChildren (previousButton , dateLabel , nextButton , addEventButton , and datePickerButton ) will not be created or shown. |
java.lang.Boolean |
getShowDateChooser()
Determines whether the
dateChooser is displayed. |
java.lang.Boolean |
getShowDatePickerButton()
Set to false to hide the
datePickerButton that
allows selecting a new base date for this Calendar. |
java.lang.Boolean |
getShowDayHeaders()
If true, the default, show a header cell for each day cell in the
month view , with both cells having a minimum combined height
of minimumDayHeight . |
java.lang.Boolean |
getShowDayLanes()
|
java.lang.Boolean |
getShowDayView()
Whether to show the Day view.
|
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 |
getShowDragHovers()
When
showViewHovers is true, dictates whether to
display hover prompts when an event is being dragged with the mouse. |
boolean |
getShowEventDescriptions()
When rendering the
canvas for an event, whether to
show the body area , typically containing brief
details of the event - by default , its description . |
boolean |
getShowEventHeaders()
When rendering the
canvas for an event, whether to
show the header area , typically containing
suitable title text - by default , the event's
name . |
java.lang.Boolean |
getShowEventHovers()
When
showViewHovers is true, dictates whether to
display hover prompts when the mouse moves over an event canvas
in a calendarView. |
java.lang.Boolean |
getShowHeaderHovers()
When
showViewHovers is true, dictates whether to
display hover prompts when the mouse rolls over the header levels in a CalendarView . |
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 |
getShowIndicators()
Set to true to render any defined
indicators into
timeline views . |
boolean |
getShowIndicatorsInFront()
In
indicator lines are showing, this attribute
affects where in the z-order their canvases will be rendered: either in front of, or behind normal calendar events. |
boolean |
getShowLabelColumn()
When set to false, hides the frozen Label-Column in vertical
CalendarView s. |
java.lang.Boolean |
getShowLaneFieldHovers()
When
showViewHovers is true, dictates whether to
display hover prompts when the mouse moves over the cells in a laneField . |
java.lang.Boolean |
getShowLaneRollOver()
When set to true, causes
Timelines , and day views with showDayLanes set, to highlight the Lane under the mouse
with the "Over" style. |
java.lang.Boolean |
getShowMonthButton()
Set to false to prevent the
Month button from
displaying on Handset devices. |
java.lang.Boolean |
getShowMonthView()
Whether to show the Month view.
|
java.lang.Boolean |
getShowNextButton()
Set to false to hide the
Next button. |
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 |
getShowPreviousButton()
Set to false to hide the
Previous button. |
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 |
getShowViewHovers()
When set to true, the default value, causes the Calendar to show customizable hovers when the mouse moves over various
areas of a CalendarView.
|
java.lang.Boolean |
getShowWeekends()
|
java.lang.Boolean |
getShowWeekView()
Whether to show the Week view.
|
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.Boolean |
getShowZoneHovers()
When
showViewHovers is true, dictates whether to
display hover prompts when the mouse moves over a zone in
a calendarView. |
java.lang.Boolean |
getShowZones()
Set to true to render any defined
zones into timeline views . |
java.lang.Boolean |
getSizeEventsToGrid()
If true, events will be sized to the grid, even if they start and/or end at times between grid cells.
|
java.util.Date |
getStartDate()
The start date of the calendar
timeline view . |
java.lang.String |
getStartDateField()
The name of the start date field on a
CalendarEvent . |
Lane |
getSublane(java.lang.String lane,
java.lang.String sublane)
|
Lane |
getSublane(java.lang.String lane,
java.lang.String sublane,
CalendarView view)
|
CalendarEvent[] |
getSublaneEvents(Lane lane,
Lane sublane)
|
CalendarEvent[] |
getSublaneEvents(Lane lane,
Lane sublane,
CalendarView view)
|
Lane |
getSublaneFromPoint()
Returns the
sublane at the passed co-ordinates. |
Lane |
getSublaneFromPoint(java.lang.Integer x) |
Lane |
getSublaneFromPoint(java.lang.Integer x,
java.lang.Integer y) |
Lane |
getSublaneFromPoint(java.lang.Integer x,
java.lang.Integer y,
CalendarView view)
Returns the
sublane at the passed co-ordinates. |
java.lang.String |
getSublaneNameField()
The name of the field which will determine the
sublane in
which this event will be displayed, within its parent Lane, in Timeline s
and in the day view , if showDayLanes is true. |
TimeDisplayFormat |
getTimeFormatter()
Display format to use for the time portion of events' date information.
|
TimeUnit |
getTimelineGranularity()
The granularity in which the
timelineView will
display events. |
int |
getTimelineUnitsPerColumn()
How many units of
timelineGranularity each
cell represents. |
CalendarView |
getTimelineView()
CalendarView used to display events in lanes in a horizontal Timeline view. |
java.lang.String |
getTimelineViewTitle()
The title for the
timeline view . |
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
components.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 |
getTodayBackgroundColor()
The background color for cells that represent today in all
CalendarView s. |
java.lang.String |
getTrailingDateField()
The name of the trailing date field for each event.
|
java.lang.Boolean |
getTwentyFourHourTime()
Dictates whether times throughout the widget are formatted and edited as 24-hour values.
|
java.lang.String |
getUpdateOperation()
operationId 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.
|
boolean |
getUseEventCanvasRolloverControls()
By default, the
close buttons and the
horizontal and vertical resizer widgets for event canvases are
shown only when the mouse is over a given event. |
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 |
getUseSublanes()
|
CalendarView |
getView(ViewName viewName)
|
java.util.Date |
getVisibleEndDate()
Returns the last visible date in the passed, or currently selected, calendar view.
|
java.util.Date |
getVisibleEndDate(CalendarView view)
Returns the last visible date in the passed, or currently selected, calendar view.
|
java.util.Date |
getVisibleStartDate()
Returns the first visible date in the passed, or currently selected, calendar view.
|
java.util.Date |
getVisibleStartDate(CalendarView view)
Returns the first visible date in the passed, or currently selected, calendar view.
|
int[] |
getWeekendDays()
An array of integer day-numbers that should be considered to be weekend days by this Calendar instance.
|
java.lang.Boolean |
getWeekEventBorderOverlap()
Augments the width of week event windows slightly to avoid duplicate adjacent borders between events.
|
java.lang.String |
getWeekPrefix()
The text to appear before the week number in the title of
week-based HeaderLevel s when this calendar is showing a timeline. |
CalendarView |
getWeekView()
CalendarView used to display events that pertain to a given week. |
java.lang.String |
getWeekViewTitle()
The title for the
week view . |
java.lang.String |
getWorkdayBaseStyle()
If
showWorkday is set, this is the style used for
cells that are within the workday, as defined by workdayStart and workdayEnd , or by a date-specific
range provided in getWorkdayStart() and getWorkdayEnd() implementations. |
java.lang.String |
getWorkdayEnd(java.util.Date date)
When using
showWorkday :true,
workdayStart and workdayEnd specify the time of day when the workday starts and ends,
specified as a String acceptable to String. |
java.lang.String |
getWorkdayStart(java.util.Date date)
When using
showWorkday :true,
workdayStart and workdayEnd specify the time of day when the workday starts and ends,
specified as a String acceptable to String. |
ZoneCanvas |
getZoneCanvas()
Note : This API is non-functional (always returns null) and exists only to make
you aware that this MultiAutoChild exists.
|
java.lang.String |
getZoneCanvasStyle(CalendarEvent zone)
|
java.lang.String |
getZoneCanvasStyle(CalendarEvent zone,
CalendarView view)
|
java.lang.String |
getZoneHoverHTML(CalendarEvent zone,
ZoneCanvas zoneCanvas,
CalendarView view,
java.lang.String defaultValue)
Gets the hover HTML for a
zone being hovered over. |
CalendarEvent[] |
getZones()
An array of CalendarEvent instances representing pre-defined periods of time to be highlighted in
timeline views . |
java.lang.String |
getZoneStyleName()
|
VerticalAlignment |
getZoneTitleOrientation()
The vertical alignment of the header-text in each
zone . |
void |
groupLanesBy(java.lang.String... groupFieldName)
When
canGroupLanes is true, this method allows
the grouping in timeline s to be altered at
runtime. |
void |
groupLanesBy(java.lang.String groupFieldName)
When
canGroupLanes is true, this method allows
the grouping in timeline s to be altered at
runtime. |
void |
invalidateCache()
Invalidate the current data cache for this databound component via a call to the dataset's
invalidateCache() method, for example,
ResultSet.invalidateCache() . |
void |
moveToEvent(CalendarEvent event)
Deprecated.
in favor of
scrollToEvent() . |
void |
next()
Move to the next day, week, or month, depending on which tab is selected.
|
protected void |
onInit_Calendar() |
protected void |
onInit() |
void |
previous()
Move to the previous day, week, month, or timeline range depending on which tab is selected.
|
void |
refreshEvent(CalendarEvent event)
Refreshes the passed event in the current view.
|
void |
removeEvent(CalendarEvent event)
Remove an event from this calendar.
|
void |
removeIndicator(CalendarEvent indicator)
Removes a
indicator from the calendar. |
void |
removeIndicator(java.lang.String indicator)
Removes a
indicator from the calendar. |
void |
removeLane(Lane lane)
Removes a lane from the calendar in
timelineView
mode. |
void |
removeLane(java.lang.String laneName)
Removes a lane from the calendar in
timelineView
mode. |
void |
removeZone(CalendarEvent zone)
Removes a
zone from the calendar. |
void |
removeZone(java.lang.String zone)
Removes a
zone from the calendar. |
void |
scrollToEnd()
Move the viewport of a CalendarView to the end of its scrollable range.
|
void |
scrollToEnd(CalendarView view)
Move the viewport of a CalendarView to the end of its scrollable range.
|
void |
scrollToEvent(CalendarEvent event)
Scrolls the
current view so the passed event is
visible. |
void |
scrollToEvent(CalendarEvent event,
boolean canReload)
Scrolls the
current view so the passed event is
visible. |
void |
scrollToStart()
Move the viewport of a CalendarView to the start of it's scrollable range.
|
void |
scrollToStart(CalendarView view)
Move the viewport of a CalendarView to the start of it's scrollable range.
|
void |
scrollToTime(java.lang.String time)
|
void |
selectAllRecords()
Select all records
|
java.lang.Boolean |
selectEvent(CalendarEvent event)
Adds an event to the list of selected events in the current view, showing it in a selected style.
|
java.lang.Boolean |
selectEvents(CalendarEvent... events)
Adds one or more events to the list of selected events in the current view, showing them in a selected style.
|
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
Record s passed in explicitly, or by index. |
void |
selectRecords(int[] records,
boolean newState)
Select/deselect a list of
Record s passed in explicitly, or by index. |
void |
selectRecords(Record[] records)
Select/deselect a list of
Record s passed in explicitly, or by index. |
void |
selectRecords(Record[] records,
boolean newState)
Select/deselect a list of
Record s passed in explicitly, or by index. |
java.lang.Boolean |
selectSingleEvent(CalendarEvent event)
Selects a single event in the current view, showing it in a selected style and deselecting any other selected events.
|
void |
selectTab(int tabnum)
Selects the calendar view in the passed tab number.
|
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 |
setAddEventButtonHoverText(java.lang.String addEventButtonHoverText)
The text to be displayed when a user hovers over the
add event toolbar button |
void |
setAddFormulaFieldText(java.lang.String addFormulaFieldText)
Text for a menu item allowing users to add a formula field
|
void |
setAddOperation(java.lang.String addOperation)
operationId 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 |
setAllowDurationEvents(java.lang.Boolean allowDurationEvents)
When set to true, allows events to be managed by duration, as well as by end date.
|
void |
setAlternateLaneStyles(java.lang.Boolean alternateLaneStyles)
When showing a
Timeline , or a day view when showDayLanes is true, whether to make lane boundaries
more obvious by showing alternate lanes in a different color. |
void |
setAlwaysShowEventHovers(java.lang.Boolean alwaysShowEventHovers)
By default, EventCanvases show their content in hovers, and will only show a hover if the content is clipped.
|
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 |
setAutoFetchTextMatchStyle(TextMatchStyle autoFetchTextMatchStyle)
If
autoFetchData is true , this attribute allows the developer to specify a textMatchStyle
for the initial DataBoundComponent.fetchData() call. |
void |
setBackButtonTitle(java.lang.String backButtonTitle)
The title of the
month on Handsets when the month view is the current visible view. |
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 |
setBringEventsToFront(java.lang.Boolean bringEventsToFront)
If set to true, clicking an event will bring it to the front of the zorder.
|
void |
setCalMonthEventLinkStyle(java.lang.String calMonthEventLinkStyle)
The base name for the CSS class applied to the links rendered by
getDayBodyHTML() . |
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 |
setCancelButtonTitle(java.lang.String cancelButtonTitle)
The title for the
Cancel button in the event editor . |
void |
setCanCreateEvents(java.lang.Boolean canCreateEvents)
If true, users can create new events.
|
void |
setCanDeleteEvents(java.lang.Boolean canDeleteEvents)
Deprecated.
in favor of
canRemoveEvents |
void |
setCanDragCreateEvents(java.lang.Boolean canDragCreateEvents)
A boolean value controlling whether new events of varying length can be created by dragging the cursor.
|
void |
setCanDragEventField(java.lang.String canDragEventField)
Name of the field on each
CalendarEvent that determines whether an EventCanvas can be moved or resized by dragging with the mouse. |
void |
setCanDragEvents(java.lang.Boolean canDragEvents)
A boolean value controlling whether users can drag-reposition 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 whether it can be
edited in the event editor . |
void |
setCanEditLane(java.lang.Boolean canEditLane)
Can events be moved between lanes? If so, the event can be dragged to a different
lane , and the event quick dialog and editor allow a lane to be selected with a drop-down
chooser. |
void |
setCanEditLaneField(java.lang.String canEditLaneField)
Name of the field on each
CalendarEvent that determines whether that event
can be moved between lanes. |
void |
setCanEditSublane(java.lang.Boolean canEditSublane)
Can events be moved between sublanes?
|
void |
setCanEditSublaneField(java.lang.String canEditSublaneField)
Name of the field on each
CalendarEvent that determines whether that event
can be moved between individual sublanes in a Lane . |
void |
setCanGroupLanes(java.lang.Boolean canGroupLanes)
If true, allows the lanes in a Timeline to be grouped by providing a value for
laneGroupByField . |
void |
setCanRemoveEvents(java.lang.Boolean canRemoveEvents)
If true, users can remove existing events.
|
void |
setCanRemoveField(java.lang.String canRemoveField)
Name of the field on each
CalendarEvent that determines whether an event
shows a remove button. |
void |
setCanReorderLanes(java.lang.Boolean canReorderLanes)
If true, lanes can be reordered by dragging their
laneFields with the mouse. |
void |
setCanResizeEventField(java.lang.String canResizeEventField)
Name of the field on each
CalendarEvent that determines whether an event
can be resized by dragging. |
void |
setCanResizeEvents(java.lang.Boolean canResizeEvents)
Can
events be resized by dragging appropriate edges of the
canvas ? Only has an effect when both canEditEvents and canDragEvents are true. |
void |
setCanResizeTimelineEvents(java.lang.Boolean canResizeTimelineEvents)
Deprecated.
in favor of
canResizeEvents ; |
void |
setCanSelectEvents(java.lang.Boolean canSelectEvents)
When set to true, makes individual
event canvases selectable. |
void |
setCellHoverCustomizer(CellHoverCustomizer customizer)
Customize the Hover text to display when the mouse hovers over cells in a CalendarView
|
void |
setChosenDate(java.util.Date chosenDate)
The date for which events are displayed in the day, week, and month tabs of the calendar.
|
void |
setColumnsPerPage(java.lang.Integer columnsPerPage)
When using the Next and Previous arrows to scroll a Timeline, this is the number of columns of the
timelineGranularity to scroll by. |
void |
setCurrentViewName(ViewName currentViewName)
The name of the view that should be visible initially by default.
|
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 |
setData(RecordList data)
An List of Record objects, specifying the data to be used to populate the DataBoundComponent.
|
void |
setDataFetchMode(FetchMode dataFetchMode)
How to fetch and manage records retrieve from the server.
|
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
DataSource requests . |
void |
setDataSource(java.lang.String dataSource)
The DataSource that this component should bind to for default fields and for performing
DataSource requests . |
void |
setDateCellAlignCustomizer(DateCellAlignCustomizer customizer)
This method installs a customizer that returns the horizontsal Alignment to display in the passed date-cell when rendered in the passed view
|
void |
setDateCellVAlignCustomizer(DateCellVAlignCustomizer customizer)
This method installs a customizer that returns the VerticalAlignment to display in the passed date-cell when rendered in the passed view
|
void |
setDateCSSTextCustomizer(DateCSSTextCustomizer customizer)
This method returns the CSS class name for the passed event when rendered in the passed view
|
void |
setDateEditingStyle(DateEditingStyle dateEditingStyle)
Indicates the type of controls to use in event-windows.
|
void |
setDateFormatter(DateDisplayFormat dateFormatter)
Date formatter for displaying events.
|
void |
setDateHeaderCustomizer(DateHeaderCustomizer customizer)
This method installs a customizer to determine the HTML to be displayed in the header for a given date column in a CalendarView
|
void |
setDateHTMLCustomizer(DateHTMLCustomizer customizer)
This method installs a customizer that returns the HTML to display in the passed date-cell when rendered in the passed view
|
void |
setDatePickerHoverText(java.lang.String datePickerHoverText)
The text to be displayed when a user hovers over the
date picker toolbar button |
void |
setDateStyleCustomizer(DateStyleCustomizer customizer)
This method installs a customizer that returns the CSS class name for the passed date-cell when rendered in the passed view
|
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.
|
void |
setDayViewTitle(java.lang.String dayViewTitle)
The title for the
day view . |
void |
setDeepCloneOnEdit(java.lang.Boolean deepCloneOnEdit)
Before we start editing values in this DataBoundComponent, should we perform a deep clone
of the underlying values.
|
static void |
setDefaultProperties(Calendar calendarProperties)
Class level method to set the default properties of this class.
|
void |
setDefaultTimelineColumnSpan(int defaultTimelineColumnSpan)
The number of columns of the
timelineGranularity to give the timeline by default if no endDate is provided. |
void |
setDescriptionField(java.lang.String descriptionField)
The name of the description field on a
CalendarEvent . |
void |
setDetailsButtonTitle(java.lang.String detailsButtonTitle)
The title for the edit button in the quick
quick
event dialog . |
void |
setDisableDateCustomizer(DisableDateCustomizer customizer)
Return true from the customizer to have the passed event considered disabled in the passed view
|
void |
setDisableWeekends(java.lang.Boolean disableWeekends)
If true, weekend days appear in a disabled style and events cannot be created on weekends.
|
void |
setDragDataAction(DragDataAction dragDataAction)
Indicates what to do with data dragged into another DataBoundComponent.
|
void |
setDragDataCustomizer(DragDataCustomizer customizer)
During a drag-and-drop interaction, this method returns the set of records being dragged
out of the component.
|
void |
setDragHoverCustomizer(DragHoverCustomizer customizer)
Customize the Hover text to display during a drag operation
|
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
Smart GWT 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 |
setDurationField(java.lang.String durationField)
The name of the
duration field on a CalendarEvent . |
void |
setDurationUnitField(java.lang.String durationUnitField)
The name of the
durationUnit field on a
CalendarEvent . |
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 |
setEndDate(java.util.Date endDate)
The end date of the calendar timeline view.
|
void |
setEndDateField(java.lang.String endDateField)
The name of the end date field on 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 |
setEventBodyHTMLCustomizer(EventBodyHTMLCustomizer customizer)
This method installs a customizer that returns the HTML to be used as the body/description for the passed event.
|
void |
setEventCanvasGripperIconCustomizer(EventCanvasGripperIconCustomizer customizer)
This method returns the SCImgURL for the icon to use as the gripper for a given EventCanvas
|
void |
setEventCanvasHoverHTMLCustomizer(EventCanvasHoverHTMLCustomizer customizer)
This method returns the hover HTML to be displayed when the user hovers over an eventCanvas
|
void |
setEventDescriptionFieldTitle(java.lang.String eventDescriptionFieldTitle)
|
void |
setEventDialogCustomizer(EventDialogCustomizer customizer)
Customizer called whenever the Calender needs to show an EventDialog, to edit or view a CalendarEvent
|
void |
setEventDialogFields(FormItem... eventDialogFields)
The set of fields for the
eventDialog . |
void |
setEventDragGap(java.lang.Integer eventDragGap)
The number of pixels to leave to the right of events so overlapping events can still be added using the mouse.
|
void |
setEventDurationFieldTitle(java.lang.String eventDurationFieldTitle)
|
void |
setEventDurationUnitFieldTitle(java.lang.String eventDurationUnitFieldTitle)
|
void |
setEventEditorCustomizer(EventEditorCustomizer customizer)
Customizer called whenever the Calender needs to show an EventEditor, to edit or create a CalendarEvent
|
void |
setEventEditorFields(FormItem... eventEditorFields)
The set of fields for the
eventEditor . |
void |
setEventEndDateFieldTitle(java.lang.String eventEndDateFieldTitle)
|
void |
setEventHeaderHeight(int eventHeaderHeight)
When
eventHeaderWrap is false and showEventDescriptions is true, this is the fixed
height for the header area in event canvases. |
void |
setEventHeaderHTMLCustomizer(EventHeaderHTMLCustomizer customizer)
This method returns the HTML to be used as the header/title for the passed event.
|
void |
setEventHeaderWrap(boolean eventHeaderWrap)
When rendering the
canvas for an event, whether to
allow the content of the header area to wrap to
multiple lines. |
void |
setEventHoverHTMLCustomizer(EventHoverHTMLCustomizer eventHoverHTMLCustomizer)
This method returns the hover HTML to be displayed when the user hovers over an event
|
void |
setEventLaneFieldTitle(java.lang.String eventLaneFieldTitle)
|
void |
setEventNameFieldTitle(java.lang.String eventNameFieldTitle)
|
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(java.lang.Integer eventSnapGap)
The number of minutes that determines the positions to which events will snap when rendered, and when moved or resized
with the mouse.
|
void |
setEventStartDateFieldTitle(java.lang.String eventStartDateFieldTitle)
|
void |
setEventStyle(CalendarEvent event,
java.lang.String styleName)
Update the styleName for the passed event.
|
void |
setEventStyleName(java.lang.String eventStyleName)
The base name for the CSS class applied to
events
when they're rendered in calendar views. |
void |
setEventStyleNameField(java.lang.String eventStyleNameField)
The name of the field used to override
eventStyleName for an individual CalendarEvent.styleName . |
void |
setEventSublaneFieldTitle(java.lang.String eventSublaneFieldTitle)
|
void |
setEventWindowStyle(java.lang.String eventWindowStyle)
Deprecated.
in favor of
eventStyleName |
void |
setEventWindowStyleField(java.lang.String eventWindowStyleField)
Deprecated.
in favor of
eventStyleNameField |
void |
setExportAll(java.lang.Boolean exportAll)
Setting exportAll to true prevents the component from passing its list of fields to the
export call.
|
void |
setExportFields(java.lang.String[] exportFields)
The list of field-names to export.
|
void |
setExportIncludeSummaries(java.lang.Boolean exportIncludeSummaries)
If Summary rows exist for this component, whether to include them when exporting client data.
|
void |
setFetchOperation(java.lang.String fetchOperation)
Operation ID this component should use when performing fetch operations.
|
void |
setFields(com.google.gwt.core.client.JavaScriptObject... fields)
Field setter variant (alternative to
setFields(FormItem...) ,
setFields(ListGridField...) ,
etc.) that will accept an array of JavaScriptObject, rather than an array of SmartGWT
Java wrappers of the field class type (e.g. |
void |
setFirstDayOfWeek(java.lang.Integer firstDayOfWeek)
The numeric day (0-6, Sunday-Saturday) which the calendar should consider as the first day of the week in multi-day
views, and in the popup
DateChooser . |
void |
setHeaderHoverCustomizer(HeaderLevelHoverCustomizer customizer)
Customize the Hover text for a given span in a HeaderLevel.
|
void |
setHeaderLevels(HeaderLevel... headerLevels)
Configures the levels of
headers shown above the event area,
and their time units. |
void |
setHideUnusedLanes(java.lang.Boolean hideUnusedLanes)
When set to true, hides any
lane that doesn't have any
active events in the current dataset. |
void |
setHiliteProperty(java.lang.String hiliteProperty)
Marker that can be set on a record to flag that record as hilited.
|
void |
setHilites(Hilite[] hilites)
Accepts an array of hilite objects and applies them to this DataBoundComponent.
|
void |
setHiliteState(java.lang.String hiliteState)
Set the current hilites based on a hiliteState String previously returned from getHilitesState.
|
void |
setImplicitCriteria(Criteria implicitCriteria)
Criteria that are never shown to or edited by the user and are cumulative with any
criteria provided via
DataBoundComponent.initialCriteria ,
DataBoundComponent.setCriteria() etc. |
void |
setIndicatorHoverHTMLCustomizer(IndicatorHoverHTMLCustomizer indicatorHoverHTMLCustomizer)
This method returns the hover HTML to be displayed when the user hovers over an IndicatorCanvas
|
void |
setIndicators(CalendarEvent... indicators)
An array of CalendarEvent instances representing instants in time, to be highlighted in
timeline views . |
void |
setIndicatorStyleName(java.lang.String indicatorStyleName)
|
void |
setInitialCriteria(Criteria initialCriteria)
Criteria to use when
DataBoundComponent.setAutoFetchData(Boolean) is used. |
void |
setInvalidDateMessage(java.lang.String invalidDateMessage)
The message to display in the
eventEditor when the
'To' date is greater than the 'From' date and a save is attempted. |
void |
setLaneEventPadding(java.lang.Integer laneEventPadding)
|
void |
setLaneFields(ListGridField... laneFields)
Field definitions for the frozen area of the
timelineView , which shows data about the timeline lanes . |
void |
setLaneGroupByField(java.lang.String... laneGroupByField)
For timelines with
canGroupLanes set to true,
this is a field name or array of field names on which to group the lanes in a timeline. |
void |
setLaneGroupByField(java.lang.String laneGroupByField)
For timelines with
canGroupLanes set to true,
this is a field name or array of field names on which to group the lanes in a timeline. |
void |
setLaneGroupStartOpen(GroupStartOpen group) |
void |
setLaneGroupStartOpen(java.lang.Object... groupValues) |
void |
setLaneNameField(java.lang.String laneNameField)
The name of the field which will determine the
lane in
which this event will be displayed in Timeline s and in the day view , if showDayLanes is true. |
void |
setLanes(Lane... lanes)
An array of
Lane definitions that represent the rows of the timelineView , or the columns of the dayView if showDayLanes is true. |
void |
setLeadingDateField(java.lang.String leadingDateField)
The name of the leading date field for each event.
|
com.smartgwt.logicalstructure.core.LogicalStructureObject |
setLogicalStructure(com.smartgwt.logicalstructure.widgets.calendar.CalendarLogicalStructure s)
Setter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
void |
setMinimalUI(boolean minimalUI)
A boolean value controlling whether the Calendar shows tabs for available calendar views.
|
void |
setMinimumDayHeight(java.lang.Integer minimumDayHeight)
In the
month view when showDayHeaders is true, this is the minimum height
applied to a day cell and its header combined. |
void |
setMinLaneWidth(java.lang.Integer minLaneWidth)
When showing
vertical lanes in the dayView , this attribute sets the minimum width of each column
or field. |
void |
setMinutesPerRow(java.lang.Integer minutesPerRow)
|
void |
setMonthButtonTitle(java.lang.String monthButtonTitle)
The title of the
month button , used for showing and
hiding the month view on Handsets. |
void |
setMonthMoreEventsLinkTitle(java.lang.String monthMoreEventsLinkTitle)
The title of the link shown in a cell of a
month view
when there are too many events to be displayed at once. |
void |
setMonthViewHoverHTMLCustomizer(MonthViewHoverHTMLCustomizer monthViewHoverHTMLCustomizer)
This method returns the hover HTML to be displayed when the user hovers over a cell displayed in the calendar month view tab.
|
void |
setMonthViewTitle(java.lang.String monthViewTitle)
The title for the
month view . |
void |
setNameField(java.lang.String nameField)
The name of the name field on a
CalendarEvent . |
void |
setNextButtonHoverText(java.lang.String nextButtonHoverText)
The text to be displayed when a user hovers over the
next toolbar button |
void |
setOtherDayBlankStyle(java.lang.String otherDayBlankStyle)
The CSS style applied to both the header and body of days from other months in the
month view , 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.
|
void |
setOverlapSortSpecifiers(SortSpecifier... overlapSortSpecifiers)
A set of
sort-specifiers for customizing the render order of events that
overlap. |
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 |
setPreviousButtonHoverText(java.lang.String previousButtonHoverText)
The text to be displayed when a user hovers over the
previous toolbar button. |
void |
setProgressiveLoading(java.lang.Boolean progressiveLoading)
Indicates whether or not this component will load its data
progressively |
void |
setRemoveButtonTitle(java.lang.String removeButtonTitle)
The title for the
Remove button in the event editor . |
void |
setRemoveOperation(java.lang.String removeOperation)
operationId this component
should use when performing remove operations. |
void |
setRenderEventsOnDemand(boolean renderEventsOnDemand)
When set to true, the default, each
event is rendered as it
appears in the viewport. |
void |
setResolution(HeaderLevel[] headerLevels,
TimeUnit unit,
java.lang.Integer unitCount)
Reset the resolution, the header levels and scrollable range, of the timeline view.
|
void |
setResolution(HeaderLevel[] headerLevels,
TimeUnit unit,
java.lang.Integer unitCount,
java.lang.Integer granularityPerColumn)
Reset the resolution, the header levels and scrollable range, of the timeline view.
|
void |
setRowHeight(int rowHeight)
The height of time-slots in the calendar.
|
void |
setRowTitleFrequency(java.lang.Integer rowTitleFrequency)
|
void |
setSaveButtonTitle(java.lang.String saveButtonTitle)
|
void |
setScrollToWorkday(java.lang.Boolean scrollToWorkday)
If set, causes the
workday hours 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 |
setSelectChosenDate(java.lang.Boolean selectChosenDate)
When true, shows the current
chosenDate in a
selected style in the month view Has no effect in
other views. |
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)
Set to false to hide the
Add Event button. |
void |
setShowCellHovers(java.lang.Boolean showCellHovers)
When
showViewHovers is true, dictates whether to
display hover prompts when the mouse rolls over the normal cells in the body of CalendarViews. |
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 |
setShowControlsBar(java.lang.Boolean showControlsBar)
If false the controls bar at the top of the calendar will not be displayed - this means that the
controlsBar will be hidden, so the autoChildren (previousButton , dateLabel , nextButton , addEventButton , and datePickerButton ) will not be created or shown. |
void |
setShowDateChooser(java.lang.Boolean showDateChooser)
Determines whether the
dateChooser is displayed. |
void |
setShowDateCustomizer(ShowDateCustomizer customizer)
This method is called during rendering for all events in the visible range - those which
would be rendered by default.
|
void |
setShowDatePickerButton(java.lang.Boolean showDatePickerButton)
Set to false to hide the
datePickerButton that
allows selecting a new base date for this Calendar. |
void |
setShowDayHeaders(java.lang.Boolean showDayHeaders)
If true, the default, show a header cell for each day cell in the
month view , with both cells having a minimum combined height
of minimumDayHeight . |
void |
setShowDayLanes(java.lang.Boolean showDayLanes)
|
void |
setShowDayView(java.lang.Boolean showDayView)
Whether to show the Day view.
|
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 |
setShowDragHovers(java.lang.Boolean showDragHovers)
When
showViewHovers is true, dictates whether to
display hover prompts when an event is being dragged with the mouse. |
void |
setShowEventCustomizer(ShowEventCustomizer customizer)
Return false from the customizer to prevent the passed CalendarEvent from being rendered in the
passed view.
|
void |
setShowEventDescriptions(boolean showEventDescriptions)
When rendering the
canvas for an event, whether to
show the body area , typically containing brief
details of the event - by default , its description . |
void |
setShowEventHeaders(boolean showEventHeaders)
When rendering the
canvas for an event, whether to
show the header area , typically containing
suitable title text - by default , the event's
name . |
void |
setShowEventHovers(java.lang.Boolean showEventHovers)
When
showViewHovers is true, dictates whether to
display hover prompts when the mouse moves over an event canvas
in a calendarView. |
void |
setShowHeaderHovers(java.lang.Boolean showHeaderHovers)
When
showViewHovers is true, dictates whether to
display hover prompts when the mouse rolls over the header levels in a CalendarView . |
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 |
setShowIndicators(java.lang.Boolean showIndicators)
Set to true to render any defined
indicators into
timeline views . |
void |
setShowIndicatorsInFront(boolean showIndicatorsInFront)
In
indicator lines are showing, this attribute
affects where in the z-order their canvases will be rendered: either in front of, or behind normal calendar events. |
void |
setShowLabelColumn(boolean showLabelColumn)
When set to false, hides the frozen Label-Column in vertical
CalendarView s. |
void |
setShowLaneCustomizer(ShowLaneCustomizer customizer)
Return false from the customizer to prevent the passed Lane from being rendered in the
passed view.
|
void |
setShowLaneFieldHovers(java.lang.Boolean showLaneFieldHovers)
When
showViewHovers is true, dictates whether to
display hover prompts when the mouse moves over the cells in a laneField . |
void |
setShowLaneRollOver(java.lang.Boolean showLaneRollOver)
When set to true, causes
Timelines , and day views with showDayLanes set, to highlight the Lane under the mouse
with the "Over" style. |
void |
setShowMonthButton(java.lang.Boolean showMonthButton)
Set to false to prevent the
Month button from
displaying on Handset devices. |
void |
setShowMonthView(java.lang.Boolean showMonthView)
Whether to show the Month view.
|
void |
setShowNextButton(java.lang.Boolean showNextButton)
Set to false to hide the
Next button. |
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 |
setShowPreviousButton(java.lang.Boolean showPreviousButton)
Set to false to hide the
Previous button. |
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 |
setShowViewHovers(java.lang.Boolean showViewHovers)
When set to true, the default value, causes the Calendar to show customizable hovers when the mouse moves over various
areas of a CalendarView.
|
void |
setShowWeekends(java.lang.Boolean showWeekends)
|
void |
setShowWeekView(java.lang.Boolean showWeekView)
Whether to show the Week view.
|
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 |
setShowZoneHovers(java.lang.Boolean showZoneHovers)
When
showViewHovers is true, dictates whether to
display hover prompts when the mouse moves over a zone in
a calendarView. |
void |
setShowZones(java.lang.Boolean showZones)
Set to true to render any defined
zones into timeline views . |
void |
setSizeEventsToGrid(java.lang.Boolean sizeEventsToGrid)
If true, events will be sized to the grid, even if they start and/or end at times between grid cells.
|
void |
setStartDate(java.util.Date startDate)
The start date of the calendar
timeline view . |
void |
setStartDateField(java.lang.String startDateField)
The name of the start date field on a
CalendarEvent . |
void |
setSublaneNameField(java.lang.String sublaneNameField)
The name of the field which will determine the
sublane in
which this event will be displayed, within its parent Lane, in Timeline s
and in the day view , if showDayLanes is true. |
void |
setTimeFormatter(TimeDisplayFormat timeFormatter)
Display format to use for the time portion of events' date information.
|
void |
setTimeFormatter(TimeFormatter timeFormatter)
Deprecated.
use
setTimeFormatter(TimeDisplayFormat) instead. |
void |
setTimelineGranularity(TimeUnit timelineGranularity)
The granularity in which the
timelineView will
display events. |
void |
setTimelineRange(java.util.Date start)
Sets the range over which the timeline will display events.
|
void |
setTimelineRange(java.util.Date start,
java.util.Date end)
Sets the range over which the timeline will display events.
|
void |
setTimelineUnitsPerColumn(int timelineUnitsPerColumn)
How many units of
timelineGranularity each
cell represents. |
void |
setTimelineViewTitle(java.lang.String timelineViewTitle)
The title for the
timeline view . |
void |
setTitleField(java.lang.String titleField)
Sets the best field to use for a user-visible title for an individual record from this component.
|
void |
setTodayBackgroundColor(java.lang.String todayBackgroundColor)
The background color for cells that represent today in all
CalendarView s. |
void |
setTrailingDateField(java.lang.String trailingDateField)
The name of the trailing date field for each event.
|
void |
setTwentyFourHourTime(java.lang.Boolean twentyFourHourTime)
Dictates whether times throughout the widget are formatted and edited as 24-hour values.
|
void |
setUpdateOperation(java.lang.String updateOperation)
operationId 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 |
setUseEventCanvasRolloverControls(boolean useEventCanvasRolloverControls)
By default, the
close buttons and the
horizontal and vertical resizer widgets for event canvases are
shown only when the mouse is over a given event. |
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 |
setUseSublanes(java.lang.Boolean useSublanes)
|
void |
setWeekendDays(int... weekendDays)
An array of integer day-numbers that should be considered to be weekend days by this Calendar instance.
|
void |
setWeekEventBorderOverlap(java.lang.Boolean weekEventBorderOverlap)
Augments the width of week event windows slightly to avoid duplicate adjacent borders between events.
|
void |
setWeekPrefix(java.lang.String weekPrefix)
The text to appear before the week number in the title of
week-based HeaderLevel s when this calendar is showing a timeline. |
void |
setWeekViewTitle(java.lang.String weekViewTitle)
The title for the
week view . |
void |
setWorkdayBaseStyle(java.lang.String workdayBaseStyle)
If
showWorkday is set, this is the style used for
cells that are within the workday, as defined by workdayStart and workdayEnd , or by a date-specific
range provided in getWorkdayStart() and getWorkdayEnd() implementations. |
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 String. |
void |
setWorkdays(int[] workdays)
Array of days that are considered workdays when
showWorkday is true |
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 String. |
void |
setZoneHoverHTMLCustomizer(ZoneHoverHTMLCustomizer zoneHoverHTMLCustomizer)
This method returns the hover HTML to be displayed when the user hovers over an ZoneCanvas
|
void |
setZones(CalendarEvent... zones)
An array of CalendarEvent instances representing pre-defined periods of time to be highlighted in
timeline views . |
void |
setZoneStyleName(java.lang.String zoneStyleName)
|
void |
setZoneTitleOrientation(VerticalAlignment zoneTitleOrientation)
The vertical alignment of the header-text in each
zone . |
boolean |
shouldDisableDate(java.util.Date date)
Returns true if the passed date should be considered disabled.
|
boolean |
shouldDisableDate(java.util.Date date,
CalendarView view)
Returns true if the passed date should be considered disabled.
|
boolean |
shouldShowDate(java.util.Date date)
Indicates whether the passed date should be visible in the passed
CalendarView . |
boolean |
shouldShowDate(java.util.Date date,
CalendarView view)
Indicates whether the passed date should be visible in the passed
CalendarView . |
boolean |
shouldShowEvent(CalendarEvent event)
Indicates whether the passed
event should be visible in the
passed CalendarView . |
boolean |
shouldShowEvent(CalendarEvent event,
CalendarView view)
Indicates whether the passed
event should be visible in the
passed CalendarView . |
boolean |
shouldShowLane(Lane lane)
Indicates whether the passed
lane should be visible in
the passed CalendarView . |
boolean |
shouldShowLane(Lane lane,
CalendarView view)
Indicates whether the passed
lane should be visible in
the passed CalendarView . |
boolean |
shouldShowLane(java.lang.String lane)
Indicates whether the passed
lane should be visible in
the passed CalendarView . |
void |
showEventDialog()
Open the Quick Event dialog showing minimal information about an existing
event . |
void |
showEventDialog(CalendarEvent event) |
void |
showEventDialog(CalendarEvent event,
java.lang.Boolean isNewEvent)
Open the Quick Event dialog showing minimal information about an existing
event . |
void |
showEventEditor()
Show an Event Editor for the passed event.
|
void |
showEventEditor(CalendarEvent event) |
void |
showEventEditor(CalendarEvent event,
java.lang.Boolean isNewEvent)
Show an Event Editor for the passed event.
|
void |
showNewEventDialog()
Open the Quick Event dialog to begin editing a new
event . |
void |
showNewEventDialog(CalendarEvent event)
Open the Quick Event dialog to begin editing a new
event . |
void |
showNewEventEditor()
Show an Event Editor for a new event.
|
void |
showNewEventEditor(CalendarEvent event)
Show an Event Editor for a new event.
|
java.lang.Boolean |
timelineEventMoved(CalendarEvent event,
java.util.Date startDate,
java.util.Date endDate,
Lane lane)
Deprecated.
in favor of
Calendar.eventRepositionStop() |
java.lang.Boolean |
timelineEventResized(CalendarEvent event,
java.util.Date startDate,
java.util.Date endDate)
Deprecated.
in favor of
Calendar.eventResizeStop() |
void |
transferRecords(Record[] records,
Record targetRecord,
java.lang.Integer index,
Canvas sourceWidget,
TransferRecordsCallback callback)
Transfer a list of
Record s from another component
(does not have to be a databound component) into this component. |
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 |
updateCalendarEvent(CalendarEvent event,
CalendarEvent newEvent,
java.util.Map otherFields)
Update an event in this calendar.
|
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.
|
addChild, addChild, addChild, addChild, addChild, addClearHandler, addClickHandler, addDoubleClickHandler, addDragMoveHandler, addDragRepositionMoveHandler, addDragRepositionStartHandler, addDragRepositionStopHandler, addDragResizeMoveHandler, addDragResizeStartHandler, addDragResizeStopHandler, addDragStartHandler, addDragStopHandler, addDropHandler, addDropMoveHandler, addDropOutHandler, addDropOverHandler, addFocusChangedHandler, addHoverHandler, addHoverHiddenHandler, addKeyDownHandler, addKeyPressHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseStillDownHandler, addMouseUpHandler, addMouseWheelHandler, addMovedHandler, addParentMovedHandler, addPeer, addPeer, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addRuleContextChangedHandler, addScrolledHandler, addShowContextMenuHandler, addSnapAlignCandidate, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, asSGWTComponent, blur, bringToFront, clear, clearExplicitTabIndex, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsFocus, containsPoint, containsPoint, deparent, depeer, disable, enable, encloses, focus, focusAfterGroup, focusAtEnd, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAdaptiveHeightPriority, getAdaptiveWidthPriority, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideEffect, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeLayoutMode, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaRole, getAutoMaskComponents, getAutoParent, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanAdaptHeight, getCanAdaptWidth, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenResizeSnapAlign, getChildrenSnapAlign, getChildrenSnapCenterAlign, getChildrenSnapEdgeAlign, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getChildTabPosition, getClassName, getComponentMask, getComponentMaskDefaults, getContentElement, getContents, getContextMenu, getCorrectZoomOverflow, getCursor, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragMaxHeight, getDragMaxWidth, getDragMinHeight, getDragMinWidth, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getEditProxyConstructor, getElement, getElement, getEnableWhen, getEndLine, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFormItemAutoChild, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverAutoFitMaxWidth, getHoverAutoFitMaxWidthAsString, getHoverAutoFitWidth, getHoverComponent, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getIsPrinting, getIsRuleScope, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeavePageSpace, getLeft, getLeftAsString, getLocalId, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMaxHeight, getMaxWidth, getMaxZoomOverflowError, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getName, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getOverflow, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPaletteDefaults, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPercentBox, getPercentSource, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrompt, getProportionalResizeModifiers, getProportionalResizing, getReceiveScrollbarEvents, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getRuleContext, getRuleContext, getRuleScope, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowColor, getShadowDepth, getShadowHOffset, getShadowImage, getShadowOffset, getShadowSoftness, getShadowSpread, getShadowVOffset, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowResizeBar, getShowShadow, getShowSnapGrid, getShrinkElementOnHide, getSizeMayChangeOnRedraw, getSkinImgDir, getSnapAlignCandidates, getSnapAlignCenterLineStyle, getSnapAlignEdgeLineStyle, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapPosition, getSnapPosition, getSnapResizeToAlign, getSnapResizeToGrid, getSnapTo, getSnapToAlign, getSnapToCenterAlign, getSnapToEdgeAlign, getSnapToGrid, getSnapVDirection, getSnapVGap, getStartLine, getStyleName, getTabIndex, getTestInstance, getTitle, getTooltip, getTop, getTopAsString, getTopElement, getUpdateTabPositionOnDraw, getUpdateTabPositionOnReparent, getUseBackMask, getUseCSSShadow, getUseDragMask, getUseImageForSVG, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getValuesManagerAsString, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWhen, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isFocused, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, pageScrollDown, pageScrollUp, parentResized, placeNear, placeNear, placeNear, printComponents, provideRuleContext, provideRuleContext, redraw, redraw, registerFontScaledPaddingStyles, removeChild, removeChild, removePeer, removePeer, removeSnapAlignCandidate, resizeAutoChildAttributes, resizeBy, resizeControls, resizeFonts, resizeFonts, resizeFonts, resizeIcons, resizePadding, resizePadding, resizeTo, resizeTo, revealChild, revealChild, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAdaptHeightByCustomizer, setAdaptiveHeightPriority, setAdaptiveWidthPriority, setAdaptWidthByCustomizer, setAlign, setAllowExternalFilters, setAlwaysShowScrollbars, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideEffect, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeLayoutMode, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoHeight, setAutoMaskComponents, setAutoParent, setAutoResizeAutoChildAttributes, setAutoResizeIcons, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanAdaptHeight, setCanAdaptWidth, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContents, setContextMenu, setCorrectZoomOverflow, setCursor, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultShowCustomScrollbars, setDefaultWidth, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragMaxHeight, setDragMaxWidth, setDragMinHeight, setDragMinWidth, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setEditProxyConstructor, setElement, setEnableWhen, setEndLine, setExtraSpace, setFacetId, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverAutoFitMaxWidth, setHoverAutoFitMaxWidth, setHoverAutoFitWidth, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setIsRuleScope, setIsSnapAlignCandidate, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeavePageSpace, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLogicalStructure, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMaxZoomOverflowError, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setName, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setOpacity, setOverflow, setPadding, setPageLeft, setPageTop, setPanelContainer, setParentCanvas, setParentElement, setPeers, setPercentBox, setPercentSource, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrompt, setProportionalResizeModifiers, setProportionalResizing, setReceiveScrollbarEvents, setRect, setRect, setRedrawOnResize, setRelativeTabPosition, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setRuleScope, setScrollbarConstructor, setScrollbarSize, setShadowColor, setShadowDepth, setShadowHOffset, setShadowImage, setShadowOffset, setShadowSoftness, setShadowSpread, setShadowVOffset, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowResizeBar, setShowShadow, setShowSnapGrid, setShrinkElementOnHide, setSizeMayChangeOnRedraw, setSkinImgDir, setSmoothFade, setSnapAlignCandidates, setSnapAlignCenterLineStyle, setSnapAlignEdgeLineStyle, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToAlign, setSnapResizeToGrid, setSnapTo, setSnapToAlign, setSnapToCenterAlign, setSnapToEdgeAlign, setSnapToGrid, setSnapVDirection, setSnapVGap, setStartLine, setStyleName, setTabIndex, setTitle, setTooltip, setTop, setTop, setUpdateTabPositionOnDraw, setUpdateTabPositionOnReparent, setUseBackMask, setUseCSSShadow, setUseDragMask, setUseImageForSVG, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setValuesManager, setVisibility, setVisible, setVisibleWhen, setWidth, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateChildTabPosition, updateChildTabPositions, updateEditNode, updateHover, updateHover, updateShadow, updateTabPositionForDraw, visibleAtPoint, willAcceptDrop
addDrawHandler, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, clearDynamicProperty, completeCreation, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hasDynamicProperty, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, isDrawn, isFactoryCreated, onBind, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDefaultProperties, setDragTracker, setFactoryCreated, setID, setJavaScriptObject, setLogicalStructure, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toString
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getOrCreateJsObj
public Calendar()
public Calendar(com.google.gwt.core.client.JavaScriptObject jsObj)
public static Calendar getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public static void changeAutoChildDefaults(java.lang.String autoChildName, Canvas defaults)
autoChildName
.autoChildName
- name of an AutoChild to customize the defaults for.defaults
- Canvas defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties. For usage tips on this
param, see SGWTProperties
.AutoChildUsage
public static void changeAutoChildDefaults(java.lang.String autoChildName, FormItem defaults)
autoChildName
.autoChildName
- name of an AutoChild to customize the defaults for.defaults
- FormItem defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties. For usage tips on this
param, see SGWTProperties
.AutoChildUsage
protected com.google.gwt.core.client.JavaScriptObject create()
public ImgButton getAddEventButton() throws java.lang.IllegalStateException
ImgButton
that appears in a Calendar's week/day/month views and offers an
alternative way to create a new event
.
This component is an AutoChild named "addEventButton". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public void setAddEventButtonHoverText(java.lang.String addEventButtonHoverText) throws java.lang.IllegalStateException
add event
toolbar buttonaddEventButtonHoverText
- New addEventButtonHoverText value. Default value is "Add an event"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getAddEventButtonHoverText()
add event
toolbar buttonpublic void setAllowDurationEvents(java.lang.Boolean allowDurationEvents)
duration
and duration unit
on each event, and are then
maintained, instead of the end date, when alterations are made to the event via editors or dragging with the mouse.allowDurationEvents
- New allowDurationEvents value. Default value is nullCalendarEvent
public java.lang.Boolean getAllowDurationEvents()
duration
and duration unit
on each event, and are then
maintained, instead of the end date, when alterations are made to the event via editors or dragging with the mouse.CalendarEvent
public void setAlternateLaneStyles(java.lang.Boolean alternateLaneStyles)
Timeline
, or a day view
when showDayLanes
is true, whether to make lane boundaries
more obvious by showing alternate lanes in a different color.alternateLaneStyles
- New alternateLaneStyles value. Default value is nullpublic java.lang.Boolean getAlternateLaneStyles()
Timeline
, or a day view
when showDayLanes
is true, whether to make lane boundaries
more obvious by showing alternate lanes in a different color.public void setAlwaysShowEventHovers(java.lang.Boolean alwaysShowEventHovers)
alwaysShowEventHovers
- New alwaysShowEventHovers value. Default value is falsepublic java.lang.Boolean getAlwaysShowEventHovers()
public void setBackButtonTitle(java.lang.String backButtonTitle) throws java.lang.IllegalStateException
month
on Handsets when the month view
is the current visible view. When the month
view is not the current visible view, the title for the month button is set according to the value of monthButtonTitle
.
backButtonTitle
- New backButtonTitle value. Default value is "Back"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdHTMLString
public java.lang.String getBackButtonTitle()
month
on Handsets when the month view
is the current visible view. When the month
view is not the current visible view, the title for the month button is set according to the value of monthButtonTitle
.
HTMLString
public void setBaseStyle(java.lang.String baseStyle)
See CellStyleSuffixes
for details on how stateful suffixes are combined with the base style to
generate stateful cell styles.
baseStyle
- New baseStyle value. Default value is "calendar"CSSStyleName
,
Appearance overview and related methods
public java.lang.String getBaseStyle()
See CellStyleSuffixes
for details on how stateful suffixes are combined with the base style to
generate stateful cell styles.
CSSStyleName
,
Appearance overview and related methods
public void setBringEventsToFront(java.lang.Boolean bringEventsToFront) throws java.lang.IllegalStateException
bringEventsToFront
- New bringEventsToFront value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getBringEventsToFront()
public void setCalMonthEventLinkStyle(java.lang.String calMonthEventLinkStyle)
getDayBodyHTML()
. These links are rendered as plain
HTML links using A elements, and the CSS style in the provided skins references the pseudo-classes :link, :visited,
:active, :hover.
Even though it goes against the general policy of not exposing the HTML structures SC writes out
and not relying on them for styling, applying style to these particular selectors is acceptable, as we're unlikely to
use any other kind of HTML structure than a link.
calMonthEventLinkStyle
- New calMonthEventLinkStyle value. Default value is "calMonthEventLink"CSSStyleName
,
Appearance overview and related methods
public java.lang.String getCalMonthEventLinkStyle()
getDayBodyHTML()
. These links are rendered as plain
HTML links using A elements, and the CSS style in the provided skins references the pseudo-classes :link, :visited,
:active, :hover.
Even though it goes against the general policy of not exposing the HTML structures SC writes out
and not relying on them for styling, applying style to these particular selectors is acceptable, as we're unlikely to
use any other kind of HTML structure than a link.
CSSStyleName
,
Appearance overview and related methods
public IButton getCancelButton() throws java.lang.IllegalStateException
com.smartgwt.client.types.AutoChild
of type IButton
, used to cancel
editing of an event and close the eventEditor
.
This component is an AutoChild named "cancelButton". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public void setCancelButtonTitle(java.lang.String cancelButtonTitle) throws java.lang.IllegalStateException
Cancel button
in the event editor
.cancelButtonTitle
- New cancelButtonTitle value. Default value is "Cancel"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdHTMLString
public java.lang.String getCancelButtonTitle()
Cancel button
in the event editor
.HTMLString
public void setCanCreateEvents(java.lang.Boolean canCreateEvents) throws java.lang.IllegalStateException
canCreateEvents
- New canCreateEvents value. Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getCanCreateEvents()
public void setCanDeleteEvents(java.lang.Boolean canDeleteEvents) throws java.lang.IllegalStateException
canRemoveEvents
canEditEvents
.canDeleteEvents
- New canDeleteEvents value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getCanDeleteEvents()
canRemoveEvents
canEditEvents
.public void setCanDragCreateEvents(java.lang.Boolean canDragCreateEvents)
canDragCreateEvents
- New canDragCreateEvents value. Default value is nullpublic java.lang.Boolean getCanDragCreateEvents()
public void setCanDragEventField(java.lang.String canDragEventField) throws java.lang.IllegalStateException
CalendarEvent
that determines whether an EventCanvas
can be moved or resized by dragging with the mouse. Note that canEditEvents
must be true for dragging to be allowed.canDragEventField
- New canDragEventField value. Default value is "canDrag"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdCalendarEvent
public java.lang.String getCanDragEventField()
CalendarEvent
that determines whether an EventCanvas
can be moved or resized by dragging with the mouse. Note that canEditEvents
must be true for dragging to be allowed.CalendarEvent
public void setCanDragEvents(java.lang.Boolean canDragEvents) throws java.lang.IllegalStateException
Only has an effect when canEditEvents
is true.
canDragEvents
- New canDragEvents value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getCanDragEvents()
Only has an effect when canEditEvents
is true.
public void setCanEditEvents(java.lang.Boolean canEditEvents) throws java.lang.IllegalStateException
canEditEvents
- New canEditEvents value. Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getCanEditEvents()
public void setCanEditField(java.lang.String canEditField) throws java.lang.IllegalStateException
CalendarEvent
that determines whether it can be
edited in the event editor
. Note that an event
with canEdit
set to true can also have canDrag
or canResize
set to false, which would still allow
editing, but not via drag operations.canEditField
- New canEditField value. Default value is "canEdit"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdCalendarEvent
public java.lang.String getCanEditField()
CalendarEvent
that determines whether it can be
edited in the event editor
. Note that an event
with canEdit
set to true can also have canDrag
or canResize
set to false, which would still allow
editing, but not via drag operations.CalendarEvent
public void setCanEditLane(java.lang.Boolean canEditLane) throws java.lang.IllegalStateException
lane
, and the event quick dialog
and editor
allow a lane to be selected with a drop-down
chooser. In either case, the event's laneNameField
is updated automatically.
If set to false, cross-lane dragging is disallowed and drop-down
Lane-choosers are disabled when editing existng events. When creating new events
, the Lane-chooser remains enabled so an
initial Lane can be selected.
This setting can be overridden on each event
.
canEditLane
- New canEditLane value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getCanEditLane()
lane
, and the event quick dialog
and editor
allow a lane to be selected with a drop-down
chooser. In either case, the event's laneNameField
is updated automatically.
If set to false, cross-lane dragging is disallowed and drop-down
Lane-choosers are disabled when editing existng events. When creating new events
, the Lane-chooser remains enabled so an
initial Lane can be selected.
This setting can be overridden on each event
.
public void setCanEditLaneField(java.lang.String canEditLaneField) throws java.lang.IllegalStateException
CalendarEvent
that determines whether that event
can be moved between lanes.canEditLaneField
- New canEditLaneField value. Default value is "canEditLane"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdCalendarEvent
public java.lang.String getCanEditLaneField()
CalendarEvent
that determines whether that event
can be moved between lanes.CalendarEvent
public void setCanEditSublane(java.lang.Boolean canEditSublane) throws java.lang.IllegalStateException
If so, the event can be dragged to a different sublane
within the same parent Lane and, when it's editor is
shown, an additional drop-down widget is provided allowing the sublane to be altered.
If the sublane is locked, but
the parent lane
isn't, an update to the event's
lane name
will be allowed, assuming that the new
Lane has an existing sublane with the same name.
In either case, the event's sublane
is updated automatically.
This setting
can be overridden on each event
.
canEditSublane
- New canEditSublane value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getCanEditSublane()
If so, the event can be dragged to a different sublane
within the same parent Lane and, when it's editor is
shown, an additional drop-down widget is provided allowing the sublane to be altered.
If the sublane is locked, but
the parent lane
isn't, an update to the event's
lane name
will be allowed, assuming that the new
Lane has an existing sublane with the same name.
In either case, the event's sublane
is updated automatically.
This setting
can be overridden on each event
.
public void setCanEditSublaneField(java.lang.String canEditSublaneField) throws java.lang.IllegalStateException
CalendarEvent
that determines whether that event
can be moved between individual sublanes
in a Lane
.canEditSublaneField
- New canEditSublaneField value. Default value is "canEditSublane"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdCalendarEvent
public java.lang.String getCanEditSublaneField()
CalendarEvent
that determines whether that event
can be moved between individual sublanes
in a Lane
.CalendarEvent
public void setCanGroupLanes(java.lang.Boolean canGroupLanes)
laneGroupByField
. The fields available for grouping
on are those defined as lane fields
. Since these
are definitions for normal fields
, you can choose to hide
the field in the timeline, but still have it available for
grouping.canGroupLanes
- New canGroupLanes value. Default value is nullpublic java.lang.Boolean getCanGroupLanes()
laneGroupByField
. The fields available for grouping
on are those defined as lane fields
. Since these
are definitions for normal fields
, you can choose to hide
the field in the timeline, but still have it available for
grouping.public void setCanRemoveEvents(java.lang.Boolean canRemoveEvents) throws java.lang.IllegalStateException
canEditEvents
.canRemoveEvents
- New canRemoveEvents value. Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getCanRemoveEvents()
canEditEvents
.public void setCanRemoveField(java.lang.String canRemoveField) throws java.lang.IllegalStateException
CalendarEvent
that determines whether an event
shows a remove button.canRemoveField
- New canRemoveField value. Default value is "canRemove"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdCalendarEvent
public java.lang.String getCanRemoveField()
CalendarEvent
that determines whether an event
shows a remove button.CalendarEvent
public void setCanReorderLanes(java.lang.Boolean canReorderLanes) throws java.lang.IllegalStateException
laneFields
with the mouse.canReorderLanes
- New canReorderLanes value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getCanReorderLanes()
laneFields
with the mouse.public void setCanResizeEventField(java.lang.String canResizeEventField) throws java.lang.IllegalStateException
CalendarEvent
that determines whether an event
can be resized by dragging.canResizeEventField
- New canResizeEventField value. Default value is "canResize"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdCalendarEvent
public java.lang.String getCanResizeEventField()
CalendarEvent
that determines whether an event
can be resized by dragging.CalendarEvent
public void setCanResizeEvents(java.lang.Boolean canResizeEvents) throws java.lang.IllegalStateException
events
be resized by dragging appropriate edges of the
canvas
? Only has an effect when both canEditEvents
and canDragEvents
are true. Set this attribute to false to
disallow drag-resizing.canResizeEvents
- New canResizeEvents value. Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getCanResizeEvents()
events
be resized by dragging appropriate edges of the
canvas
? Only has an effect when both canEditEvents
and canDragEvents
are true. Set this attribute to false to
disallow drag-resizing.public void setCanResizeTimelineEvents(java.lang.Boolean canResizeTimelineEvents) throws java.lang.IllegalStateException
canResizeEvents
;Timeline
events be stretched by their left and right edges?canResizeTimelineEvents
- New canResizeTimelineEvents value. Default value is falsejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getCanResizeTimelineEvents()
canResizeEvents
;Timeline
events be stretched by their left and right edges?public void setCanSelectEvents(java.lang.Boolean canSelectEvents) throws java.lang.IllegalStateException
event canvases
selectable.
Events may be selected via a single click, as well as being included in the page's tab order. The current selected event
is shown in a special style and pressing TAB or Shift-TAB will move the selection first among the events in the same
lane, and then among those in the next or previous lane. Pressing Enter while an editable event is selected will
show either the event- dialog
or editor
. Pressing Delete will remove the event.
Note that when this property is false, single clicking the event canvas for an editable event will bring up an editing interface for that event. When true this is no longer the case - a user can double click to bring up the editing interface instead (a single click will simply select the event canvas).
canSelectEvents
- New canSelectEvents value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getCanSelectEvents()
event canvases
selectable.
Events may be selected via a single click, as well as being included in the page's tab order. The current selected event
is shown in a special style and pressing TAB or Shift-TAB will move the selection first among the events in the same
lane, and then among those in the next or previous lane. Pressing Enter while an editable event is selected will
show either the event- dialog
or editor
. Pressing Delete will remove the event.
Note that when this property is false, single clicking the event canvas for an editable event will bring up an editing interface for that event. When true this is no longer the case - a user can double click to bring up the editing interface instead (a single click will simply select the event canvas).
public void setChosenDate(java.util.Date chosenDate)
chosenDate
- the new date to set as the current date. Default value is 'Today'public java.util.Date getChosenDate()
public void setColumnsPerPage(java.lang.Integer columnsPerPage) throws java.lang.IllegalStateException
timelineGranularity
to scroll by. With the
default value of null, the Timeline will scroll by its current length.columnsPerPage
- New columnsPerPage value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Integer getColumnsPerPage()
timelineGranularity
to scroll by. With the
default value of null, the Timeline will scroll by its current length.public HLayout getControlsBar() throws java.lang.IllegalStateException
HLayout
shown above the Calendar views and displaying a set of
controls for interacting with the current view - namely, the next
, previous
and add
buttons, the date label
and the date-picker
icon.
This component is an AutoChild named "controlsBar". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public void setCurrentViewName(ViewName currentViewName)
currentViewName
- The name of the view that should be made visible. Default value is nullpublic ViewName getCurrentViewName()
public void setData(CalendarEvent... data)
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 resultSet
rather than a simple array.
If this method is called after the component has been drawn/initialized:
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.
data
- data to show in the list. Default value is nullCalendarEvent
public CalendarEvent[] getData()
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 resultSet
rather than a simple array.
CalendarEvent
public void setDataFetchMode(FetchMode dataFetchMode)
FetchMode
. This
setting only applies to the ResultSet
automatically created by calling fetchData()
. If a pre-existing ResultSet is passed to setData()
instead, it's existing setting for ResultSet.fetchMode
applies.
setDataFetchMode
in interface DataBoundComponent
dataFetchMode
- New dataFetchMode value. Default value is "paged"Databinding overview and related methods
public FetchMode getDataFetchMode()
FetchMode
. This
setting only applies to the ResultSet
automatically created by calling fetchData()
. If a pre-existing ResultSet is passed to setData()
instead, it's existing setting for ResultSet.fetchMode
applies.
getDataFetchMode
in interface DataBoundComponent
Databinding overview and related methods
public void setDataSource(DataSource dataSource)
DataSource requests
. Can be specified as either a DataSource instance or the String ID of a DataSource.
setDataSource
in interface DataBoundComponent
dataSource
- New dataSource value. Default value is nullDatabinding overview and related methods
,
DataSource fields Examplepublic void setDataSource(java.lang.String dataSource)
DataSource requests
. Can be specified as either a DataSource instance or the String ID of a DataSource.
setDataSource
in interface DataBoundComponent
dataSource
- New dataSource value. Default value is nullDatabinding overview and related methods
,
DataSource fields Examplepublic DateChooser getDateChooser() throws java.lang.IllegalStateException
DateChooser
used to select the date for which events will be displayed.
This component is an AutoChild named "dateChooser". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public void setDateEditingStyle(DateEditingStyle dateEditingStyle) throws java.lang.IllegalStateException
DateEditingStyle
type. If unset, the editing style will be set to the
field-type on the DataSource, if there is one. If there's no DataSource, it will be set to "date" if the granularity
is "day" or larger and "time" if
granularity is "minute" or smaller, otherwise "datetime".
dateEditingStyle
- New dateEditingStyle value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic DateEditingStyle getDateEditingStyle()
DateEditingStyle
type. If unset, the editing style will be set to the
field-type on the DataSource, if there is one. If there's no DataSource, it will be set to "date" if the granularity
is "day" or larger and "time" if
granularity is "minute" or smaller, otherwise "datetime".
public void setDateFormatter(DateDisplayFormat dateFormatter)
DateUtil.setShortDisplayFormat()
. Specify any valid DateDisplayFormat
.dateFormatter
- New dateFormatter value. Default value is nullpublic DateDisplayFormat getDateFormatter()
DateUtil.setShortDisplayFormat()
. Specify any valid DateDisplayFormat
.public Label getDateLabel() throws java.lang.IllegalStateException
com.smartgwt.client.types.AutoChild
Label
used to display the current
date or range above the selected calendar view.
This component is an AutoChild named "dateLabel". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public ImgButton getDatePickerButton() throws java.lang.IllegalStateException
ImgButton
that appears above the various views of the calendar and
offers alternative access to a DateChooser
to pick the current day.
This component is an AutoChild named "datePickerButton". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public void setDatePickerHoverText(java.lang.String datePickerHoverText) throws java.lang.IllegalStateException
date picker
toolbar buttondatePickerHoverText
- New datePickerHoverText value. Default value is "Choose a date"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getDatePickerHoverText()
date picker
toolbar buttonpublic void setDayBodyBaseStyle(java.lang.String dayBodyBaseStyle)
See CellStyleSuffixes
for details on how stateful suffixes are combined with the base style to
generate stateful cell styles.
dayBodyBaseStyle
- New dayBodyBaseStyle value. Default value is "calMonthDayBody"CSSStyleName
,
Appearance overview and related methods
public java.lang.String getDayBodyBaseStyle()
See CellStyleSuffixes
for details on how stateful suffixes are combined with the base style to
generate stateful cell styles.
CSSStyleName
,
Appearance overview and related methods
public void setDayHeaderBaseStyle(java.lang.String dayHeaderBaseStyle)
See CellStyleSuffixes
for details on how stateful suffixes are combined with the base style to
generate stateful cell styles.
dayHeaderBaseStyle
- New dayHeaderBaseStyle value. Default value is "calMonthDayHeader"CSSStyleName
,
Appearance overview and related methods
public java.lang.String getDayHeaderBaseStyle()
See CellStyleSuffixes
for details on how stateful suffixes are combined with the base style to
generate stateful cell styles.
CSSStyleName
,
Appearance overview and related methods
public CalendarView getDayView() throws java.lang.IllegalStateException
CalendarView
used to display events that pertain to a given day.
This component is an AutoChild named "dayView". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public void setDayViewTitle(java.lang.String dayViewTitle) throws java.lang.IllegalStateException
day view
.dayViewTitle
- New dayViewTitle value. Default value is "Day"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getDayViewTitle()
day view
.public void setDefaultTimelineColumnSpan(int defaultTimelineColumnSpan) throws java.lang.IllegalStateException
timelineGranularity
to give the timeline by default if no endDate
is provided. The default is 20.defaultTimelineColumnSpan
- New defaultTimelineColumnSpan value. Default value is 20java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getDefaultTimelineColumnSpan()
timelineGranularity
to give the timeline by default if no endDate
is provided. The default is 20.public void setDescriptionField(java.lang.String descriptionField) throws java.lang.IllegalStateException
CalendarEvent
.descriptionField
- New descriptionField value. Default value is "description"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getDescriptionField()
CalendarEvent
.public void setDetailsButtonTitle(java.lang.String detailsButtonTitle) throws java.lang.IllegalStateException
quick
event dialog
.detailsButtonTitle
- New detailsButtonTitle value. Default value is "Edit Details"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdHTMLString
public java.lang.String getDetailsButtonTitle()
quick
event dialog
.HTMLString
public void setDisableWeekends(java.lang.Boolean disableWeekends)
weekendDays
.disableWeekends
- New disableWeekends value. Default value is trueVisibility overview and related methods
public java.lang.Boolean getDisableWeekends()
weekendDays
.Visibility overview and related methods
public void setDurationField(java.lang.String durationField) throws java.lang.IllegalStateException
duration
field on a CalendarEvent
.durationField
- New durationField value. Default value is "duration"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdCalendarEvent
public java.lang.String getDurationField()
duration
field on a CalendarEvent
.CalendarEvent
public void setDurationUnitField(java.lang.String durationUnitField) throws java.lang.IllegalStateException
durationUnit
field on a
CalendarEvent
.durationUnitField
- New durationUnitField value. Default value is "durationUnit"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdCalendarEvent
public java.lang.String getDurationUnitField()
durationUnit
field on a
CalendarEvent
.CalendarEvent
public void setEndDate(java.util.Date endDate) throws java.lang.IllegalStateException
To set different start
and end dates after initial draw, see setTimelineRange
.
Note that the value you provide
may be automatically altered if showing header-levels
, to fit to header boundaries.
endDate
- New endDate value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.util.Date getEndDate()
To set different start
and end dates after initial draw, see setTimelineRange
.
Note that the value you provide
may be automatically altered if showing header-levels
, to fit to header boundaries.
public void setEndDateField(java.lang.String endDateField) throws java.lang.IllegalStateException
CalendarEvent
.endDateField
- New endDateField value. Default value is "endDate"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdCalendarEvent
public java.lang.String getEndDateField()
CalendarEvent
.CalendarEvent
public void setEventAutoArrange(java.lang.Boolean eventAutoArrange) throws java.lang.IllegalStateException
eventAutoArrange
- New eventAutoArrange value. Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getEventAutoArrange()
public EventCanvas getEventCanvas()
Using AutoChildren
for details.
To display events in day
, week
and timeline
views, the Calendar creates instances of EventCanvas
for each event. Use the com.smartgwt.client.types.AutoChild
system to customize these canvases.
public HLayout getEventCanvasButtonLayout() throws java.lang.IllegalStateException
close
and/or context
buttons.
This component is an AutoChild named "eventCanvasButtonLayout". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public ImgButton getEventCanvasCloseButton() throws java.lang.IllegalStateException
CalendarView
.
This component is an AutoChild named "eventCanvasCloseButton". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public ImgButton getEventCanvasContextButton() throws java.lang.IllegalStateException
context menu
when clicked.
This component is an AutoChild named "eventCanvasContextButton". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public Menu getEventCanvasContextMenu() throws java.lang.IllegalStateException
event canvas
is right-clicked,
or when the rollover context button
is
clicked. The context button, and the menu itself, will only be displayed if getEventCanvasMenuItems
returns an array of
appropriate items for the event.
This component is an AutoChild named "eventCanvasContextMenu". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public Img getEventCanvasGripper()
Using AutoChildren
for details.
The "gripper" widget that snaps to the top of an event canvas and allows an event to be dragged with the mouse.
public Img getEventCanvasHResizer()
Using AutoChildren
for details.
The resizer image that snaps to the left and right edges of an editable event canvas in a Timeline
, allowing it to be resized horizontally by dragging with the mouse.
public Label getEventCanvasLabel()
Using AutoChildren
for details.
public Img getEventCanvasVResizer()
Using AutoChildren
for details.
The resizer image that snaps to the bottom of event canvases in day
and week
views, allowing them to be resized vertically by
dragging with the mouse.
public void setEventDescriptionFieldTitle(java.lang.String eventDescriptionFieldTitle) throws java.lang.IllegalStateException
eventDescriptionFieldTitle
- New eventDescriptionFieldTitle value. Default value is "Description"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdHTMLString
public java.lang.String getEventDescriptionFieldTitle()
HTMLString
public Window getEventDialog() throws java.lang.IllegalStateException
com.smartgwt.client.types.AutoChild
of type Window
that displays a quick
event entry form in a popup window.
This component is an AutoChild named "eventDialog". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public void setEventDragGap(java.lang.Integer eventDragGap)
eventDragGap
- New eventDragGap value. Default value is 10public java.lang.Integer getEventDragGap()
public void setEventDurationFieldTitle(java.lang.String eventDurationFieldTitle) throws java.lang.IllegalStateException
eventDurationFieldTitle
- New eventDurationFieldTitle value. Default value is "Duration"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdHTMLString
public java.lang.String getEventDurationFieldTitle()
HTMLString
public void setEventDurationUnitFieldTitle(java.lang.String eventDurationUnitFieldTitle) throws java.lang.IllegalStateException
eventDurationUnitFieldTitle
- New eventDurationUnitFieldTitle value. Default value is " "java.lang.IllegalStateException
- this property cannot be changed after the component has been createdHTMLString
public java.lang.String getEventDurationUnitFieldTitle()
HTMLString
public DynamicForm getEventEditor() throws java.lang.IllegalStateException
com.smartgwt.client.types.AutoChild
of type DynamicForm
which
displays event data
. This form is created within the event editor layout
This component is an AutoChild named "eventEditor". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public HLayout getEventEditorButtonLayout() throws java.lang.IllegalStateException
com.smartgwt.client.types.AutoChild
of type HLayout
which houses
the Save
, Remove
and Cancel
buttons in the eventEditor
.
This component is an AutoChild named "eventEditorButtonLayout". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public Window getEventEditorLayout() throws java.lang.IllegalStateException
com.smartgwt.client.types.AutoChild
of type Window
that displays the full
event editor
This component is an AutoChild named "eventEditorLayout". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public void setEventEndDateFieldTitle(java.lang.String eventEndDateFieldTitle) throws java.lang.IllegalStateException
eventEndDateFieldTitle
- New eventEndDateFieldTitle value. Default value is "To"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdHTMLString
public java.lang.String getEventEndDateFieldTitle()
HTMLString
public void setEventHeaderHeight(int eventHeaderHeight) throws java.lang.IllegalStateException
eventHeaderWrap
is false and showEventDescriptions
is true, this is the fixed
height for the header area
in event canvases.eventHeaderHeight
- New eventHeaderHeight value. Default value is 14java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getEventHeaderHeight()
eventHeaderWrap
is false and showEventDescriptions
is true, this is the fixed
height for the header area
in event canvases.public void setEventHeaderWrap(boolean eventHeaderWrap) throws java.lang.IllegalStateException
canvas
for an event, whether to
allow the content of the header area
to wrap to
multiple lines. The default is true - if set to false, the header area is fixed
, unless showEventDescriptions
is false, in which case
the header area fills the canvas.
eventHeaderWrap
- New eventHeaderWrap value. Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic boolean getEventHeaderWrap()
canvas
for an event, whether to
allow the content of the header area
to wrap to
multiple lines. The default is true - if set to false, the header area is fixed
, unless showEventDescriptions
is false, in which case
the header area fills the canvas.
public void setEventLaneFieldTitle(java.lang.String eventLaneFieldTitle) throws java.lang.IllegalStateException
eventLaneFieldTitle
- New eventLaneFieldTitle value. Default value is "Lane"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdHTMLString
public java.lang.String getEventLaneFieldTitle()
HTMLString
public void setEventNameFieldTitle(java.lang.String eventNameFieldTitle) throws java.lang.IllegalStateException
eventNameFieldTitle
- New eventNameFieldTitle value. Default value is "Event Name"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdHTMLString
public java.lang.String getEventNameFieldTitle()
HTMLString
public void setEventOverlap(java.lang.Boolean eventOverlap) throws java.lang.IllegalStateException
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 for Calendars and false for Timelines
.eventOverlap
- New eventOverlap value. Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getEventOverlap()
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 for Calendars and false for Timelines
.public void setEventOverlapIdenticalStartTimes(java.lang.Boolean eventOverlapIdenticalStartTimes) throws java.lang.IllegalStateException
eventOverlapIdenticalStartTimes
- New eventOverlapIdenticalStartTimes value. Default value is falsejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getEventOverlapIdenticalStartTimes()
public void setEventOverlapPercent(int eventOverlapPercent) throws java.lang.IllegalStateException
eventOverlapPercent
- New eventOverlapPercent value. Default value is 10java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getEventOverlapPercent()
public void setEventSnapGap(java.lang.Integer eventSnapGap)
If unset (the default), all views will snap to each cell boundary; 30 minutes in a default vertical
view, or one column
in a default Timeline.
If set to zero, views will snap to one of a set of known "sensible" defaults: for a default vertical, this will be
5 minutes. For timelines, the eventSnapGap is automatic depending on the current timelineGranularity
. If timelineUnitsPerColumn
is greater than 1, the
snapGap is set to one unit of the current granularity. So, a cell-resolution of 15 minutes would snap to every minute,
assuming there are at least 15 pixels per column. Otherwise, the snapGap is either 15 minutes, 1 hour, one day or one
month, depending on granularity.
If any other value is specified, it is used where possible.
If the specified or calculated value is less than the time covered by a single pixel in the current view, then it can't be represented. In this case, it is rounded up to the lowest of a set of "sensible" time-spans that can be represented: one of [1, 5, 10, 15, 20, 30, 60, 120, 240, 360, 480, 720, 1440].
For example - a Timeline showing "day" columns cannot support an eventSnapGap of 1 minute, unless each column is at least 1440 pixels wide - if the columns were only 150px wide, then each pixel would represent around 9.6 minutes, which would result in unpleasant and unexpected time-offsets when dragging events. So, the calculated eventSnapGap will be rounded up to the nearest "sensible" time-span - in this case, 10 minutes. If the columns were only 60px wide, it would be 30 minutes.
eventSnapGap
- New eventSnapGap value. Default value is nullEditing overview and related methods
public java.lang.Integer getEventSnapGap()
If unset (the default), all views will snap to each cell boundary; 30 minutes in a default vertical
view, or one column
in a default Timeline.
If set to zero, views will snap to one of a set of known "sensible" defaults: for a default vertical, this will be
5 minutes. For timelines, the eventSnapGap is automatic depending on the current timelineGranularity
. If timelineUnitsPerColumn
is greater than 1, the
snapGap is set to one unit of the current granularity. So, a cell-resolution of 15 minutes would snap to every minute,
assuming there are at least 15 pixels per column. Otherwise, the snapGap is either 15 minutes, 1 hour, one day or one
month, depending on granularity.
If any other value is specified, it is used where possible.
If the specified or calculated value is less than the time covered by a single pixel in the current view, then it can't be represented. In this case, it is rounded up to the lowest of a set of "sensible" time-spans that can be represented: one of [1, 5, 10, 15, 20, 30, 60, 120, 240, 360, 480, 720, 1440].
For example - a Timeline showing "day" columns cannot support an eventSnapGap of 1 minute, unless each column is at least 1440 pixels wide - if the columns were only 150px wide, then each pixel would represent around 9.6 minutes, which would result in unpleasant and unexpected time-offsets when dragging events. So, the calculated eventSnapGap will be rounded up to the nearest "sensible" time-span - in this case, 10 minutes. If the columns were only 60px wide, it would be 30 minutes.
Editing overview and related methods
public void setEventStartDateFieldTitle(java.lang.String eventStartDateFieldTitle) throws java.lang.IllegalStateException
eventStartDateFieldTitle
- New eventStartDateFieldTitle value. Default value is "From"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdHTMLString
public java.lang.String getEventStartDateFieldTitle()
HTMLString
public void setEventStyleName(java.lang.String eventStyleName)
events
when they're rendered in calendar views. This style will have "Header" 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'.eventStyleName
- New eventStyleName value. Default value is "eventWindow"CSSStyleName
,
Appearance overview and related methods
public java.lang.String getEventStyleName()
events
when they're rendered in calendar views. This style will have "Header" 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'.CSSStyleName
,
Appearance overview and related methods
public void setEventStyleNameField(java.lang.String eventStyleNameField) throws java.lang.IllegalStateException
eventStyleName
for an individual CalendarEvent.styleName
.eventStyleNameField
- New eventStyleNameField value. Default value is "styleName"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdAppearance overview and related methods
public java.lang.String getEventStyleNameField()
eventStyleName
for an individual CalendarEvent.styleName
.Appearance overview and related methods
public void setEventSublaneFieldTitle(java.lang.String eventSublaneFieldTitle) throws java.lang.IllegalStateException
eventSublaneFieldTitle
- New eventSublaneFieldTitle value. Default value is "Sublane"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdHTMLString
public java.lang.String getEventSublaneFieldTitle()
HTMLString
public EventWindow getEventWindow()
eventCanvas
Using AutoChildren
for details.
To display events in day and week views, the Calendar creates instance of EventWindow
for each event. Use the com.smartgwt.client.types.AutoChild
system to customize these windows.
public void setEventWindowStyle(java.lang.String eventWindowStyle)
eventStyleName
eventWindowStyle
- New eventWindowStyle value. Default value is nullCSSStyleName
,
Appearance overview and related methods
public java.lang.String getEventWindowStyle()
eventStyleName
CSSStyleName
,
Appearance overview and related methods
public void setEventWindowStyleField(java.lang.String eventWindowStyleField) throws java.lang.IllegalStateException
eventStyleNameField
eventWindowStyle
for an individual CalendarEvent
. See CalendarEvent.eventWindowStyle
.eventWindowStyleField
- New eventWindowStyleField value. Default value is "eventWindowStyle"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdAppearance overview and related methods
public java.lang.String getEventWindowStyleField()
eventStyleNameField
eventWindowStyle
for an individual CalendarEvent
. See CalendarEvent.eventWindowStyle
.Appearance overview and related methods
public void setFirstDayOfWeek(java.lang.Integer firstDayOfWeek)
DateChooser
. If unset, the default is taken from the current locale.
firstDayOfWeek
- New firstDayOfWeek value. Default value is nullpublic java.lang.Integer getFirstDayOfWeek()
DateChooser
. If unset, the default is taken from the current locale.
public void setHeaderLevels(HeaderLevel... headerLevels)
headers
shown above the event area,
and their time units. Header levels are provided from the top down, so the first header level should be the largest
time unit and the last one the smallest. The smallest is then used for the actual field-headers.
If this method is called after the component has been drawn/initialized:
For Timeline
s, configures the levels of headers
shown above the event area, and their time units, after initialization.
headerLevels
- the array of HeaderLevels to set. Default value is nullpublic HeaderLevel[] getHeaderLevels()
headers
shown above the event area,
and their time units. Header levels are provided from the top down, so the first header level should be the largest time unit and the last one the smallest. The smallest is then used for the actual field-headers.
public void setHideUnusedLanes(java.lang.Boolean hideUnusedLanes)
lane
that doesn't have any
active events in the current dataset.
hideUnusedLanes
after creation.hideUnusedLanes
- whether to hide unused lanes. Default value is nullpublic java.lang.Boolean getHideUnusedLanes()
lane
that doesn't have any
active events in the current dataset.public IndicatorCanvas getIndicatorCanvas()
Using AutoChildren
for details.
AutoChild component created for each indicator
entry.
public void setIndicators(CalendarEvent... indicators)
timeline views
. Each indicator renders out as an indicator canvas
, a special, non-interactive subclass of EventCanvas
, which spans all lanes and draws behind any normal, interactive
events in the zorder, but in front of any zones
. The
default style
for these components renders
them as thin vertical lines that span all lanes and have a hover but no title.
indicators
used to highlight instants in time.indicators
- array of indicators to display. Default value is nullpublic CalendarEvent[] getIndicators()
timeline views
. Each indicator renders out as an indicator canvas
, a special, non-interactive subclass of EventCanvas
, which spans all lanes and draws behind any normal, interactive
events in the zorder, but in front of any zones
. The
default style
for these components renders
them as thin vertical lines that span all lanes and have a hover but no title.public void setIndicatorStyleName(java.lang.String indicatorStyleName)
indicatorStyleName
- New indicatorStyleName value. Default value is "indicatorCanvas"CSSStyleName
public java.lang.String getIndicatorStyleName()
CSSStyleName
public void setInvalidDateMessage(java.lang.String invalidDateMessage) throws java.lang.IllegalStateException
eventEditor
when the
'To' date is greater than the 'From' date and a save is attempted.invalidDateMessage
- New invalidDateMessage value. Default value is "From must be before To"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getInvalidDateMessage()
eventEditor
when the
'To' date is greater than the 'From' date and a save is attempted.public void setLaneEventPadding(java.lang.Integer laneEventPadding)
lane
or sublane
they appear in. Only applicable to timelines
and to dayViews
showing day lanes
.laneEventPadding
- New laneEventPadding value. Default value is 0public java.lang.Integer getLaneEventPadding()
lane
or sublane
they appear in. Only applicable to timelines
and to dayViews
showing day lanes
.public void setLaneFields(ListGridField... laneFields) throws java.lang.IllegalStateException
timelineView
, which shows data about the timeline lanes
.
Each field shows one attribute of the objects provided as lanes
. When lane grouping
is enabled, only
fields that are specified as lane fields can be used as group fields.
laneFields
- New laneFields value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic ListGridField[] getLaneFields()
timelineView
, which shows data about the timeline lanes
.
Each field shows one attribute of the objects provided as lanes
. When lane grouping
is enabled, only
fields that are specified as lane fields can be used as group fields.
public void setLaneGroupByField(java.lang.String laneGroupByField)
canGroupLanes
set to true,
this is a field name or array of field names on which to group the lanes in a timeline.laneGroupByField
- New laneGroupByField value. Default value is nullpublic java.lang.String getLaneGroupByField()
canGroupLanes
set to true,
this is a field name or array of field names on which to group the lanes in a timeline.public void setLaneGroupByField(java.lang.String... laneGroupByField)
canGroupLanes
set to true,
this is a field name or array of field names on which to group the lanes in a timeline.laneGroupByField
- New laneGroupByField value. Default value is nullpublic java.lang.String[] getLaneGroupByFieldAsStringArray()
canGroupLanes
set to true,
this is a field name or array of field names on which to group the lanes in a timeline.public void setLaneNameField(java.lang.String laneNameField) throws java.lang.IllegalStateException
lane
in
which this event will be displayed in Timeline
s and in the day view
, if showDayLanes
is true.laneNameField
- New laneNameField value. Default value is "lane"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdCalendarEvent
public java.lang.String getLaneNameField()
lane
in
which this event will be displayed in Timeline
s and in the day view
, if showDayLanes
is true.CalendarEvent
public void setLanes(Lane... lanes)
Lane
definitions that represent the rows of the timelineView
, or the columns of the dayView
if showDayLanes
is true.
lanes
in the current calendar view. Only has an effect in timeline views
, and in day views
when showDayLanes
is true.lanes
- array of lanes to display. Default value is nullpublic Lane[] getLanes()
Lane
definitions that represent the rows of the timelineView
, or the columns of the dayView
if showDayLanes
is true.public void setLeadingDateField(java.lang.String leadingDateField) throws java.lang.IllegalStateException
trailingDateField
are present in the data, a line
extends out from the event showing the extent of the leading and trailing dates - useful for visualizing a pipeline of
events where some can be moved a certain amount without affecting others.leadingDateField
- New leadingDateField value. Default value is "leadingDate"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdCalendarEvent
public java.lang.String getLeadingDateField()
trailingDateField
are present in the data, a line
extends out from the event showing the extent of the leading and trailing dates - useful for visualizing a pipeline of
events where some can be moved a certain amount without affecting others.CalendarEvent
public TabSet getMainView() throws java.lang.IllegalStateException
TabSet
for managing calendar views when multiple views are available (eg, day
and month
).
This component is an AutoChild named "mainView". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public void setMinimalUI(boolean minimalUI)
minimalUI
- New minimalUI value. Default value is falsepublic boolean getMinimalUI()
public void setMinimumDayHeight(java.lang.Integer minimumDayHeight)
month view
when showDayHeaders
is true, this is the minimum height
applied to a day cell and its header combined. If showDayHeaders
is false, this attribute has no effect
- the minimum height of day cells is either an equal share of the available height, or the rendered height of the
cell's HTML content, whichever is greater. If the latter, a vertical scrollbar is shown.
minimumDayHeight
- New minimumDayHeight value. Default value is 80Appearance overview and related methods
public java.lang.Integer getMinimumDayHeight()
month view
when showDayHeaders
is true, this is the minimum height
applied to a day cell and its header combined. If showDayHeaders
is false, this attribute has no effect
- the minimum height of day cells is either an equal share of the available height, or the rendered height of the
cell's HTML content, whichever is greater. If the latter, a vertical scrollbar is shown.
Appearance overview and related methods
public void setMinLaneWidth(java.lang.Integer minLaneWidth) throws java.lang.IllegalStateException
vertical lanes
in the dayView
, this attribute sets the minimum width of each column
or field.minLaneWidth
- New minLaneWidth value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Integer getMinLaneWidth()
vertical lanes
in the dayView
, this attribute sets the minimum width of each column
or field.public void setMinutesPerRow(java.lang.Integer minutesPerRow) throws java.lang.IllegalStateException
day
and week
views. The default of 30 minutes shows two rows per
hour. Note that this value must divide into 60.minutesPerRow
- New minutesPerRow value. Default value is 30java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Integer getMinutesPerRow()
day
and week
views. The default of 30 minutes shows two rows per
hour. Note that this value must divide into 60.public NavigationButton getMonthButton() throws java.lang.IllegalStateException
NavigationButton
that appears to the left of other navigation controls in the
controls bar
on Handset devices. Used to show
and hide the month view
on devices with limited
space.
This component is an AutoChild named "monthButton". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public void setMonthButtonTitle(java.lang.String monthButtonTitle) throws java.lang.IllegalStateException
month button
, used for showing and
hiding the month view
on Handsets. This is a
dynamic string - text within ${...}
are dynamic variables and will be evaluated as JS code when the
message is displayed.
Only one dynamic variable, monthName, is available and represents the name of the month containing the currently selected date.
The default value is a left-facing arrow followed by the Month-name of the selected date.
When the month view is already visible, the title for the month button is set according to the value
of backButtonTitle
.
monthButtonTitle
- New monthButtonTitle value. Default value is "< ${monthName}"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdHTMLString
public java.lang.String getMonthButtonTitle()
month button
, used for showing and
hiding the month view
on Handsets. This is a
dynamic string - text within ${...}
are dynamic variables and will be evaluated as JS code when the
message is displayed.
Only one dynamic variable, monthName, is available and represents the name of the month containing the currently selected date.
The default value is a left-facing arrow followed by the Month-name of the selected date.
When the month view is already visible, the title for the month button is set according to the value
of backButtonTitle
.
HTMLString
public void setMonthMoreEventsLinkTitle(java.lang.String monthMoreEventsLinkTitle) throws java.lang.IllegalStateException
month view
when there are too many events to be displayed at once. This is a dynamic string - text within
${...}
are dynamic variables and will be evaluated as JS code when the message is displayed.
Only one dynamic variable, eventCount, is available and represents the number of events that are not currently displayed and that will appear in the menu displayed when the More Events link is clicked.
The default value is a string like "+ 3 more...".
monthMoreEventsLinkTitle
- New monthMoreEventsLinkTitle value. Default value is "+ ${eventCount} more..."java.lang.IllegalStateException
- this property cannot be changed after the component has been createdHTMLString
public java.lang.String getMonthMoreEventsLinkTitle()
month view
when there are too many events to be displayed at once. This is a dynamic string - text within
${...}
are dynamic variables and will be evaluated as JS code when the message is displayed.
Only one dynamic variable, eventCount, is available and represents the number of events that are not currently displayed and that will appear in the menu displayed when the More Events link is clicked.
The default value is a string like "+ 3 more...".
HTMLString
public Menu getMonthMoreEventsMenu() throws java.lang.IllegalStateException
more events
link in a cell of the monthView
. Items in this menu represent additional events,
not already displayed in the cell, and clicking them fires the eventClick
notification.
This component is an AutoChild named "monthMoreEventsMenu". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public CalendarView getMonthView() throws java.lang.IllegalStateException
CalendarView
used to display events that pertain to a given month.
This component is an AutoChild named "monthView". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public void setMonthViewTitle(java.lang.String monthViewTitle) throws java.lang.IllegalStateException
month view
.monthViewTitle
- New monthViewTitle value. Default value is "Month"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getMonthViewTitle()
month view
.public void setNameField(java.lang.String nameField) throws java.lang.IllegalStateException
CalendarEvent
.nameField
- New nameField value. Default value is "name"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdCalendarEvent
public java.lang.String getNameField()
CalendarEvent
.CalendarEvent
public ImgButton getNextButton() throws java.lang.IllegalStateException
ImgButton
that appears above the week/day/month views of the calendar and allows
the user to move the calendar forwards in time.
This component is an AutoChild named "nextButton". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public void setNextButtonHoverText(java.lang.String nextButtonHoverText) throws java.lang.IllegalStateException
next
toolbar buttonnextButtonHoverText
- New nextButtonHoverText value. Default value is "Next"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getNextButtonHoverText()
next
toolbar buttonpublic void setOtherDayBlankStyle(java.lang.String otherDayBlankStyle) throws java.lang.IllegalStateException
month view
, when showOtherDays
is false.otherDayBlankStyle
- New otherDayBlankStyle value. Default value is "calMonthOtherDayBlank"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdCSSStyleName
,
Appearance overview and related methods
public java.lang.String getOtherDayBlankStyle()
month view
, when showOtherDays
is false.CSSStyleName
,
Appearance overview and related methods
public void setOtherDayBodyBaseStyle(java.lang.String otherDayBodyBaseStyle)
See CellStyleSuffixes
for details on how stateful suffixes are combined with the base style to
generate stateful cell styles.
otherDayBodyBaseStyle
- New otherDayBodyBaseStyle value. Default value is "calMonthOtherDayBody"CSSStyleName
,
Appearance overview and related methods
public java.lang.String getOtherDayBodyBaseStyle()
See CellStyleSuffixes
for details on how stateful suffixes are combined with the base style to
generate stateful cell styles.
CSSStyleName
,
Appearance overview and related methods
public void setOtherDayHeaderBaseStyle(java.lang.String otherDayHeaderBaseStyle)
See CellStyleSuffixes
for details on how stateful suffixes are combined with the base style to
generate stateful cell styles.
otherDayHeaderBaseStyle
- New otherDayHeaderBaseStyle value. Default value is "calMonthDayHeader"CSSStyleName
,
Appearance overview and related methods
public java.lang.String getOtherDayHeaderBaseStyle()
See CellStyleSuffixes
for details on how stateful suffixes are combined with the base style to
generate stateful cell styles.
CSSStyleName
,
Appearance overview and related methods
public void setOverlapSortSpecifiers(SortSpecifier... overlapSortSpecifiers)
sort-specifiers
for customizing the render order of events that
overlap. In timelines
, this dictates the vertical rendering
order of overlapped events in each lane
.
In day
and week
views, it dictates the horizontal rendering order of
overlapped events in each column or Lane.
By default, events that share space in a Lane or column are rendered from
top to bottom, or left to right according to their start-dates
- the earliest in a given lane appears
top-most in that lane, or left-most in its column.
Providing overlapSortSpecifiers
allows for the
events to be ordered by one or more of the fields stored on the events, or in the underlying data-source
, if the Calendar is databound.
overlapSortSpecifiers
- New overlapSortSpecifiers value. Default value is nullpublic SortSpecifier[] getOverlapSortSpecifiers()
sort-specifiers
for customizing the render order of events that
overlap. In timelines
, this dictates the vertical rendering
order of overlapped events in each lane
.
In day
and week
views, it dictates the horizontal rendering order of
overlapped events in each column or Lane.
By default, events that share space in a Lane or column are rendered from
top to bottom, or left to right according to their start-dates
- the earliest in a given lane appears
top-most in that lane, or left-most in its column.
Providing overlapSortSpecifiers
allows for the
events to be ordered by one or more of the fields stored on the events, or in the underlying data-source
, if the Calendar is databound.
public ImgButton getPreviousButton() throws java.lang.IllegalStateException
ImgButton
that appears above the week/day/month views of the calendar and allows
the user to move the calendar backwards in time.
This component is an AutoChild named "previousButton". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public void setPreviousButtonHoverText(java.lang.String previousButtonHoverText) throws java.lang.IllegalStateException
previous
toolbar button.previousButtonHoverText
- New previousButtonHoverText value. Default value is "Previous"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getPreviousButtonHoverText()
previous
toolbar button.public IButton getRemoveButton() throws java.lang.IllegalStateException
com.smartgwt.client.types.AutoChild
of type IButton
, used to permanently
remove an event from the eventEditor
.
This component is an AutoChild named "removeButton". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public void setRemoveButtonTitle(java.lang.String removeButtonTitle) throws java.lang.IllegalStateException
Remove button
in the event editor
.removeButtonTitle
- New removeButtonTitle value. Default value is "Remove Event"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdHTMLString
public java.lang.String getRemoveButtonTitle()
Remove button
in the event editor
.HTMLString
public void setRenderEventsOnDemand(boolean renderEventsOnDemand) throws java.lang.IllegalStateException
event
is rendered as it
appears in the viewport. If set to false, all events are rendered up-front, whenever the current range changes.renderEventsOnDemand
- New renderEventsOnDemand value. Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic boolean getRenderEventsOnDemand()
event
is rendered as it
appears in the viewport. If set to false, all events are rendered up-front, whenever the current range changes.public void setRowHeight(int rowHeight)
rowHeight
- New rowHeight value. Default value is 20public int getRowHeight()
public void setRowTitleFrequency(java.lang.Integer rowTitleFrequency) throws java.lang.IllegalStateException
day
and week
. The default of 60 minutes shows titles on the first
row of each hour. The value provided must be a multiple of minutesPerRow
and be no larger than 60.rowTitleFrequency
- New rowTitleFrequency value. Default value is 60java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Integer getRowTitleFrequency()
day
and week
. The default of 60 minutes shows titles on the first
row of each hour. The value provided must be a multiple of minutesPerRow
and be no larger than 60.public IButton getSaveButton() throws java.lang.IllegalStateException
com.smartgwt.client.types.AutoChild
of type IButton
, used to save an
event from the eventEditor
.
This component is an AutoChild named "saveButton". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public void setSaveButtonTitle(java.lang.String saveButtonTitle) throws java.lang.IllegalStateException
saveButtonTitle
- New saveButtonTitle value. Default value is "Save Event"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdHTMLString
public java.lang.String getSaveButtonTitle()
HTMLString
public void setScrollToWorkday(java.lang.Boolean scrollToWorkday) throws java.lang.IllegalStateException
workday hours
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.scrollToWorkday
- New scrollToWorkday value. Default value is falsejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getScrollToWorkday()
workday hours
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.public void setSelectChosenDate(java.lang.Boolean selectChosenDate)
chosenDate
in a
selected style in the month view
Has no effect in
other views.selectChosenDate
- New selectChosenDate value. Default value is trueVisibility overview and related methods
public java.lang.Boolean getSelectChosenDate()
chosenDate
in a
selected style in the month view
Has no effect in
other views.Visibility overview and related methods
public void setSelectedCellStyle(java.lang.String selectedCellStyle)
selectedCellStyle
- New selectedCellStyle value. Default value is "calendarCellSelected"CSSStyleName
,
Appearance overview and related methods
public java.lang.String getSelectedCellStyle()
CSSStyleName
,
Appearance overview and related methods
public void setShowAddEventButton(java.lang.Boolean showAddEventButton)
Add Event
button.showAddEventButton
- New showAddEventButton value. Default value is nullpublic java.lang.Boolean getShowAddEventButton()
Add Event
button.public void setShowCellHovers(java.lang.Boolean showCellHovers) throws java.lang.IllegalStateException
showViewHovers
is true, dictates whether to
display hover prompts when the mouse rolls over the normal cells in the body of CalendarViews. The content of the
hover is determined by a call to getCellHoverHTML()
, which can be overridden to return custom results; by default, it returns the cell's date as a
string.
showCellHovers
- New showCellHovers value. Default value is falsejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowCellHovers()
showViewHovers
is true, dictates whether to
display hover prompts when the mouse rolls over the normal cells in the body of CalendarViews. The content of the
hover is determined by a call to getCellHoverHTML()
, which can be overridden to return custom results; by default, it returns the cell's date as a
string.
public void setShowControlsBar(java.lang.Boolean showControlsBar) throws java.lang.IllegalStateException
controlsBar
will be hidden, so the autoChildren (previousButton
, dateLabel
, nextButton
, addEventButton
, and datePickerButton
) will not be created or shown.showControlsBar
- New showControlsBar value. Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowControlsBar()
controlsBar
will be hidden, so the autoChildren (previousButton
, dateLabel
, nextButton
, addEventButton
, and datePickerButton
) will not be created or shown.public void setShowDateChooser(java.lang.Boolean showDateChooser) throws java.lang.IllegalStateException
dateChooser
is displayed.showDateChooser
- New showDateChooser value. Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdVisibility overview and related methods
public java.lang.Boolean getShowDateChooser()
dateChooser
is displayed.Visibility overview and related methods
public void setShowDatePickerButton(java.lang.Boolean showDatePickerButton)
datePickerButton
that
allows selecting a new base date for this Calendar.showDatePickerButton
- New showDatePickerButton value. Default value is nullpublic java.lang.Boolean getShowDatePickerButton()
datePickerButton
that
allows selecting a new base date for this Calendar.public void setShowDayHeaders(java.lang.Boolean showDayHeaders) throws java.lang.IllegalStateException
month view
, with both cells having a minimum combined height
of minimumDayHeight
. If false, the header
cells will not be shown, and the value of minimumDayHeight
is ignored. This causes the available vertical space in month views to be shared equally between day
cells, such that no vertical scrollbar is required unless the HTML in the cells renders them taller than will fit.showDayHeaders
- New showDayHeaders value. Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdVisibility overview and related methods
public java.lang.Boolean getShowDayHeaders()
month view
, with both cells having a minimum combined height
of minimumDayHeight
. If false, the header
cells will not be shown, and the value of minimumDayHeight
is ignored. This causes the available vertical space in month views to be shared equally between day
cells, such that no vertical scrollbar is required unless the HTML in the cells renders them taller than will fit.Visibility overview and related methods
public void setShowDayLanes(java.lang.Boolean showDayLanes) throws java.lang.IllegalStateException
day view
uses lanes
to render multiple vertical "lanes" within the day, very
much like a vertical Timeline
. Day lanes are useful for showing events for various entities on the same day - agendas for various staff members, for example, or delivery schedules for a fleet of trucks.
Each day lane is self-contained, showing in a column with a header and individual events are
placed in appropriate lanes
, respecting padding and
overlapping. If canEditEvents
is true, events
can be drag-moved or drag-resized from their top and bottom edges, within the containing lane. To allow events to be
dragged from one lane into another, see canEditLane
.
If this method is called after the component has been drawn/initialized:
Changes the view mode
of the day view at runtime - whether to show a normal day column for the chosenDate
, or the specified set of vertical lanes
.
showDayLanes
- whether or not to show lanes in the day view. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowDayLanes()
day view
uses lanes
to render multiple vertical "lanes" within the day, very
much like a vertical Timeline
. Day lanes are useful for showing events for various entities on the same day - agendas for various staff members, for example, or delivery schedules for a fleet of trucks.
Each day lane is self-contained, showing in a column with a header and individual events are
placed in appropriate lanes
, respecting padding and
overlapping. If canEditEvents
is true, events
can be drag-moved or drag-resized from their top and bottom edges, within the containing lane. To allow events to be
dragged from one lane into another, see canEditLane
.
public void setShowDayView(java.lang.Boolean showDayView) throws java.lang.IllegalStateException
showDayView
- New showDayView value. Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdAppearance overview and related methods
public java.lang.Boolean getShowDayView()
Appearance overview and related methods
public void setShowDetailFields(java.lang.Boolean showDetailFields) throws java.lang.IllegalStateException
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.
setShowDetailFields
in interface DataBoundComponent
showDetailFields
- New showDetailFields value. Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdDatabinding overview and related methods
public java.lang.Boolean getShowDetailFields()
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.
getShowDetailFields
in interface DataBoundComponent
Databinding overview and related methods
public void setShowDragHovers(java.lang.Boolean showDragHovers)
showViewHovers
is true, dictates whether to
display hover prompts when an event is being dragged with the mouse. The content of the hover is determined by a
call to getDragHoverHTML()
, which can be
overridden to return custom results; by default, it returns the date range of the drag canvas as a string.
showDragHovers
- New showDragHovers value. Default value is falsepublic java.lang.Boolean getShowDragHovers()
showViewHovers
is true, dictates whether to
display hover prompts when an event is being dragged with the mouse. The content of the hover is determined by a
call to getDragHoverHTML()
, which can be
overridden to return custom results; by default, it returns the date range of the drag canvas as a string.
public void setShowEventDescriptions(boolean showEventDescriptions) throws java.lang.IllegalStateException
canvas
for an event, whether to
show the body area
, typically containing brief
details of the event - by default
, its description
. The default is true - if set to
false, the event's header
will fill the canvas.
showEventDescriptions
- New showEventDescriptions value. Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic boolean getShowEventDescriptions()
canvas
for an event, whether to
show the body area
, typically containing brief
details of the event - by default
, its description
. The default is true - if set to
false, the event's header
will fill the canvas.
public void setShowEventHeaders(boolean showEventHeaders) throws java.lang.IllegalStateException
canvas
for an event, whether to
show the header area
, typically containing
suitable title text - by default
, the event's
name
. The default is true - if set to false, the
event's body area
will fill the canvas.
showEventHeaders
- New showEventHeaders value. Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic boolean getShowEventHeaders()
canvas
for an event, whether to
show the header area
, typically containing
suitable title text - by default
, the event's
name
. The default is true - if set to false, the
event's body area
will fill the canvas.
public void setShowEventHovers(java.lang.Boolean showEventHovers)
showViewHovers
is true, dictates whether to
display hover prompts when the mouse moves over an event canvas
in a calendarView. The content of the hover is determined by a call to getCellHoverHTML()
, which can be overridden to return
custom results.
showEventHovers
- New showEventHovers value. Default value is truepublic java.lang.Boolean getShowEventHovers()
showViewHovers
is true, dictates whether to
display hover prompts when the mouse moves over an event canvas
in a calendarView. The content of the hover is determined by a call to getCellHoverHTML()
, which can be overridden to return
custom results.
public void setShowHeaderHovers(java.lang.Boolean showHeaderHovers) throws java.lang.IllegalStateException
showViewHovers
is true, dictates whether to
display hover prompts when the mouse rolls over the header levels
in a CalendarView
. The content of the hover is
determined by a call to getHeaderHoverHTML()
,
which can be overridden to return custom results;
showHeaderHovers
- New showHeaderHovers value. Default value is falsejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowHeaderHovers()
showViewHovers
is true, dictates whether to
display hover prompts when the mouse rolls over the header levels
in a CalendarView
. The content of the hover is
determined by a call to getHeaderHoverHTML()
,
which can be overridden to return custom results;
public void setShowIndicators(java.lang.Boolean showIndicators)
indicators
into
timeline views
.showIndicators
- New showIndicators value. Default value is nullpublic java.lang.Boolean getShowIndicators()
indicators
into
timeline views
.public void setShowIndicatorsInFront(boolean showIndicatorsInFront) throws java.lang.IllegalStateException
indicator lines
are showing, this attribute
affects where in the z-order their canvases will be rendered: either in front of, or behind normal calendar events.showIndicatorsInFront
- New showIndicatorsInFront value. Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic boolean getShowIndicatorsInFront()
indicator lines
are showing, this attribute
affects where in the z-order their canvases will be rendered: either in front of, or behind normal calendar events.public void setShowLabelColumn(boolean showLabelColumn) throws java.lang.IllegalStateException
CalendarView
s.showLabelColumn
- New showLabelColumn value. Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic boolean getShowLabelColumn()
CalendarView
s.public void setShowLaneFieldHovers(java.lang.Boolean showLaneFieldHovers)
showViewHovers
is true, dictates whether to
display hover prompts when the mouse moves over the cells in a laneField
. The content of the hover is determined by a
call to getCellHoverHTML()
, which can be
overridden to return custom results. Note that getCellHoverHTML() is also called when the mouse moves over cells if
showCellHovers
is true - when called for a
laneField, no "date" parameter is passed to that method.
showLaneFieldHovers
- New showLaneFieldHovers value. Default value is falsepublic java.lang.Boolean getShowLaneFieldHovers()
showViewHovers
is true, dictates whether to
display hover prompts when the mouse moves over the cells in a laneField
. The content of the hover is determined by a
call to getCellHoverHTML()
, which can be
overridden to return custom results. Note that getCellHoverHTML() is also called when the mouse moves over cells if
showCellHovers
is true - when called for a
laneField, no "date" parameter is passed to that method.
public void setShowLaneRollOver(java.lang.Boolean showLaneRollOver)
Timelines
, and day views
with showDayLanes
set, to highlight the Lane under the mouse
with the "Over" style.showLaneRollOver
- New showLaneRollOver value. Default value is nullpublic java.lang.Boolean getShowLaneRollOver()
Timelines
, and day views
with showDayLanes
set, to highlight the Lane under the mouse
with the "Over" style.public void setShowMonthButton(java.lang.Boolean showMonthButton)
Month
button from
displaying on Handset devices.showMonthButton
- New showMonthButton value. Default value is nullpublic java.lang.Boolean getShowMonthButton()
Month
button from
displaying on Handset devices.public void setShowMonthView(java.lang.Boolean showMonthView) throws java.lang.IllegalStateException
showMonthView
- New showMonthView value. Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdAppearance overview and related methods
public java.lang.Boolean getShowMonthView()
Appearance overview and related methods
public void setShowNextButton(java.lang.Boolean showNextButton)
Next
button.showNextButton
- New showNextButton value. Default value is nullpublic java.lang.Boolean getShowNextButton()
Next
button.public void setShowOtherDays(java.lang.Boolean showOtherDays) throws java.lang.IllegalStateException
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.showOtherDays
- New showOtherDays value. Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdVisibility overview and related methods
public java.lang.Boolean getShowOtherDays()
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.Visibility overview and related methods
public void setShowPreviousButton(java.lang.Boolean showPreviousButton)
Previous
button.showPreviousButton
- New showPreviousButton value. Default value is nullpublic java.lang.Boolean getShowPreviousButton()
Previous
button.public void setShowQuickEventDialog(java.lang.Boolean showQuickEventDialog) throws java.lang.IllegalStateException
showQuickEventDialog
- New showQuickEventDialog value. Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdEditing overview and related methods
public java.lang.Boolean getShowQuickEventDialog()
Editing overview and related methods
public void setShowTimelineView(java.lang.Boolean showTimelineView)
Timeline view
.showTimelineView
- New showTimelineView value. Default value is falsepublic java.lang.Boolean getShowTimelineView()
Timeline view
.public void setShowViewHovers(java.lang.Boolean showViewHovers)
See showEventHovers
, showZoneHovers
, showHeaderHovers
, showCellHovers
, showLaneFieldHovers
, showDragHovers
for further configuration options.
If this method is called after the component has been drawn/initialized:
Switches the various levels of hovers
on or off at runtime.
showViewHovers
- whether to allow CalendarViews to show hovers. Default value is truepublic java.lang.Boolean getShowViewHovers()
See showEventHovers
, showZoneHovers
, showHeaderHovers
, showCellHovers
, showLaneFieldHovers
, showDragHovers
for further configuration options.
public void setShowWeekends(java.lang.Boolean showWeekends)
week
,
month
and timeline
views, and disallows the creation of events on
weekends. Which days are considered weekends is controlled by weekendDays
.
showWeekends
at runtime.showWeekends
- whether or not to show weekends. Default value is trueVisibility overview and related methods
public java.lang.Boolean getShowWeekends()
week
,
month
and timeline
views, and disallows the creation of events on
weekends. Which days are considered weekends is controlled by weekendDays
.Visibility overview and related methods
public void setShowWeekView(java.lang.Boolean showWeekView) throws java.lang.IllegalStateException
showWeekView
- New showWeekView value. Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdAppearance overview and related methods
public java.lang.Boolean getShowWeekView()
Appearance overview and related methods
public void setShowWorkday(java.lang.Boolean showWorkday) throws java.lang.IllegalStateException
workdayBaseStyle
for cells falling within the workday as defined by workdayStart
and workdayEnd
, in both the weekView
and dayView
. The hours of the workday can be customized for
particular dates by providing implementations of getWorkdayStart()
and getWorkdayEnd()
.
showWorkday
- New showWorkday value. Default value is falsejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowWorkday()
workdayBaseStyle
for cells falling within the workday as defined by workdayStart
and workdayEnd
, in both the weekView
and dayView
. The hours of the workday can be customized for
particular dates by providing implementations of getWorkdayStart()
and getWorkdayEnd()
.
public void setShowZoneHovers(java.lang.Boolean showZoneHovers)
showViewHovers
is true, dictates whether to
display hover prompts when the mouse moves over a zone
in
a calendarView. When showCellHovers
is true,
this attribute is ignored and zone hovers are not displayed.
The content of the hover is determined by a call to
getZoneHoverHTML()
, which can be overridden to
return custom results.
showZoneHovers
- New showZoneHovers value. Default value is truepublic java.lang.Boolean getShowZoneHovers()
showViewHovers
is true, dictates whether to
display hover prompts when the mouse moves over a zone
in
a calendarView. When showCellHovers
is true,
this attribute is ignored and zone hovers are not displayed.
The content of the hover is determined by a call to
getZoneHoverHTML()
, which can be overridden to
return custom results.
public void setShowZones(java.lang.Boolean showZones)
zones
into timeline views
.showZones
- New showZones value. Default value is nullpublic java.lang.Boolean getShowZones()
zones
into timeline views
.public void setSizeEventsToGrid(java.lang.Boolean sizeEventsToGrid) throws java.lang.IllegalStateException
sizeEventsToGrid
- New sizeEventsToGrid value. Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getSizeEventsToGrid()
public void setStartDate(java.util.Date startDate) throws java.lang.IllegalStateException
timeline view
. Has no effect in
other views. If not specified, defaults to a timeline starting from the beginning of the current timelineGranularity
and spanning a default of 20
columns of that granularity.
To set different start and end
dates after initial
draw, see setTimelineRange
.
Note that the
value you provide may be automatically altered if showing header-levels
, to fit to header boundaries.
startDate
- New startDate value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.util.Date getStartDate()
timeline view
. Has no effect in
other views. If not specified, defaults to a timeline starting from the beginning of the current timelineGranularity
and spanning a default of 20
columns of that granularity.
To set different start and end
dates after initial
draw, see setTimelineRange
.
Note that the
value you provide may be automatically altered if showing header-levels
, to fit to header boundaries.
public void setStartDateField(java.lang.String startDateField) throws java.lang.IllegalStateException
CalendarEvent
.startDateField
- New startDateField value. Default value is "startDate"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdCalendarEvent
public java.lang.String getStartDateField()
CalendarEvent
.CalendarEvent
public void setSublaneNameField(java.lang.String sublaneNameField) throws java.lang.IllegalStateException
sublane
in
which this event will be displayed, within its parent Lane, in Timeline
s
and in the day view
, if showDayLanes
is true.sublaneNameField
- New sublaneNameField value. Default value is "sublane"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getSublaneNameField()
sublane
in
which this event will be displayed, within its parent Lane, in Timeline
s
and in the day view
, if showDayLanes
is true.public void setTimelineGranularity(TimeUnit timelineGranularity) throws java.lang.IllegalStateException
timelineView
will
display events. Possible values are those available in the built-in TimeUnit
type.timelineGranularity
- New timelineGranularity value. Default value is "day"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic TimeUnit getTimelineGranularity()
timelineView
will
display events. Possible values are those available in the built-in TimeUnit
type.public void setTimelineUnitsPerColumn(int timelineUnitsPerColumn) throws java.lang.IllegalStateException
timelineGranularity
each
cell represents.timelineUnitsPerColumn
- New timelineUnitsPerColumn value. Default value is 1java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getTimelineUnitsPerColumn()
timelineGranularity
each
cell represents.public CalendarView getTimelineView() throws java.lang.IllegalStateException
CalendarView
used to display events in lanes in a horizontal Timeline
view.
This component is an AutoChild named "timelineView". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public void setTimelineViewTitle(java.lang.String timelineViewTitle) throws java.lang.IllegalStateException
timeline view
.timelineViewTitle
- New timelineViewTitle value. Default value is "Timeline"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getTimelineViewTitle()
timeline view
.public void setTodayBackgroundColor(java.lang.String todayBackgroundColor) throws java.lang.IllegalStateException
CalendarView
s.todayBackgroundColor
- New todayBackgroundColor value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getTodayBackgroundColor()
CalendarView
s.public void setTrailingDateField(java.lang.String trailingDateField) throws java.lang.IllegalStateException
leadingDateField
are present in the data, a line
extends out from the event showing the extent of the leading and trailing dates - useful for visualizing a pipeline of
events where some can be moved a certain amount without affecting others.trailingDateField
- New trailingDateField value. Default value is "trailingDate"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdCalendarEvent
public java.lang.String getTrailingDateField()
leadingDateField
are present in the data, a line
extends out from the event showing the extent of the leading and trailing dates - useful for visualizing a pipeline of
events where some can be moved a certain amount without affecting others.CalendarEvent
public void setTwentyFourHourTime(java.lang.Boolean twentyFourHourTime) throws java.lang.IllegalStateException
local formatter
is
installed, causes the Calendar to choose an appropriate builtin formatter.twentyFourHourTime
- New twentyFourHourTime value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getTwentyFourHourTime()
local formatter
is
installed, causes the Calendar to choose an appropriate builtin formatter.public void setUseEventCanvasRolloverControls(boolean useEventCanvasRolloverControls) throws java.lang.IllegalStateException
close buttons
and the
horizontal
and vertical
resizer widgets for event canvases are
shown only when the mouse is over a given event. Set this attribute to false to have event canvases show these widgets
permanently.useEventCanvasRolloverControls
- New useEventCanvasRolloverControls value. Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic boolean getUseEventCanvasRolloverControls()
close buttons
and the
horizontal
and vertical
resizer widgets for event canvases are
shown only when the mouse is over a given event. Set this attribute to false to have event canvases show these widgets
permanently.public void setUseSublanes(java.lang.Boolean useSublanes) throws java.lang.IllegalStateException
useSublanes
- New useSublanes value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getUseSublanes()
public void setWeekendDays(int... weekendDays)
globally
.weekendDays
- New weekendDays value. Default value is nullVisibility overview and related methods
public int[] getWeekendDays()
globally
.Visibility overview and related methods
public void setWeekEventBorderOverlap(java.lang.Boolean weekEventBorderOverlap) throws java.lang.IllegalStateException
weekEventBorderOverlap
- New weekEventBorderOverlap value. Default value is falsejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdAppearance overview and related methods
public java.lang.Boolean getWeekEventBorderOverlap()
Appearance overview and related methods
public void setWeekPrefix(java.lang.String weekPrefix) throws java.lang.IllegalStateException
week-based
HeaderLevel
s when this calendar is showing a timeline.weekPrefix
- New weekPrefix value. Default value is "Week"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdHTMLString
public java.lang.String getWeekPrefix()
week-based
HeaderLevel
s when this calendar is showing a timeline.HTMLString
public CalendarView getWeekView() throws java.lang.IllegalStateException
CalendarView
used to display events that pertain to a given week.
This component is an AutoChild named "weekView". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public void setWeekViewTitle(java.lang.String weekViewTitle) throws java.lang.IllegalStateException
week view
.weekViewTitle
- New weekViewTitle value. Default value is "Week"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getWeekViewTitle()
week view
.public void setWorkdayBaseStyle(java.lang.String workdayBaseStyle) throws java.lang.IllegalStateException
showWorkday
is set, this is the style used for
cells that are within the workday, as defined by workdayStart
and workdayEnd
, or by a date-specific
range provided in getWorkdayStart()
and getWorkdayEnd()
implementations.workdayBaseStyle
- New workdayBaseStyle value. Default value is "calendarWorkday"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdCSSStyleName
,
Appearance overview and related methods
public java.lang.String getWorkdayBaseStyle()
showWorkday
is set, this is the style used for
cells that are within the workday, as defined by workdayStart
and workdayEnd
, or by a date-specific
range provided in getWorkdayStart()
and getWorkdayEnd()
implementations.CSSStyleName
,
Appearance overview and related methods
public ZoneCanvas getZoneCanvas()
Using AutoChildren
for details.
AutoChild component created for each zone
entry.
public void setZones(CalendarEvent... zones)
timeline views
. Each zone renders out a zone canvas
, a special, non-interactive subclass of EventCanvas
, which spans all lanes and draws behind any normal, interactive
events in the zorder. The default style
for
these components renders them semi-transparent and with a bottom-aligned title label.
If this method is called after the component has been drawn/initialized:
Sets the zones
used to highlight areas of this calendar.
zones
- array of zones to display. Default value is nullpublic CalendarEvent[] getZones()
timeline views
. Each zone renders out a zone canvas
, a special, non-interactive subclass of EventCanvas
, which spans all lanes and draws behind any normal, interactive
events in the zorder. The default style
for
these components renders them semi-transparent and with a bottom-aligned title label.
public void setZoneStyleName(java.lang.String zoneStyleName)
zoneStyleName
- New zoneStyleName value. Default value is "zoneCanvas"CSSStyleName
public java.lang.String getZoneStyleName()
CSSStyleName
public void setZoneTitleOrientation(VerticalAlignment zoneTitleOrientation) throws java.lang.IllegalStateException
zone
.zoneTitleOrientation
- New zoneTitleOrientation value. Default value is "bottom"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic VerticalAlignment getZoneTitleOrientation()
zone
.public void addCalendarEvent(CalendarEvent event)
In all cases, the event
passed as the first parameter must have at least a start date
set. If the calendar is showing lanes
, the name of the lane
and, if applicable, the sublane
, must also be set.
event
- the new calendar event to addpublic void addCalendarEvent(CalendarEvent event, java.util.Map customValues)
In all cases, the event
passed as the first parameter must have at least a start date
set. If the calendar is showing lanes
, the name of the lane
and, if applicable, the sublane
, must also be set.
event
- the new calendar event to addcustomValues
- additional, custom values to be saved with the eventpublic void addIndicator(CalendarEvent indicator)
indicator
to the calendar.indicator
- a new indicator to add to the calendarpublic void addLane(Lane lane)
Lane
to the calendar, for display in the timeline view
, and in the day view
if showDayLanes
is true.lane
- a new Lane object to add to the calendarpublic void addLaneEvent(Lane laneName, java.util.Date startDate)
addCalendarEvent()
Timeline
s, and for dayView
with showDayLanes
set, creates a new event and adds it to a
particular Lane
.laneName
- the Lane in which to add this eventstartDate
- start date of event, or CalendarEvent Objectpublic void addLaneEvent(Lane laneName, java.util.Date startDate, java.util.Date endDate)
public void addLaneEvent(Lane laneName, java.util.Date startDate, java.util.Date endDate, java.lang.String name)
public void addLaneEvent(Lane laneName, java.util.Date startDate, java.util.Date endDate, java.lang.String name, java.lang.String description)
public void addLaneEvent(Lane laneName, java.util.Date startDate, java.util.Date endDate, java.lang.String name, java.lang.String description, java.lang.Object otherFields)
addCalendarEvent()
Timeline
s, and for dayView
with showDayLanes
set, creates a new event and adds it to a
particular Lane
.laneName
- the Lane in which to add this eventstartDate
- start date of event, or CalendarEvent ObjectendDate
- end date of eventname
- name of eventdescription
- description of eventotherFields
- new values of additional fields to be updatedpublic void addZone(CalendarEvent zone)
zone
to the calendar.zone
- a new zone to add to the calendarpublic com.google.gwt.event.shared.HandlerRegistration addBackgroundClickHandler(BackgroundClickHandler handler)
Callback fired when the mouse is clicked in a background-cell, ie, one without an event.
addBackgroundClickHandler
in interface HasBackgroundClickHandlers
handler
- the backgroundClick handlerHandlerRegistration
used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addBackgroundMouseDownHandler(BackgroundMouseDownHandler handler)
Callback fired when the mouse button is depressed over a background-cell, ie, one without an event. Call BackgroundMouseDownEvent.cancel()
from within BackgroundMouseDownHandler.onBackgroundMouseDown(com.smartgwt.client.widgets.calendar.events.BackgroundMouseDownEvent)
to cancel the default
behavior of allowing sweep selection via dragging.
addBackgroundMouseDownHandler
in interface HasBackgroundMouseDownHandlers
handler
- the backgroundMouseDown handlerHandlerRegistration
used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addBackgroundMouseUpHandler(BackgroundMouseUpHandler handler)
Notification method fired when the mouse button is released over a background-cell, ie, one without an event. Call
BackgroundMouseUpEvent.cancel()
from within BackgroundMouseUpHandler.onBackgroundMouseUp(com.smartgwt.client.widgets.calendar.events.BackgroundMouseUpEvent)
to cancel the default behavior
of showing a dialog to add a new event with the passed dates.
addBackgroundMouseUpHandler
in interface HasBackgroundMouseUpHandlers
handler
- the backgroundMouseUp handlerHandlerRegistration
used to remove this handlerpublic void cancelEditing()
dialog
or editor
and clearing any visible edit-selection from the
current CalendarView
.public com.google.gwt.event.shared.HandlerRegistration addCurrentViewChangedHandler(CurrentViewChangedHandler handler)
Notification that fires whenever the current view changes via the mainView tabset
.
addCurrentViewChangedHandler
in interface HasCurrentViewChangedHandlers
handler
- the currentViewChanged handlerHandlerRegistration
used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addDateChangedHandler(DateChangedHandler handler)
Fires whenever the user changes the current date, including picking a specific date or navigating to a new week or month.
addDateChangedHandler
in interface HasDateChangedHandlers
handler
- the dateChanged handlerHandlerRegistration
used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addDayBodyClickHandler(DayBodyClickHandler 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. Call DayBodyClickEvent.cancel()
from within DayBodyClickHandler.onDayBodyClick(com.smartgwt.client.widgets.calendar.events.DayBodyClickEvent)
to cancel this action.
Not called if
the day falls outside the current month and Calendar.showOtherDays
is false.
addDayBodyClickHandler
in interface HasDayBodyClickHandlers
handler
- the dayBodyClick handlerHandlerRegistration
used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addDayHeaderClickHandler(DayHeaderClickHandler 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. Call DayHeaderClickEvent.cancel()
from within
DayHeaderClickHandler.onDayHeaderClick(com.smartgwt.client.widgets.calendar.events.DayHeaderClickEvent)
to cancel this action.
Not called if the day falls outside the current month and Calendar.showOtherDays
is false.
addDayHeaderClickHandler
in interface HasDayHeaderClickHandlers
handler
- the dayHeaderClick handlerHandlerRegistration
used to remove this handlerpublic java.lang.Boolean deselectEvent(CalendarEvent event)
event
- the event to deselectpublic java.lang.Boolean deselectEvents(CalendarEvent... events)
events
- the events to deselectpublic com.google.gwt.event.shared.HandlerRegistration addEventAddedHandler(EventAddedHandler handler)
Notification fired whenever a user adds an event.
In a calendar with a DataSource, eventAdded() fires after the event has been successfully added at the server
addEventAddedHandler
in interface HasEventAddedHandlers
handler
- the eventAdded handlerHandlerRegistration
used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addEventChangedHandler(EventChangedHandler 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
addEventChangedHandler
in interface HasEventChangedHandlers
handler
- the eventChanged handlerHandlerRegistration
used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addEventClickHandler(EventClickHandler 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 that can be edited. Call CalendarEventClick.cancel()
from within EventClickHandler.onEventClick(com.smartgwt.client.widgets.calendar.events.CalendarEventClick)
to cancel the default action. This is a good
place to, for example, show a completely customized event dialog instead of the default one.
addEventClickHandler
in interface HasEventClickHandlers
handler
- the eventClick handlerHandlerRegistration
used to remove this handlerpublic boolean eventMoved(java.util.Date newDate, CalendarEvent event, java.lang.String newLane)
Calendar.eventRepositionStop()
newDate
- new start date and time that the event is being moved toevent
- the event as it will be after this movementnewLane
- the name of the lane into which the event was movedpublic com.google.gwt.event.shared.HandlerRegistration addEventRemoveClickHandler(EventRemoveClickHandler handler)
Called whenever the close icon of an event canvas
is clicked in
the day
, week
and timeline
views, or when the remove button
is pressed in the event editor
.
Implement this method to intercept the
automatic removal of data. You can Call CalendarEventRemoveClick.cancel()
from within EventRemoveClickHandler.onEventRemoveClick(com.smartgwt.client.widgets.calendar.events.CalendarEventRemoveClick)
to prevent the default action
(calling removeEvent()
) and instead take action of
your own. For example, returning false from this method and then showing a custom confirmation dialog - if the user
cancels, do nothing, otherwise make a call to removeEvent(event)
, passing the event.
addEventRemoveClickHandler
in interface HasEventRemoveClickHandlers
handler
- the eventRemoveClick handlerHandlerRegistration
used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addEventRemovedHandler(EventRemovedHandler 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
addEventRemovedHandler
in interface HasEventRemovedHandlers
handler
- the eventRemoved handlerHandlerRegistration
used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addEventRepositionMoveHandler(EventRepositionMoveHandler handler)
Notification called whenever the drop position of an event being drag-moved changes.
The newEvent
parameter represents the event as it will be after the move, including start
and end
dates and lane
and sublane
where applicable.
Call EventRepositionMove.cancel()
from within EventRepositionMoveHandler.onEventRepositionMove(com.smartgwt.client.widgets.calendar.events.EventRepositionMove)
to prevent the default
action, of positioning the drag canvas to the newEvent.
addEventRepositionMoveHandler
in interface HasEventRepositionMoveHandlers
handler
- the eventRepositionMove handlerHandlerRegistration
used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addEventRepositionStopHandler(EventRepositionStopHandler handler)
Notification called when an event being drag-moved is dropped.
The newEvent
parameter represents the
event as it will be after the move, including start
and end
dates and lane
and sublane
where applicable.
Call EventRepositionStop.cancel()
from within EventRepositionStopHandler.onEventRepositionStop(com.smartgwt.client.widgets.calendar.events.EventRepositionStop)
to prevent the default
action, of actually updating
the event.
addEventRepositionStopHandler
in interface HasEventRepositionStopHandlers
handler
- the eventRepositionStop handlerHandlerRegistration
used to remove this handlerpublic boolean eventResized(java.util.Date newDate, CalendarEvent event)
Calendar.eventResizeStop()
newDate
- new end date and time that event is being resized toevent
- the event as it will be after this resizepublic com.google.gwt.event.shared.HandlerRegistration addEventResizeMoveHandler(EventResizeMoveHandler handler)
Notification called on each resize during an event drag-resize operation.
The newEvent
parameter
represents the event as it will be after the resize.
Call EventResizeMove.cancel()
from within EventResizeMoveHandler.onEventResizeMove(com.smartgwt.client.widgets.calendar.events.EventResizeMove)
to prevent the default action, of
resizing the drag canvas to the newEvent.
addEventResizeMoveHandler
in interface HasEventResizeMoveHandlers
handler
- the eventResizeMove handlerHandlerRegistration
used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addEventResizeStopHandler(EventResizeStopHandler handler)
Notification called when an event drag-resize operation completes.
The newEvent
parameter represents
the event as it will be after the move.
Call EventResizeStop.cancel()
from within EventResizeStopHandler.onEventResizeStop(com.smartgwt.client.widgets.calendar.events.EventResizeStop)
to prevent the default action, of
actually updating
the event.
addEventResizeStopHandler
in interface HasEventResizeStopHandlers
handler
- the eventResizeStop handlerHandlerRegistration
used to remove this handlerpublic void eventsRendered()
public java.lang.Integer getActiveDay()
getActiveTime()
public java.util.Date getActiveTime()
public java.util.Date getCellDate()
To determine the date at a more specific point within a cell, see getDateFromPoint()
.
public java.util.Date getCellDate(java.lang.Integer rowNum)
getCellDate()
public java.util.Date getCellDate(java.lang.Integer rowNum, java.lang.Integer colNum)
getCellDate()
public java.util.Date getCellDate(java.lang.Integer rowNum, java.lang.Integer colNum, CalendarView view)
To determine the date at a more specific point within a cell, see getDateFromPoint()
.
rowNum
- the row number to get the date forcolNum
- the column number to get the date forview
- the view to use - uses the selected view if not passedpublic java.lang.String getCellHoverHTML(CalendarView view, Record record, java.lang.Integer rowNum, java.lang.Integer colNum, java.util.Date date, java.lang.String defaultValue)
laneField
being hovered over. Override here to return custom HTML for the passed cell.
view
- the CalendarView the mouse is hovered overrecord
- The record containing the cell being hoveredrowNum
- The rowNum of the cell being hoveredcolNum
- the colNum of the cell being hovereddate
- the snap-date at the mouse, which may be different from the result of a call to getCellDate
defaultValue
- the default hover text for the passed valuesHTMLString
public java.lang.String getDateCellAlign(java.util.Date date, java.lang.Integer rowNum, java.lang.Integer colNum, CalendarView view)
getDateHTML
returns a value, this method returns
the horizontal alignment for that value in its cell, in the passed view.date
- the date to get the cell-alignment forrowNum
- the row number containing the date to get the cell-alignment forcolNum
- the column number containing the date to get the cell-alignment forview
- the relevant CalendarViewHTMLString
getDateHTML(java.util.Date, java.lang.Integer, java.lang.Integer, com.smartgwt.client.widgets.calendar.CalendarView)
,
getDateCellVAlign(java.util.Date, java.lang.Integer, java.lang.Integer, com.smartgwt.client.widgets.calendar.CalendarView)
,
getDateStyle(java.util.Date, java.lang.Integer, java.lang.Integer, com.smartgwt.client.widgets.calendar.CalendarView)
,
getDateCSSText(java.util.Date, java.lang.Integer, java.lang.Integer, com.smartgwt.client.widgets.calendar.CalendarView)
public java.lang.String getDateCellVAlign(java.util.Date date, java.lang.Integer rowNum, java.lang.Integer colNum, CalendarView view)
getDateHTML
returns a value, this method returns
the vertical alignment for that value in its cell, in the passed view.date
- the date to get the cell-alignment forrowNum
- the row number containing the date to get the cell-alignment forcolNum
- the column number containing the date to get the cell-alignment forview
- the relevant CalendarViewHTMLString
getDateHTML(java.util.Date, java.lang.Integer, java.lang.Integer, com.smartgwt.client.widgets.calendar.CalendarView)
,
getDateCellAlign(java.util.Date, java.lang.Integer, java.lang.Integer, com.smartgwt.client.widgets.calendar.CalendarView)
,
getDateStyle(java.util.Date, java.lang.Integer, java.lang.Integer, com.smartgwt.client.widgets.calendar.CalendarView)
,
getDateCSSText(java.util.Date, java.lang.Integer, java.lang.Integer, com.smartgwt.client.widgets.calendar.CalendarView)
public java.lang.String getDateCSSText(java.util.Date date, java.lang.Integer rowNum, java.lang.Integer colNum, CalendarView view)
"CSS text" means semicolon-separated style settings, suitable for inclusion in a CSS stylesheet or in a STYLE attribute of an HTML element.
date
- the date to return CSS text forrowNum
- the row number containing the date to get the CSS forcolNum
- the column number containing the date to get the CSS forview
- the relevant CalendarViewgetDateHTML(java.util.Date, java.lang.Integer, java.lang.Integer, com.smartgwt.client.widgets.calendar.CalendarView)
,
getDateStyle(java.util.Date, java.lang.Integer, java.lang.Integer, com.smartgwt.client.widgets.calendar.CalendarView)
public java.util.Date getDateFromPoint()
If
snapOffsets is passed as false, returns the date representing the exact position of the passed offsets. If unset or
passed as true, returns the date at the nearest eventSnapGap to the left, for Timeline
s, or above for day
and week
views.
If neither x nor y offsets are passed, assumes them from the last mouse event.
If the cell at the eventual offsets is not a date-cell, returns null.
Note that, for the month view
, this method is
functionally equivalent to getCellDate()
, which
determines the date associated with a cell, without the additional offset precision offered here.
public java.util.Date getDateFromPoint(java.lang.Integer x)
getDateFromPoint()
public java.util.Date getDateFromPoint(java.lang.Integer x, java.lang.Integer y)
getDateFromPoint()
public java.util.Date getDateFromPoint(java.lang.Integer x, java.lang.Integer y, java.lang.Boolean snapOffsets)
getDateFromPoint()
public java.util.Date getDateFromPoint(java.lang.Integer x, java.lang.Integer y, java.lang.Boolean snapOffsets, CalendarView view)
If
snapOffsets is passed as false, returns the date representing the exact position of the passed offsets. If unset or
passed as true, returns the date at the nearest eventSnapGap to the left, for Timeline
s, or above for day
and week
views.
If neither x nor y offsets are passed, assumes them from the last mouse event.
If the cell at the eventual offsets is not a date-cell, returns null.
Note that, for the month view
, this method is
functionally equivalent to getCellDate()
, which
determines the date associated with a cell, without the additional offset precision offered here.
x
- the x offset into the body of the selected view - non-functional for the day view
. If this param and "y" are both unset,
assumes both offsets from the last mouse event.y
- the y offset into the body of the selected view - non-functional for the timeline view
. If this param and "x" are
both unset, assumes both offsets from the last mouse event.snapOffsets
- whether to snap the offsets to the nearest eventSnapGap - if unset, the default is trueview
- the view to use - or the selected view if not passedpublic java.lang.String getDateHeaderTitle(java.util.Date date, int dayOfWeek, java.lang.String defaultValue, CalendarView view)
date
- the date to return the header-title for - note that the month view
does not pass this parameter
because a single column represents multiple datesdayOfWeek
- the week-day number of the passed date, except for the month view
, where no date is passed,
because the week-day number represents multiple dates.defaultValue
- the default header-title for the passed date and viewview
- the relevant CalendarViewpublic java.lang.String getDateHTML(java.util.Date date, java.lang.Integer rowNum, java.lang.Integer colNum, CalendarView view)
month view
has default cell HTML, controlled via getDayBodyHTML()
.date
- the date to get the HTML forrowNum
- the row number containing the date to get the HTML forcolNum
- the column number containing the date to get the HTML forview
- the relevant CalendarViewHTMLString
getDateCellAlign(java.util.Date, java.lang.Integer, java.lang.Integer, com.smartgwt.client.widgets.calendar.CalendarView)
,
getDateCellVAlign(java.util.Date, java.lang.Integer, java.lang.Integer, com.smartgwt.client.widgets.calendar.CalendarView)
,
getDateStyle(java.util.Date, java.lang.Integer, java.lang.Integer, com.smartgwt.client.widgets.calendar.CalendarView)
,
getDateCSSText(java.util.Date, java.lang.Integer, java.lang.Integer, com.smartgwt.client.widgets.calendar.CalendarView)
,
getDayBodyHTML(java.util.Date, com.smartgwt.client.widgets.calendar.CalendarEvent[], com.smartgwt.client.widgets.calendar.Calendar, int, int)
public java.lang.String getDateStyle(java.util.Date date, java.lang.Integer rowNum, java.lang.Integer colNum, CalendarView view)
date
- the date to return the CSS styleName forrowNum
- the row number containing the date to get the CSS styleName forcolNum
- the column number containing the date to get the CSS styleName forview
- the relevant CalendarViewCSSStyleName
getDateHTML(java.util.Date, java.lang.Integer, java.lang.Integer, com.smartgwt.client.widgets.calendar.CalendarView)
,
getDateCSSText(java.util.Date, java.lang.Integer, java.lang.Integer, com.smartgwt.client.widgets.calendar.CalendarView)
public java.lang.String getDragHoverHTML(CalendarView view, CalendarEvent event, java.lang.String defaultValue)
view
- the CalendarView the mouse is hovered overevent
- the CalendarEvent attached to the EventCanvas being draggeddefaultValue
- the default text for the passed valuesHTMLString
public java.lang.String getEventBodyHTML(CalendarEvent event)
description
field
.event
- the event to get the description text forHTMLString
public java.lang.String getEventBodyHTML(CalendarEvent event, CalendarView view)
description
field
.event
- the event to get the description text forview
- the view in which the event is being renderedHTMLString
public MenuItem[] getEventCanvasMenuItems(EventCanvas canvas)
items
applicable to the passed canvas and its event. If an array with valid entries is returned, the rollover context button
is shown for the passed
canvas.canvas
- the canvas to get menu items forpublic java.lang.String getEventCanvasStyle(CalendarEvent event)
styleName
to use for the passed event
, in the passed view
. By default, returns the style on the event
, if one is specified - otherwise, in
lane-based
views, it returns the style specified on the
lane or sublane
, or the style specified on the
calendar
.event
- the event to get the CSS style forCSSStyleName
public java.lang.String getEventCanvasStyle(CalendarEvent event, CalendarView view)
styleName
to use for the passed event
, in the passed view
. By default, returns the style on the event
, if one is specified - otherwise, in
lane-based
views, it returns the style specified on the
lane or sublane
, or the style specified on the
calendar
.event
- the event to get the CSS style forview
- the CalendarView that contains the canvas being styledCSSStyleName
public java.util.Date getEventEndDate(CalendarEvent event)
end date
of the passed event. If the
event is duration-based
, the result is
calculated from the start date
and the
specified duration
and unit
.event
- the event to get the start date ofpublic java.lang.String getEventHeaderHTML(CalendarEvent event)
Month view
. The default implementation returns the
event's name field
for timelines, and that same value
pre-pended with the event's start
for day, week
and month views.
event
- the event to get the description text forHTMLString
public java.lang.String getEventHeaderHTML(CalendarEvent event, CalendarView view)
Month view
. The default implementation returns the
event's name field
for timelines, and that same value
pre-pended with the event's start
for day, week
and month views.
event
- the event to get the description text forview
- the view in which the event is being renderedHTMLString
public java.lang.String getEventHoverHTML(CalendarEvent event, EventCanvas eventCanvas, CalendarView view)
event
- The event being hoveredeventCanvas
- the event canvas being hovered overview
- the CalendarView in which the eventCanvas livesHTMLString
public java.lang.String getEventHoverHTML(CalendarEvent event, EventCanvas eventCanvas, CalendarView view, java.lang.String defaultValue)
event
- The event being hoveredeventCanvas
- the event canvas being hovered overview
- the CalendarView in which the eventCanvas livesdefaultValue
- the default HTML to show when hovering over the passed eventHTMLString
public Lane getEventLane(CalendarEvent event)
lane
associated with the passed event, in the passed viewevent
- the event to get the lane forpublic Lane getEventLane(CalendarEvent event, CalendarView view)
lane
associated with the passed event, in the passed viewevent
- the event to get the lane forview
- the view to get the lane object frompublic void getEventLength(CalendarEvent event)
event
in the passed