publish
IT2BE Calendar Bean info


Servoy Properties Summary
Boolean allowEventCategoryChange
String bgcolor
Boolean calendarAllDayAreaEnabled
String calendarBgcolor
Number calendarCategoryColumnWidth
String calendarCategoryHeaderBgcolor
Boolean calendarCompressed
String calendarCurrentBgcolor
String calendarDateHeaderFormat
String calendarHorizontalLineEvenColor
String calendarHorizontalLineOddColor
Number calendarHourDisplayFormat
String calendarInactiveBgcolor
String calendarInactiveRange
Number calendarMonthHeaderAlignment
String calendarMonthHeaderFormat
Number calendarScale
String calendarSelectionBgcolor
String calendarSelectionMouseOverColor
String calendarSubRowLineColor
Number calendarTimeInterval
String calendarTodayBgcolor
Number calendarType
String calendarVerticalLineEvenColor
String calendarVerticalLineOddColor
Number calendarView
Boolean calendarVisible
String calendarWeekendBgcolor
String categoryHeaderText
String categoryHeaderToolTip
String categoryTreeBgcolor
Boolean categoryTreeVisible
Boolean clearInformationOnEventExit
Date date
String datePickerBgcolor
String datePickerSelectionBgcolor
Boolean datePickerVisible
String datePickerWeekendBgcolor
Number dividerCenterLocation
Number dividerLeftLocation
Boolean dividerOneTouchExpandable
Number dividerRightLocation
Number dividerSize
Number eventAllDayShape
Boolean eventAllDayUseRecurrenceIcon
Number eventCategoryColor
Number eventDuration
Boolean eventGanttUseRecurrenceIcon
Number eventMagnet
Number eventMonthShape
Boolean eventMonthSpanDay
Boolean eventMonthUseRecurrenceIcon
Boolean eventMouseOverOnTop
Boolean eventMovable
Boolean eventResizable
Boolean eventSelectedOnTop
Number eventShape
Number eventTransparancy
Boolean eventUseRecurrenceIcon
String fgcolor
Object filterCalendarCategories
Boolean filterCategoryLabelSelected
Boolean filterChildrenCategoriesOnly
Number firstDayOfWorkWeek
Boolean ganttCategoryHeaderGrow
Number ganttDayTimeInterval
Number ganttWeekTimeInterval
Number getCalendarColumnAreaWidth
ICCategorySet getClonedCategorySet
Number getGanttCategoryHeaderHeight
Number getGanttCategoryHeaderWidth
Number getHeight
Date getVisibleEndDate
String getVisibleFilter
Date getVisibleStartDate
Number getWidth
String headerBgcolor
String headerFgcolor
String headerFont
String informationBgcolor
String informationFgcolor
Boolean informationVisible
Number locationX
Number locationY
Number minimumEventSize
String name
Boolean overlapEvents
Boolean overrideThemeColors
Boolean scaleButtonVisible
Boolean showCalendarAllDayEvents
Boolean showCalendarCategories
Boolean showCalendarHeaderDate
Boolean showCalendarMonthHeader
String timeScaleBgcolor
String toolbarBgcolor
Number toolbarSpacerWidth
Array<Object> toolbarToolTips
Boolean toolbarVisible
Boolean transparent
Number usedTheme
Boolean visible


Servoy Methods Summary
void clearCalendarPopupMenu( )
void clearCalendarSelectedDateRange( )
void clearEventPopupMenu( )
Object getCategoryIdByName( Object )
ICEvent getEvent( Object )
ICEventSet getEventSetForDateRange( Date, Date, Boolean )
Array<Object> getSelectedCategories( )
Array<Object> getSelectedCategories( Boolean )
ICEventSet getVisibleEventSet( Boolean )
Boolean isCategoryExpanded( Object )
Boolean isCategorySelected( Object )
void onDrop( Function )
void overrideLocale( String, String )
void printCalendar( Boolean, String )
void printCalendar( )
void printCalendar( String )
void printCalendar( Boolean )
void removeCalendarDecoratorSet( )
void removeCategory( Object )
void removeCategorySet( )
void removeDecoratorSet( )
void removeEvent( Object )
void removeEventSet( )
void removeToolbarButton( String )
void revalidateCalendar( )
void scrollVisibleDateRange( Number )
void selectEvent( Object, Boolean )
void selectEvent( Object )
void setCalendarDecoratorSet( ICDecoratorSet )
void setCalendarDoubleClickedMethod( Function )
void setCalendarMouseReleasedMethod( Function )
void setCalendarPopupMenuItem( String, String, Object )
void setCalendarPopupMenuItem( String, String )
void setCalendarPopupMenuSeparator( )
void setCalendarRangeChangedMethod( Function )
void setCalendarRangeSelectedMethod( Function )
void setCalendarRightClickedMethod( Function )
void setCalendarSelectedDateRange( Date, Date )
void setCalendarViewPosition( Number )
void setCategory( ICCategory )
void setCategoryExpanded( Object, Boolean )
void setCategoryExpandedDeep( Object, Boolean )
void setCategoryExpandedMethod( Function )
void setCategorySelected( Object, Boolean )
void setCategorySelectedMethod( Function )
void setCategorySet( ICCategorySet )
void setEvent( ICEvent )
void setEventAllDayTemplate( Number )
void setEventChangedMethod( Function )
void setEventFont( String )
void setEventMonthFont( String )
void setEventMonthTemplate( Number )
void setEventOpenedMethod( Function )
void setEventPopupMenuItem( String, String )
void setEventPopupMenuItem( String, String, Object )
void setEventPopupMenuSeparator( )
void setEventRightClickedMethod( Function )
void setEventSelectedMethod( Function )
void setEventSet( ICEventSet )
void setEventTemplate( Number )
void setFont( String )
void setGanttCategoryHeaderSize( Number, Number )
void setGanttDecoratorSet( ICDecoratorSet )
void setInformation( String )
void setLocation( Number, Number )
void setOnDataChangedMethod( Function )
void setPopupMethod( Function )
void setSize( Number, Number )
void setToolTipMethod( Function, Object )
void setToolTipMethod( Function )
void setToolbarActionMethod( Function )
void setToolbarButton( String, String, Object )
void setToolbarButton( String, String )
void setToolbarButton( String )
void setToolbarButton( String, String, Object, Boolean )
void setToolbarButtonEnabled( String, Boolean )
void setToolbarButtonVisible( String, Boolean )
void setToolbarDefaultButton( Number, String )
void setToolbarDefaultButton( Number, String, Object, String, Boolean )
void setToolbarDefaultButton( Number, String, String, Boolean )
void setToolbarDefaultButton( Number, String, Object )
void setToolbarDefaultButtonEnabled( Number, Boolean )
void setToolbarDefaultButtonVisible( Number, Boolean )
void setToolbarSeparator( )
void setVisibleDateRange( Date, Date )
void toggleCategoryExpanded( Object )
void toggleCategorySelected( Object )


Servoy Properties Details


allowEventCategoryChange
Boolean  allowEventCategoryChange
Get/Set the event category allowed change state
Returns
Boolean  state boolean

Supported Clients
SmartClient


bgcolor
String  bgcolor
Get/Set the background color of the calendar.
Returns
String  color String

Supported Clients
SmartClient


calendarAllDayAreaEnabled
Boolean  calendarAllDayAreaEnabled
Get/Set the allday area enabled state
Returns
Boolean  state boolean

Supported Clients
SmartClient


calendarBgcolor
String  calendarBgcolor
Get/Set the background color of the calendar area.
Returns
String  color String

Supported Clients
SmartClient


calendarCategoryColumnWidth
Number  calendarCategoryColumnWidth
Get/Set the width of the category column when filtering (0 fits in panel, > 0 sets horizontal scrollbar).
Returns
Number  width int

Supported Clients
SmartClient


calendarCategoryHeaderBgcolor
String  calendarCategoryHeaderBgcolor
Get/Set the background color of the category header.
Returns
String  color String

Supported Clients
SmartClient


calendarCompressed
Boolean  calendarCompressed
Get/Set the calendar compressed state
Returns
Boolean  state boolean

Supported Clients
SmartClient


calendarCurrentBgcolor
String  calendarCurrentBgcolor
Get/Set the color for the current day/time cell.
Returns
String  color String

Supported Clients
SmartClient


calendarDateHeaderFormat
String  calendarDateHeaderFormat
Get/Set the format of the date header, can be set for more than one width e.g. "EEEE, MMMM d|EEE, MMM d|EEE|1E".
Returns
String  format String

Supported Clients
SmartClient


calendarHorizontalLineEvenColor
String  calendarHorizontalLineEvenColor
Get/Set the color of the 'full hour' lines.
Returns
String  color String

Supported Clients
SmartClient


calendarHorizontalLineOddColor
String  calendarHorizontalLineOddColor
Get/Set the color of the 'half hour' lines.
Returns
String  color String

Supported Clients
SmartClient


calendarHourDisplayFormat
Number  calendarHourDisplayFormat
Get/Set the format of the hours HH/hh H/h.
Returns
Number  format int

Supported Clients
SmartClient


calendarInactiveBgcolor
String  calendarInactiveBgcolor
Get/Set the background color of the inactive date range in the calendar area.
Returns
String  color String

Supported Clients
SmartClient


calendarInactiveRange
String  calendarInactiveRange
Get/Set the inactive range for the calendar area inactive background color or when compressed.
Returns
String  range String

Supported Clients
SmartClient


calendarMonthHeaderAlignment
Number  calendarMonthHeaderAlignment
Get/Set the alignment of the month (name and year) in the month view header (use the alignment properties in the Plug-in).
Returns
Number  alignment int

Supported Clients
SmartClient


calendarMonthHeaderFormat
String  calendarMonthHeaderFormat
Get/Set the format of the month (name and year) in the month view header.
Returns
String  format String

Supported Clients
SmartClient


calendarScale
Number  calendarScale
Get/Set the scale value of the calendar area.
Returns
Number  scale int

Supported Clients
SmartClient


calendarSelectionBgcolor
String  calendarSelectionBgcolor
Get/Set the background color of the selected date range in the calendar area.
Returns
String  color String

Supported Clients
SmartClient


calendarSelectionMouseOverColor
String  calendarSelectionMouseOverColor
Get/Set the mouse over color in the calendar area.
Returns
String  color String

Supported Clients
SmartClient


calendarSubRowLineColor
String  calendarSubRowLineColor
Get/Set the color of the category dividers.
Returns
String  color String

Supported Clients
SmartClient


calendarTimeInterval
Number  calendarTimeInterval
Get/Set the interval for the cell size.
Returns
Number  interval int

Supported Clients
SmartClient


calendarTodayBgcolor
String  calendarTodayBgcolor
Get/Set the today background color
Returns
String  color String

Supported Clients
SmartClient


calendarType
Number  calendarType
Get/Set the type to Calendar (0) or Gantt (1).
Returns
Number  type int

Supported Clients
SmartClient


calendarVerticalLineEvenColor
String  calendarVerticalLineEvenColor
Get/Set the color of the 'even' day lines.
Returns
String  color String

Supported Clients
SmartClient


calendarVerticalLineOddColor
String  calendarVerticalLineOddColor
Get/Set the color of the 'odd' day lines.
Returns
String  color String

Supported Clients
SmartClient


calendarView
Number  calendarView
Get/Set the calendar view to day, work week, week or month.
Returns
Number  view int

Supported Clients
SmartClient


calendarVisible
Boolean  calendarVisible
Get/Set the visibility of the calendar area.
Returns
Boolean  visible boolean

Supported Clients
SmartClient


calendarWeekendBgcolor
String  calendarWeekendBgcolor
Get/Set the background color of the weekend in the calendar area.
Returns
String  color String

Supported Clients
SmartClient


categoryHeaderText
String  categoryHeaderText
Get/Set the text for the category tree header.
Returns
String  text String

Supported Clients
SmartClient


categoryHeaderToolTip
String  categoryHeaderToolTip
Get/Set the tooltip for the category tree header.
Returns
String  tooltip String

Supported Clients
SmartClient


categoryTreeBgcolor
String  categoryTreeBgcolor
Get/Set the background color for the category tree.
Returns
String  color String

Supported Clients
SmartClient


categoryTreeVisible
Boolean  categoryTreeVisible
Get/Set the visibility of the category tree.
Returns
Boolean  visible boolean

Supported Clients
SmartClient


clearInformationOnEventExit
Boolean  clearInformationOnEventExit
Get/Set if the information should disappear when the mouse exit an event.
Returns
Boolean  clear boolean

Supported Clients
SmartClient


date
Date  date
Get/Set the date to show.
Returns
Date  date Date

Supported Clients
SmartClient


datePickerBgcolor
String  datePickerBgcolor
Get/Set the background color for the datepicker.
Returns
String  color String

Supported Clients
SmartClient


datePickerSelectionBgcolor
String  datePickerSelectionBgcolor
Get/Set the background color for the selection in the datepicker area.
Returns
String  color String

Supported Clients
SmartClient


datePickerVisible
Boolean  datePickerVisible
Get/Set the visibility of the datepicker area.
Returns
Boolean  visible boolean

Supported Clients
SmartClient


datePickerWeekendBgcolor
String  datePickerWeekendBgcolor
Get/Set the background color for the weekend in the datepicker area.
Returns
String  color String

Supported Clients
SmartClient


dividerCenterLocation
Number  dividerCenterLocation
Get/Set the location for the center (vertical) divider.
Returns
Number  location int

Supported Clients
SmartClient


dividerLeftLocation
Number  dividerLeftLocation
Get/Set the location for the left (horizontal) divider.
Returns
Number  location int

Supported Clients
SmartClient


dividerOneTouchExpandable
Boolean  dividerOneTouchExpandable
Get/Set the dividers to be expandable in one touch.
Returns
Boolean  expandable boolean

Supported Clients
SmartClient


dividerRightLocation
Number  dividerRightLocation
Get/Set the location for the right (horizontal) divider.
Returns
Number  location int

Supported Clients
SmartClient


dividerSize
Number  dividerSize
Get/Set the size of the dividers.
Returns
Number  size int

Supported Clients
SmartClient


eventAllDayShape
Number  eventAllDayShape
Get/Set the shape of the allday event in the calendar: 0 - 4.
Returns
Number  shape int

Supported Clients
SmartClient


eventAllDayUseRecurrenceIcon
Boolean  eventAllDayUseRecurrenceIcon
Get/Set a recurrence icon in an event in an allday view.
Returns
Boolean  use boolean

Supported Clients
SmartClient


eventCategoryColor
Number  eventCategoryColor
Get/Set the event category color (user or category).
Returns
Number  color index int

Supported Clients
SmartClient


eventDuration
Number  eventDuration
Get/Set the default duration of an event.
Returns
Number  duration int

Supported Clients
SmartClient


eventGanttUseRecurrenceIcon
Boolean  eventGanttUseRecurrenceIcon
Get/Set a recurrence icon in an event in a gantt view.
Returns
Boolean  use boolean

Supported Clients
SmartClient


eventMagnet
Number  eventMagnet
Get/Set the event magnet.
Returns
Number  magnet int

Supported Clients
SmartClient


eventMonthShape
Number  eventMonthShape
Get/Set the shape of the month event in the calendar: 0 - 4.
Returns
Number  shape int

Supported Clients
SmartClient


eventMonthSpanDay
Boolean  eventMonthSpanDay
Get/Set the span in days of n event in month view
Returns
Boolean  span boolean

Supported Clients
SmartClient


eventMonthUseRecurrenceIcon
Boolean  eventMonthUseRecurrenceIcon
Get/Set a recurrence icon in an event in a month view.
Returns
Boolean  use boolean

Supported Clients
SmartClient


eventMouseOverOnTop
Boolean  eventMouseOverOnTop
Get/Set the event on top of other events on mouseover.
Returns
Boolean  top boolean

Supported Clients
SmartClient


eventMovable
Boolean  eventMovable
Get/Set the shape of the event to be movable or not.
Returns
Boolean  movable boolean

Supported Clients
SmartClient


eventResizable
Boolean  eventResizable
Get/Set the shape of the event to be resizable or not.
Returns
Boolean  resizable boolean

Supported Clients
SmartClient


eventSelectedOnTop
Boolean  eventSelectedOnTop
Get/Set the event on top of other events when selected.
Returns
Boolean  top boolean

Supported Clients
SmartClient


eventShape
Number  eventShape
Get/Set the shape of the calendar event in the calendar: 0 - 4.
Returns
Number  shape int

Supported Clients
SmartClient


eventTransparancy
Number  eventTransparancy
Get/Set the transparancy of the event background in the calendar: 0 - 255.
Returns
Number  transparancy int

Supported Clients
SmartClient


eventUseRecurrenceIcon
Boolean  eventUseRecurrenceIcon
Get/Set the use of a recurrence icon in an event shape.
Returns
Boolean  use boolean

Supported Clients
SmartClient


fgcolor
String  fgcolor
Get/Set the foreground color for the calendar.
Returns
String  color String

Supported Clients
SmartClient


filterCalendarCategories
Object  filterCalendarCategories
Get/Set the filter type for categories 0 - 4.
Returns
Object  filter Object

Supported Clients
SmartClient


filterCategoryLabelSelected
Boolean  filterCategoryLabelSelected
Get/Set filtering based on the selected category label(s) in the tree.
Returns
Boolean  filter boolean

Supported Clients
SmartClient


filterChildrenCategoriesOnly
Boolean  filterChildrenCategoriesOnly
Get/Set the use of children categories to be filtered
Returns
Boolean  filter boolean

Supported Clients
SmartClient


firstDayOfWorkWeek
Number  firstDayOfWorkWeek
Get/Set the first day of the workweek .
Returns
Number  day int

Supported Clients
SmartClient


ganttCategoryHeaderGrow
Boolean  ganttCategoryHeaderGrow
Get/Set category row headers of the Gantt view to grow with the size of the part.
Returns
Boolean  grow boolean

Supported Clients
SmartClient


ganttDayTimeInterval
Number  ganttDayTimeInterval
Get/Set Gantt view day/time interval
Returns
Number  interval int

Supported Clients
SmartClient


ganttWeekTimeInterval
Number  ganttWeekTimeInterval
Get/Set Gantt view week/time interval
Returns
Number  interval int

Supported Clients
SmartClient


getCalendarColumnAreaWidth
Number  getCalendarColumnAreaWidth
Get the width of the date area (without, when visible, 'west header').
Returns
Number  width int

Supported Clients
SmartClient


getClonedCategorySet
ICCategorySet  getClonedCategorySet
Clone a category set for further use
Returns
ICCategorySet  set ICCategorySet

Supported Clients
SmartClient


getGanttCategoryHeaderHeight
Number  getGanttCategoryHeaderHeight
Get the height of the Gantt category header.
Returns
Number  height int

Supported Clients
SmartClient


getGanttCategoryHeaderWidth
Number  getGanttCategoryHeaderWidth
Get the width of the Gantt category header.
Returns
Number  width int

Supported Clients
SmartClient


getHeight
Number  getHeight
Get the height of the calendar.
Returns
Number  height int

Supported Clients
SmartClient


getVisibleEndDate
Date  getVisibleEndDate
Get the end datetime of the calendar.
Returns
Date  date Date

Supported Clients
SmartClient


getVisibleFilter
String  getVisibleFilter
Get the string value of the filter as set in the category tree.
Returns
String  filter String

Supported Clients
SmartClient


getVisibleStartDate
Date  getVisibleStartDate
Get the visible start datetime of the calendar.
Returns
Date  date Date

Supported Clients
SmartClient


getWidth
Number  getWidth
Get the width of the calendar.
Returns
Number  width int

Supported Clients
SmartClient


headerBgcolor
String  headerBgcolor
Get/Set the background color of the header.
Returns
String  color String

Supported Clients
SmartClient


headerFgcolor
String  headerFgcolor
Get/Set the foreground color of the header.
Returns
String  color String

Supported Clients
SmartClient


headerFont
String  headerFont
Get/Set the textFont for the headers.
Returns
String  font String

Supported Clients
SmartClient


informationBgcolor
String  informationBgcolor
Get/Set the background color for the information panel.
Returns
String  color String

Supported Clients
SmartClient


informationFgcolor
String  informationFgcolor
Get/Set the foreground color for the information panel.
Returns
String  color String

Supported Clients
SmartClient


informationVisible
Boolean  informationVisible
Get/Set the visibility of the information panel.
Returns
Boolean  visible boolean

Supported Clients
SmartClient


locationX
Number  locationX
Get the x location of the calendar.
Returns
Number  x int

Supported Clients
SmartClient


locationY
Number  locationY
Get the y location of the calendar.
Returns
Number  y int

Supported Clients
SmartClient


minimumEventSize
Number  minimumEventSize
Get/Set the minimum event size
Returns
Number  int

Supported Clients
SmartClient


name
String  name
Get the name of the calendar.
Returns
String  name String

Supported Clients
SmartClient


overlapEvents
Boolean  overlapEvents
When set (default) overlapping events show on top of each other.
Returns
Boolean  overlap boolean

Supported Clients
SmartClient


overrideThemeColors
Boolean  overrideThemeColors
Override all theme colors with your own values.
Returns
Boolean  override boolean

Supported Clients
SmartClient


scaleButtonVisible
Boolean  scaleButtonVisible
Get/Set the visibility of the toolbar scalebutton.
Returns
Boolean  visible boolean

Supported Clients
SmartClient


showCalendarAllDayEvents
Boolean  showCalendarAllDayEvents
Get/Set all day event part to show or not (in calendar view).
Returns
Boolean  show boolean

Supported Clients
SmartClient


showCalendarCategories
Boolean  showCalendarCategories
Get/Set the calendar to show category headers and columns.
Returns
Boolean  show boolean

Supported Clients
SmartClient


showCalendarHeaderDate
Boolean  showCalendarHeaderDate
Get/Set to show the date in the header or not (in calendar view).
Returns
Boolean  show boolean

Supported Clients
SmartClient


showCalendarMonthHeader
Boolean  showCalendarMonthHeader
Show the month view header with the month (name and year).
Returns
Boolean  result boolean

Supported Clients
SmartClient


timeScaleBgcolor
String  timeScaleBgcolor
Get/Set the background color of the calendar timescale (west header).
Returns
String  color String

Supported Clients
SmartClient


toolbarBgcolor
String  toolbarBgcolor
Get/Set the background color of the toolbar.
Returns
String  color String

Supported Clients
SmartClient


toolbarSpacerWidth
Number  toolbarSpacerWidth
Get/Set the width of the spacer between toolbar button groups.
Returns
Number  width int

Supported Clients
SmartClient


toolbarToolTips
Array<Object>  toolbarToolTips
Get/Set the array of tooltips for the default toolbar buttons.
Returns
Array<Object>  tooltips Object[]

Supported Clients
SmartClient


toolbarVisible
Boolean  toolbarVisible
Get/Set the visibility of the toolbar.
Returns
Boolean  visible boolean

Supported Clients
SmartClient


transparent
Boolean  transparent
Get/Set the transparency
Returns
Boolean  tranparent boolean

Supported Clients
SmartClient


usedTheme
Number  usedTheme
Get/Set the theme to use to 'iCal', 'Outlook' or 'Classic'.
Returns
Number  theme Number

Supported Clients
SmartClient


visible
Boolean  visible
Get/Set the visibility
Returns
Boolean  visible oolean

Supported Clients
SmartClient

Servoy Methods Details


clearCalendarPopupMenu
void  clearCalendarPopupMenu( )
Set the calendar contextual menu.
Returns
void  

Supported Clients
SmartClient


clearCalendarSelectedDateRange
void  clearCalendarSelectedDateRange( )
Remove the selection in the calendar area per method.
Returns
void  

Supported Clients
SmartClient


clearEventPopupMenu
void  clearEventPopupMenu( )
Clear the event contextual menu.
Returns
void  

Supported Clients
SmartClient


getCategoryIdByName
Object  getCategoryIdByName( Object )
Get the id of a category by entering the name.
Parameters
Object  name  the name

Returns
Object  id Object

Supported Clients
SmartClient


getEvent
ICEvent  getEvent( Object )
Get the event by activity id
Parameters
Object  id  the activity id

Returns
ICEvent  event ICEvent

Supported Clients
SmartClient


getEventSetForDateRange
ICEventSet  getEventSetForDateRange( Date, Date, Boolean )
Retrieve events by date range and optionally use current filter (recurring events return their current dates and not base dates).
Parameters
Date  startDate  the start date
Date  endDate  the end date
Boolean  useFilter  the use filter

Returns
ICEventSet  set ICEventSet

Supported Clients
SmartClient


getSelectedCategories
Array<Object>  getSelectedCategories( )
Returns an array with all id's of selected users/categories (include optional boolean argument to include sub categories).
Returns
Array<Object>  Object[]

Supported Clients
SmartClient


getSelectedCategories
Array<Object>  getSelectedCategories( Boolean )
Returns an array with all id's of selected users/categories (include optional boolean argument to include sub categories).
Parameters
Boolean  include  the include

Returns
Array<Object>  Object[]

Supported Clients
SmartClient


getVisibleEventSet
ICEventSet  getVisibleEventSet( Boolean )
Retrieve visible events and optionally use current filter (recurring events return their current dates and not base dates).
Parameters
Boolean  useFilter  the use filter

Returns
ICEventSet  set ICEventSet

Supported Clients
SmartClient


isCategoryExpanded
Boolean  isCategoryExpanded( Object )
Find out if the category is expanded (by id).
Parameters
Object  id  the category id

Returns
Boolean  boolean

Supported Clients
SmartClient


isCategorySelected
Boolean  isCategorySelected( Object )
Find out if the category is selected (by id).
Parameters
Object  id  the category id

Returns
Boolean  selected boolean

Supported Clients
SmartClient


onDrop
void  onDrop( Function )
Set the callback method to execute on drop of an event.
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient


overrideLocale
void  overrideLocale( String, String )
Override locale settings like you would with I18N.
Parameters
String  language  the language
String  country  the country

Returns
void  

Supported Clients
SmartClient


printCalendar
void  printCalendar( Boolean, String )
Print the current daterange in a (non) modal dialog with the specified title.
Parameters
Boolean  modal  the modal
String  title  the title

Returns
void  

Supported Clients
SmartClient


printCalendar
void  printCalendar( )
Print the current daterange.
Returns
void  

Supported Clients
SmartClient


printCalendar
void  printCalendar( String )
Print the current daterange with the specified title.
Parameters
String  title  the title

Returns
void  

Supported Clients
SmartClient


printCalendar
void  printCalendar( Boolean )
Print the current daterange in a (non) modal dialog.
Parameters
Boolean  modal  the modal

Returns
void  

Supported Clients
SmartClient


removeCalendarDecoratorSet
void  removeCalendarDecoratorSet( )
Remove the current DecoratorSet.
Returns
void  

Supported Clients
SmartClient


removeCategory
void  removeCategory( Object )
Remove a category.
Parameters
Object  id  the id

Returns
void  

Supported Clients
SmartClient


removeCategorySet
void  removeCategorySet( )
Remove the category set
Returns
void  

Supported Clients
SmartClient


removeDecoratorSet
void  removeDecoratorSet( )
Remove the decorator set
Returns
void  

Supported Clients
SmartClient


removeEvent
void  removeEvent( Object )
Remove an event.
Parameters
Object  id  the id

Returns
void  

Supported Clients
SmartClient


removeEventSet
void  removeEventSet( )
Remove all events.
Returns
void  

Supported Clients
SmartClient


removeToolbarButton
void  removeToolbarButton( String )
Remove your own toolbar button(s).
Parameters
String  id  the id

Returns
void  

Supported Clients
SmartClient


revalidateCalendar
void  revalidateCalendar( )
Revalidate the calendar.
Returns
void  

Supported Clients
SmartClient


scrollVisibleDateRange
void  scrollVisibleDateRange( Number )
Scroll the daterange up or down by the entered (negative) number.
Parameters
Number  value  the value

Returns
void  

Supported Clients
SmartClient


selectEvent
void  selectEvent( Object, Boolean )
Select the event by id (Daterange has to be visible and Categories selected).
Parameters
Object  id  the id
Boolean  state  the selected state

Returns
void  

Supported Clients
SmartClient


selectEvent
void  selectEvent( Object )
Select the event by id (Daterange has to be visible and Categories selected).
Parameters
Object  id  the id

Returns
void  

Supported Clients
SmartClient


setCalendarDecoratorSet
void  setCalendarDecoratorSet( ICDecoratorSet )
Set or reset a set of decorators.
Parameters
ICDecoratorSet  set  the decorator set

Returns
void  

Supported Clients
SmartClient


setCalendarDoubleClickedMethod
void  setCalendarDoubleClickedMethod( Function )
Set the method to be executed when the calendar is double clicked.
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient


setCalendarMouseReleasedMethod
void  setCalendarMouseReleasedMethod( Function )
Set the method to be executed when the mouse is released.
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient


setCalendarPopupMenuItem
void  setCalendarPopupMenuItem( String, String, Object )
Set the popup menu item for the calendar contextual menu.
Parameters
String  id  the action id
String  label  the label
Object  icon  the icon

Returns
void  

Supported Clients
SmartClient


setCalendarPopupMenuItem
void  setCalendarPopupMenuItem( String, String )
Set the popup menu item for the calendar contextual menu.
Parameters
String  id  the action id
String  label  the label

Returns
void  

Supported Clients
SmartClient


setCalendarPopupMenuSeparator
void  setCalendarPopupMenuSeparator( )
Set the popup separator for the calendar contextual menu.
Returns
void  

Supported Clients
SmartClient


setCalendarRangeChangedMethod
void  setCalendarRangeChangedMethod( Function )
Set the method to be executed when the visible daterange changes.
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient


setCalendarRangeSelectedMethod
void  setCalendarRangeSelectedMethod( Function )
Set the method to be executed when the visible daterange changes.
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient


setCalendarRightClickedMethod
void  setCalendarRightClickedMethod( Function )
Set the callback method to be executed on a right click.
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient


setCalendarSelectedDateRange
void  setCalendarSelectedDateRange( Date, Date )
Select an date range in the calendar area per method.
Parameters
Date  start  the start date
Date  end  the end date

Returns
void  

Supported Clients
SmartClient


setCalendarViewPosition
void  setCalendarViewPosition( Number )
Scroll the vertical scrollbar to the give position (range 0-1, 0.5 is center)
Parameters
Number  position  the position

Returns
void  

Supported Clients
SmartClient


setCategory
void  setCategory( ICCategory )
Add or reset a category.
Parameters
ICCategory  category  the category

Returns
void  

Supported Clients
SmartClient


setCategoryExpanded
void  setCategoryExpanded( Object, Boolean )
Set a category expanded.
Parameters
Object  categoryId  the category id
Boolean  expanded  the expanded

Returns
void  

Supported Clients
SmartClient


setCategoryExpandedDeep
void  setCategoryExpandedDeep( Object, Boolean )
Set a category and it children expanded.
Parameters
Object  categoryId  the category id
Boolean  expanded  the expanded

Returns
void  

Supported Clients
SmartClient


setCategoryExpandedMethod
void  setCategoryExpandedMethod( Function )
Set the callback method to be executed when a node in the category tree is expanded.
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient


setCategorySelected
void  setCategorySelected( Object, Boolean )
Set a category selected.
Parameters
Object  categoryId  the category id
Boolean  selected  the selected

Returns
void  

Supported Clients
SmartClient


setCategorySelectedMethod
void  setCategorySelectedMethod( Function )
Set the callback method to be executed when a node in the category tree is selected.
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient


setCategorySet
void  setCategorySet( ICCategorySet )
Add or reset a set of categories.
Parameters
ICCategorySet  categorySet  the category set

Returns
void  

Supported Clients
SmartClient


setEvent
void  setEvent( ICEvent )
Set or reset an event.
Parameters
ICEvent  event  the event

Returns
void  

Supported Clients
SmartClient


setEventAllDayTemplate
void  setEventAllDayTemplate( Number )
Set the template for the All day events.
Parameters
Number  template  the template

Returns
void  

Supported Clients
SmartClient


setEventChangedMethod
void  setEventChangedMethod( Function )
Set the method to be executed when the event is changed in the calendar.
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient


setEventFont
void  setEventFont( String )
Set the font for the events.
Parameters
String  font  the text font

Returns
void  

Supported Clients
SmartClient


setEventMonthFont
void  setEventMonthFont( String )
Set the font for the month events.
Parameters
String  font  the text font

Returns
void  

Supported Clients
SmartClient


setEventMonthTemplate
void  setEventMonthTemplate( Number )
Set the template for the Month events.
Parameters
Number  template  the template

Returns
void  

Supported Clients
SmartClient


setEventOpenedMethod
void  setEventOpenedMethod( Function )
Set the callback method to be executed when the event is opened (double clicked).
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient


setEventPopupMenuItem
void  setEventPopupMenuItem( String, String )
Set the popup menu item for the event contextual menu.
Parameters
String  id  the action id
String  label  the label

Returns
void  

Supported Clients
SmartClient


setEventPopupMenuItem
void  setEventPopupMenuItem( String, String, Object )
Set the popup menu item for the event contextual menu.
Parameters
String  id  the action id
String  label  the label
Object  icon  the icon

Returns
void  

Supported Clients
SmartClient


setEventPopupMenuSeparator
void  setEventPopupMenuSeparator( )
Set the popup separator for the event contextual menu.
Returns
void  

Supported Clients
SmartClient


setEventRightClickedMethod
void  setEventRightClickedMethod( Function )
Set the callback method for a right click on an event
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient


setEventSelectedMethod
void  setEventSelectedMethod( Function )
Set the callback method to be executed when an event is selected.
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient


setEventSet
void  setEventSet( ICEventSet )
Add or reset a set of events.
Parameters
ICEventSet  set  the event set

Returns
void  

Supported Clients
SmartClient


setEventTemplate
void  setEventTemplate( Number )
Set the template for the events.
Parameters
Number  template  the template

Returns
void  

Supported Clients
SmartClient


setFont
void  setFont( String )
Set the font of the calendar. String is 'fontname,style,size' , style = (plain=0, bold=1, italic=2, bold-italic=3).
Parameters
String  font  the text font

Returns
void  

Supported Clients
SmartClient


setGanttCategoryHeaderSize
void  setGanttCategoryHeaderSize( Number, Number )
Set the size of the Gantt category header.
Parameters
Number  width  the width
Number  height  the height

Returns
void  

Supported Clients
SmartClient


setGanttDecoratorSet
void  setGanttDecoratorSet( ICDecoratorSet )
Set or reset a set of decorators.
Parameters
ICDecoratorSet  set  the decorator set

Returns
void  

Supported Clients
SmartClient


setInformation
void  setInformation( String )
Set the text for the information panel.
Parameters
String  message  the message

Returns
void  

Supported Clients
SmartClient


setLocation
void  setLocation( Number, Number )
Set the location of the calendar.
Parameters
Number  x  the x
Number  y  the y

Returns
void  

Supported Clients
SmartClient


setOnDataChangedMethod
void  setOnDataChangedMethod( Function )
Set the on data changed callback method
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient


setPopupMethod
void  setPopupMethod( Function )
Set the callback method to be executed when calling a contextual menu.
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient


setSize
void  setSize( Number, Number )
Set the size of the calendar.
Parameters
Number  width  the width
Number  height  the height

Returns
void  

Supported Clients
SmartClient


setToolTipMethod
void  setToolTipMethod( Function, Object )
Set the callback method to be executed that sets the tooltip.
Parameters
Function  method  the method
Object  showInformation  the show information

Returns
void  

Supported Clients
SmartClient


setToolTipMethod
void  setToolTipMethod( Function )
Set the callback method to be executed that sets the tooltip.
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient


setToolbarActionMethod
void  setToolbarActionMethod( Function )
Set the callback method to be executed for your toolbar buttons.
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient


setToolbarButton
void  setToolbarButton( String, String, Object )
Add or reset your own toolbar button(s).
Parameters
String  text  the text or actionId
String  tooltip  the tooltip
Object  image  the image

Returns
void  

Supported Clients
SmartClient


setToolbarButton
void  setToolbarButton( String, String )
Add or reset your own toolbar button(s).
Parameters
String  text  the text or actionId
String  tooltip  the tooltip

Returns
void  

Supported Clients
SmartClient


setToolbarButton
void  setToolbarButton( String )
Add or reset your own toolbar button(s).
Parameters
String  text  the text or actionId

Returns
void  

Supported Clients
SmartClient


setToolbarButton
void  setToolbarButton( String, String, Object, Boolean )
Add or reset your own toolbar button(s).
Parameters
String  text  the text or actionId
String  tooltip  the tooltip
Object  image  the image
Boolean  showText  the show text

Returns
void  

Supported Clients
SmartClient


setToolbarButtonEnabled
void  setToolbarButtonEnabled( String, Boolean )
Enable/disable the button in the toolbar (by actionID).
Parameters
String  text  the text or actionId
Boolean  enabled  the enabled

Returns
void  

Supported Clients
SmartClient


setToolbarButtonVisible
void  setToolbarButtonVisible( String, Boolean )
Set the visibility of the button in the toolbar (by actionID).
Parameters
String  text  the text or actionId
Boolean  visible  the visible

Returns
void  

Supported Clients
SmartClient


setToolbarDefaultButton
void  setToolbarDefaultButton( Number, String )
Set the tooltips and (optionally) the icons of the the default toolbar button(s).
Parameters
Number  index  the index
String  tooltip  the tooltip

Returns
void  

Supported Clients
SmartClient


setToolbarDefaultButton
void  setToolbarDefaultButton( Number, String, Object, String, Boolean )
Set the tooltip and the icon for a default toolbar button.
Parameters
Number  index  the index
String  tooltip  the tooltip
Object  image  the image
String  text  the text
Boolean  showText  the show text

Returns
void  

Supported Clients
SmartClient


setToolbarDefaultButton
void  setToolbarDefaultButton( Number, String, String, Boolean )
Set the tooltip and the icon for a default toolbar button.
Parameters
Number  index  the index
String  tooltip  the tooltip
String  text  the text
Boolean  showText  the show text

Returns
void  

Supported Clients
SmartClient


setToolbarDefaultButton
void  setToolbarDefaultButton( Number, String, Object )
Set the tooltip and the icon for a default toolbar button.
Parameters
Number  index  the index
String  tooltip  the tooltip
Object  image  the image

Returns
void  

Supported Clients
SmartClient


setToolbarDefaultButtonEnabled
void  setToolbarDefaultButtonEnabled( Number, Boolean )
Enable/disable a default toolbar button.
Parameters
Number  index  the index
Boolean  enabled  the enabled

Returns
void  

Supported Clients
SmartClient


setToolbarDefaultButtonVisible
void  setToolbarDefaultButtonVisible( Number, Boolean )
Set the visibility of a default toolbar button.
Parameters
Number  index  the index
Boolean  visible  the visible

Returns
void  

Supported Clients
SmartClient


setToolbarSeparator
void  setToolbarSeparator( )
Add your own toolbar separator.
Returns
void  

Supported Clients
SmartClient


setVisibleDateRange
void  setVisibleDateRange( Date, Date )
Set the range to show in the calendar 'manually'.
Parameters
Date  start  the start
Date  end  the end

Returns
void  

Supported Clients
SmartClient


toggleCategoryExpanded
void  toggleCategoryExpanded( Object )
Toggle the expanded state of the entered category.
Parameters
Object  id  the category id

Returns
void  

Supported Clients
SmartClient


toggleCategorySelected
void  toggleCategorySelected( Object )
Toggle the selected (checked) state of the entered category.
Parameters
Object  id  the category id

Returns
void  

Supported Clients
SmartClient