com.cc.framework.ui.model
Interface SchedulerDesignModel

All Superinterfaces:

AccessControlled, ActionBehavior, AjaxSupport, ButtonContainer, ClientHandler, ControlDesignModel, DesignModel, FrameContainer

All Known Implementing Classes:

SchedulerDesignModelImp

public interface SchedulerDesignModel

extends ControlDesignModel, FrameContainer

Scheduler DesignModel

Version:

$Revision: 1.17 $

Author:

Harald Schulz

Method Summary

boolean	compressWeekEnds()
int	getCheckBoxMask() Retrieves a bit mask that indicates on what view levels a checkbox should be shown for this control
int	getColumns() Retrieves the number of columns in year view
int	getDayEndHour()
int	getDayStartHour()
boolean	getFilter() Returns the Filter setting
int	getFirstDayOfWeek() Gets the first day of the week
ImageMap	getImageMap() Returns the associated ImageMap
int	getInterval()
int	getMaxVisible() Retrieves the maximum visible appointments for one Day
int	getMonthIncrement() retrieves the number of month to increment in year view when the user clicks on one of the navigation buttons.
int	getRows() Retrieves the number of rows in year view
java.lang.String	getTitle() Returns the Title
int	getViewMask() Retrieves a bit mask with all the possible view buttons for this control
int	getWorkEndHour()
int	getWorkingDayMask() Retrieves a Mask with the weeks working days.
int	getWorkStartHour()
void	setCheckBoxMask(int checkBoxMask) Sets a bit mask that indicates on what view levels checkboxes should be shown for this control
void	setColumns(int columns) Sets the number of columns in year view
void	setCompressWeekEnds(boolean comress) Sets a value indicating whether the weekends should be compressed in one day
void	setDayEndHour(int hour) Sets a value indicating the end of the hour range displayed by the Schedule on DayView.
void	setDayStartHour(int hour) Sets a value indicating the start of the hour range displayed by the Schedule on DayView.
void	setFilter(boolean filter) Sets the Filter.
void	setFirstDayOfWeek(int dayIndex) Sets the first day of the week
void	setImageMap(ImageMap map) Specifies the name of an image map.
void	setInterval(int interval) Sets a value specifying the interval in which the hour is divided.
void	setMaxVisible(int max) Sets the maximum visible appointments for one Day
void	setMonthIncrement(int increment) Sets the number of month to increment in year view when the user clicks on one of the navigation buttons.
void	setRows(int rows) Sets the number of rows in year view
void	setShowAllDayArea(boolean show) Sets a value specifying whether the all-day area is displayed.
void	setShowFrame(boolean show) Disables the frame
void	setShowPopups(boolean show)
void	setShowWeekEndDays(boolean show) Sets a value specifying whether the week end days are shown in week, month and navigator view.
void	setTitle(java.lang.String title) Sets the title of the ListControl which is display in the Header
void	setViewMask(int mask) Sets the visible view buttons for this scheduler control.
void	setWorkEndHour(int hour) Sets a value indicating the end time of the day for the working hours.
void	setWorkingDayMask(int dayMask) Sets a Mask with the weeks working days.
void	setWorkStartHour(int hour) Sets a value indicating the start time of the day for the working hours.
boolean	showAllDayArea()
boolean	showFrame()
boolean	showPopups()
boolean	showWeekEndDays()

Methods inherited from interface com.cc.framework.ui.model.ControlDesignModel

addDesignRule, getAction, getBorder, getDesignRules, getHeight, getHelp, getId, getLocaleName, getName, getProperty, getRunAt, getStyle, getStyleClass, getStyleId, getSummary, getTabIndex, getTooltip, getTransaction, getWidth, hasShadow, isDisabled, isDynamicDesignModel, isFormElement, setAction, setBorder, setDisabled, setDynamicDesignModel, setFormElement, setHeight, setHelp, setId, setLocaleName, setName, setPermission, setProperty, setRunAt, setShadow, setStyle, setStyleClass, setStyleId, setSummary, setTabIndex, setTooltip, setTransaction, setWidth

Methods inherited from interface com.cc.framework.ui.model.ClientHandler

getHandler, getHandlers, setHandler

Methods inherited from interface com.cc.framework.ui.model.AccessControlled

getPermission, show

Methods inherited from interface com.cc.framework.ui.model.ActionBehavior

isAjaxEnabled

Methods inherited from interface com.cc.framework.ui.model.AjaxSupport

enableAjax, isAjaxEnabled

Methods inherited from interface com.cc.framework.ui.model.FrameContainer

addInnerFrame, getImage, getInnerFrames, setImage

Methods inherited from interface com.cc.framework.ui.model.ButtonContainer

getButtonPermission, setButtonPermission, showButton

Method Detail

getTitle

public java.lang.String getTitle()

Returns the Title

Returns:

Title

setTitle

public void setTitle(java.lang.String title)

Sets the title of the ListControl which is display in the Header

Parameters:

title - The main title of the control

setImageMap

public void setImageMap(ImageMap map)

Specifies the name of an image map.

Parameters:

map - ImageMap

getImageMap

public ImageMap getImageMap()

Returns the associated ImageMap

Returns:

ImageMap

setShowFrame

public void setShowFrame(boolean show)

Disables the frame

Parameters:

show - true if the lists frame should be shown

showFrame

public boolean showFrame()

Returns:

true if the frame should be shown

compressWeekEnds

public boolean compressWeekEnds()

Returns:

Gets a value indicating whether the weekends should be compressed in one day

setCompressWeekEnds

public void setCompressWeekEnds(boolean comress)

Sets a value indicating whether the weekends should be compressed in one day

Parameters:

comress - boolean value

getDayStartHour

public int getDayStartHour()

Returns:

Gets a value indicating the start of the hour range displayed by the Schedule on DayView.

setDayStartHour

public void setDayStartHour(int hour)

Sets a value indicating the start of the hour range displayed by the Schedule on DayView.

Parameters:

hour - the start hour

getDayEndHour

public int getDayEndHour()

Returns:

Gets a value indicating the end of the hour range displayed by the Schedule on DayView.

setDayEndHour

public void setDayEndHour(int hour)

Sets a value indicating the end of the hour range displayed by the Schedule on DayView.

Parameters:

hour - the start hour

getWorkStartHour

public int getWorkStartHour()

Returns:

Gets a value indicating the start time of the day for the working hours.

setWorkStartHour

public void setWorkStartHour(int hour)

Sets a value indicating the start time of the day for the working hours.

Parameters:

hour - the start hour

getWorkEndHour

public int getWorkEndHour()

Returns:

Gets a value indicating the end time of the day for the working hours.

setWorkEndHour

public void setWorkEndHour(int hour)

Sets a value indicating the end time of the day for the working hours.

Parameters:

hour - the start hour

showAllDayArea

public boolean showAllDayArea()

Returns:

Gets a value specifying whether the all-day area is displayed.

setShowAllDayArea

public void setShowAllDayArea(boolean show)

Sets a value specifying whether the all-day area is displayed.

Parameters:

show - boolean value

showWeekEndDays

public boolean showWeekEndDays()

Returns:

Gets a value specifying whether the week end days are shown in week, month and navigator view.

setShowWeekEndDays

public void setShowWeekEndDays(boolean show)

Sets a value specifying whether the week end days are shown in week, month and navigator view.

Parameters:

show - boolean value

setInterval

public void setInterval(int interval)

Sets a value specifying the interval in which the hour is divided.

Parameters:

interval - the interval in minutes (5|6|10|15|30|60)

getInterval

public int getInterval()

Returns:

Gets a value specifying the interval in which the hour is divided.

getWorkingDayMask

public int getWorkingDayMask()

Retrieves a Mask with the weeks working days. The mask is a bitwise or combination of the following integer constants representing each day of the week:

• Calendar.SUNDAY^2 = Sunday
• Calendar.MONDAY^2 = Monday
• ...

Returns:

Mask

setWorkingDayMask

public void setWorkingDayMask(int dayMask)

Sets a Mask with the weeks working days. The mask is a bitwise or combination of the following integer constants representing each day of the week:

• Calendar.SUNDAY^2 = Sunday
• Calendar.MONDAY^2 = Monday
• ...

An attempt to set DayOfWeekMask to any value less than 1 or greater than 127 results in an OutOfBounds Exception.

Parameters:

dayMask - Mask

getFirstDayOfWeek

public int getFirstDayOfWeek()

Gets the first day of the week

Returns:

Day index of the first Day of the week or 0 for the locales default

setFirstDayOfWeek

public void setFirstDayOfWeek(int dayIndex)

Sets the first day of the week

Parameters:

dayIndex - Day index of the first Day of the week or 0 for the locales default

getMaxVisible

public int getMaxVisible()

Retrieves the maximum visible appointments for one Day

Returns:

Maximum visible Appointments for one Day

setMaxVisible

public void setMaxVisible(int max)

Sets the maximum visible appointments for one Day

Parameters:

max - Maximum visible Appointments for one Day

showPopups

public boolean showPopups()

Returns:

true to show appointments in year view in a popup window

setShowPopups

public void setShowPopups(boolean show)

Parameters:

show - true to show appointments in year view in a popup window

getColumns

public int getColumns()

Retrieves the number of columns in year view

Returns:

number of columns

setColumns

public void setColumns(int columns)

Sets the number of columns in year view

Parameters:

columns - number of columns

getRows

public int getRows()

Retrieves the number of rows in year view

Returns:

number of rows

setRows

public void setRows(int rows)

Sets the number of rows in year view

Parameters:

rows - number of rows

setViewMask

public void setViewMask(int mask)

Sets the visible view buttons for this scheduler control.

Parameters:

mask - Bit combination of Scheduler views

See Also:

SchedulerView

getViewMask

public int getViewMask()

Retrieves a bit mask with all the possible view buttons for this control

Returns:

Bit combination of Scheduler views

See Also:

SchedulerView

getFilter

public boolean getFilter()

Returns the Filter setting

Returns:

boolean

setFilter

public void setFilter(boolean filter)

Sets the Filter. If set to true, all String will be converted into valid HTML-strings

Parameters:

filter - true if Strings should be HTML encoded

setMonthIncrement

public void setMonthIncrement(int increment)

Sets the number of month to increment in year view when the user clicks on one of the navigation buttons. A value of 0 resets the the control to the default increment which is the number of visible months (= rows * columns)

Parameters:

increment - Number of columns to increment

getMonthIncrement

public int getMonthIncrement()

retrieves the number of month to increment in year view when the user clicks on one of the navigation buttons. A value of 0 resets the the control to the default increment which is the number of visible months (= rows * columns)

Returns:

the number of month to increment

getCheckBoxMask

public int getCheckBoxMask()

Retrieves a bit mask that indicates on what view levels a checkbox should be shown for this control

Returns:

Bit combination of Scheduler views

See Also:

SchedulerScope

setCheckBoxMask

public void setCheckBoxMask(int checkBoxMask)

Sets a bit mask that indicates on what view levels checkboxes should be shown for this control

Parameters:

checkBoxMask - Bit combination of Scheduler views

See Also:

SchedulerScope