com.webmethods.caf.faces.component.table.html

Class CalendarTable

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIData

javax.faces.component.html.HtmlDataTable

com.webmethods.caf.faces.component.table.html.DataTable

com.webmethods.caf.faces.component.table.html.AsyncTable

com.webmethods.caf.faces.component.table.html.CalendarTable

All Implemented Interfaces:

IDynamicComponent, IExtendedTable, ITableRowStateHolder, Serializable, EventListener, ClientBehaviorHolder, NamingContainer, PartialStateHolder, StateHolder, TransientStateHolder, UniqueIdVendor, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder

public class CalendarTable
extends AsyncTable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CalendarTable.CalendarContext

Nested classes/interfaces inherited from class com.webmethods.caf.faces.component.table.html.DataTable

DataTable.ExportActionEvent, DataTable.ExportActionListener

Nested classes/interfaces inherited from interface com.webmethods.caf.faces.component.table.IExtendedTable

IExtendedTable.RowMovement

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_DISPLAY_UNITS
static String	FAMILY
protected CalendarTable.CalendarContext	m_calendarContext
protected ICalendarEventProvider	m_eventProvider
static String	TYPE
static String	UNIT_DAY
static String	UNIT_MONTH
static String	UNIT_WEEK
static String	UNIT_YEAR

Fields inherited from class com.webmethods.caf.faces.component.table.html.AsyncTable

m_savedSuppressed, m_savedVisible

Fields inherited from class com.webmethods.caf.faces.component.table.html.DataTable

content, lazyRowIndex, NO_LAZY_INDEX, rowsToCreate, rowsToDelete, rowsToMove, rowsToUpdate, saved, skipRowIndexLookup, sortIds, sortKeys, templateRowId

Fields inherited from class javax.faces.component.html.HtmlDataTable

COMPONENT_TYPE

Fields inherited from class javax.faces.component.UIData

COMPONENT_FAMILY

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor and Description
CalendarTable()

Method Summary

Modifier and Type	Method and Description
protected void	clearContent() Clear cached content.
static String	formatDate(Locale locale, String format, Date date)
Boolean	getAllDay()
CalendarTable.CalendarContext	getCalendarContext()
Date	getCalendarEndDate()
ICalendarEventProvider	getCalendarEventProvider()
protected ICalendarProvider	getCalendarProvider()
Date	getCalendarStartDate()
ITableContentProvider	getContentProvider() Lazily gets table-content-provider, wrapping raw value if necessary.
Object	getCurrentRow()
CalendarUnit	getCurrentUnit()
ICalendarDay	getDay()
String	getDayVar()
String	getDisplayUnits()
int	getEventCount()
Object	getEvents()
List<ICalendarEvent>	getEventsInRange(Date startDate, Date endDate)
String	getEventVar()
String	getFamily()
Date	getInitialDate()
int	getRows() Return the number of rows to be displayed, or zero for all remaining rows in the table.
Date	getUnitEndDate()
Date	getUnitStartDate()
boolean	isDayAvailable()
void	setAllDay(Boolean allDay)
void	setCalendarEndDate(Date endDate)
void	setCalendarStartDate(Date startDate)
void	setCurrentEvent(ICalendarEvent event)
void	setDayIndex(int dayIndex)
void	setDayVar(String dayVar)
void	setDisplayUnits(String units)
void	setEvents(Object events)
void	setEventVar(String eventVar)
void	setInitialDate(Date initialDate)
void	setRowIndex(int rowIndex) Set the zero relative index of the current row, or -1 to indicate that no row is currently selected, by implementing the following algorithm.

Methods inherited from class com.webmethods.caf.faces.component.table.html.AsyncTable

decode, encodeBegin, findSuppressed, getBufferChunk, getBufferMax, getBufferMin, getProgressDelay, getProgressMsg, getSuppressInputs, isAncestorOrSelf, isAsync, isClientSideCache, isFlashOnChange, setBufferChunk, setBufferMax, setBufferMin, setClientSideCache, setFlashOnChange, setProgressDelay, setProgressMsg, setSuppressInputs

Methods inherited from class com.webmethods.caf.faces.component.table.html.DataTable

broadcast, clearDescendantState, convertCreatedToOriginalRowIds, convertOriginalToCreatedRowIds, filter, fromClientRowId, getCanTemplateRow, getClientId, getContentProvider, getExportSettings, getFilter, getFirst, getRowCount, getRowData, getRowId, getRowIndex, getRowsToCreate, getRowsToDelete, getRowsToMove, getRowsToUpdate, getSortInfo, getTableRowState, isNestedWithinUIData, isRowAvailable, isTemplateRow, iterate, keepSaved, populateInitialComponents, prepareForEncode, processColumnChild, processDecodes, processUpdates, processValidators, queueEvent, resetContent, resetRowCaches, restoreDescendantState, restoreDescendantState, restoreState, saveDescendantState, saveDescendantState, setFilter, setFirst, setLazyRowIndex, setRowById, setRows, setRowsToCreate, setRowsToDelete, setRowsToMove, setRowsToUpdate, setTableRowState, setTemplateRow, setTemplateRowId, setValue, setValueBinding, setValueExpression, sort, toClientRowId, updateRowsToCreate

Methods inherited from class javax.faces.component.html.HtmlDataTable

getBgcolor, getBodyrows, getBorder, getCaptionClass, getCaptionStyle, getCellpadding, getCellspacing, getColumnClasses, getDefaultEventName, getDir, getEventNames, getFooterClass, getFrame, getHeaderClass, getLang, getOnclick, getOndblclick, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getRole, getRowClasses, getRules, getStyle, getStyleClass, getSummary, getTitle, getWidth, setBgcolor, setBodyrows, setBorder, setCaptionClass, setCaptionStyle, setCellpadding, setCellspacing, setColumnClasses, setDir, setFooterClass, setFrame, setHeaderClass, setLang, setOnclick, setOndblclick, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setRole, setRowClasses, setRules, setStyle, setStyleClass, setSummary, setTitle, setWidth

Methods inherited from class javax.faces.component.UIData

createUniqueId, getDataModel, getFooter, getHeader, getValue, getVar, invokeOnComponent, isRowStatePreserved, markInitialState, saveState, setDataModel, setFooter, setHeader, setRowStatePreserved, setVar, visitTree

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, clearInitialState, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

addClientBehavior, getClientBehaviors

Field Detail

TYPE

public static final String TYPE

See Also:

Constant Field Values

FAMILY

public static final String FAMILY

See Also:

Constant Field Values

DEFAULT_DISPLAY_UNITS

public static final String DEFAULT_DISPLAY_UNITS

See Also:

Constant Field Values

UNIT_DAY

public static final String UNIT_DAY

See Also:

Constant Field Values

UNIT_WEEK

public static final String UNIT_WEEK

See Also:

Constant Field Values

UNIT_MONTH

public static final String UNIT_MONTH

See Also:

Constant Field Values

UNIT_YEAR

public static final String UNIT_YEAR

See Also:

Constant Field Values

m_calendarContext

protected transient CalendarTable.CalendarContext m_calendarContext

m_eventProvider

protected transient ICalendarEventProvider m_eventProvider

Constructor Detail

CalendarTable

public CalendarTable()

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class UIData

getCalendarStartDate

public Date getCalendarStartDate()

setCalendarStartDate

public void setCalendarStartDate(Date startDate)

getCalendarEndDate

public Date getCalendarEndDate()

setCalendarEndDate

public void setCalendarEndDate(Date endDate)

getAllDay

public Boolean getAllDay()

setAllDay

public void setAllDay(Boolean allDay)

getDisplayUnits

public String getDisplayUnits()

setDisplayUnits

public void setDisplayUnits(String units)

getInitialDate

public Date getInitialDate()

setInitialDate

public void setInitialDate(Date initialDate)

clearContent

protected void clearContent()

Description copied from class: DataTable

Clear cached content.

Overrides:

clearContent in class DataTable

getCalendarProvider

protected ICalendarProvider getCalendarProvider()

getContentProvider

public ITableContentProvider getContentProvider()

Description copied from class: DataTable

Lazily gets table-content-provider, wrapping raw value if necessary.

Specified by:

getContentProvider in interface IExtendedTable

Overrides:

getContentProvider in class DataTable

getEvents

public Object getEvents()

setEvents

public void setEvents(Object events)

getCalendarEventProvider

public ICalendarEventProvider getCalendarEventProvider()

getEventsInRange

public List<ICalendarEvent> getEventsInRange(Date startDate,
                                             Date endDate)

getRows

public int getRows()

Description copied from class: DataTable

Return the number of rows to be displayed, or zero for all remaining rows in the table. The default value of this property is zero.

Overrides:

getRows in class DataTable

setRowIndex

public void setRowIndex(int rowIndex)

Description copied from class: DataTable

Set the zero relative index of the current row, or -1 to indicate that no row is currently selected, by implementing the following algorithm. It is possible to set the row index at a value for which the underlying data collection does not contain any row data. Therefore, callers may use the isRowAvailable() method to detect whether row data will be available for use by the getRowData() method.

• Save current state information for all descendant components (as described below).
• Store the new row index, and pass it on to the DataModel associated with this UIData instance.
• If the new rowIndex value is -1:
  • If the var property is not null, remove the corresponding request scope attribute (if any).
  • Reset the state information for all descendant components (as described below).
• If the new rowIndex value is not -1:
  • If the var property is not null, call getRowData() and expose the resulting data object as a request scope attribute whose key is the var property value.
  • Reset the state information for all descendant components (as described below).

To save current state information for all descendant components, UIData must maintain per-row information for each descendant as follows:

• If the descendant is an instance of EditableValueHolder, save the state of its localValue property.
• If the descendant is an instance of EditableValueHolder, save the state of the localValueSet property.
• If the descendant is an instance of EditableValueHolder, save the state of the valid property.
• If the descendant is an instance of EditableValueHolder, save the state of the submittedValue property.

To restore current state information for all descendant components, UIData must reference its previously stored information for the current rowIndex and call setters for each descendant as follows:

• If the descendant is an instance of EditableValueHolder, restore the value property.
• If the descendant is an instance of EditableValueHolder, restore the state of the localValueSet property.
• If the descendant is an instance of EditableValueHolder, restore the state of the valid property.
• If the descendant is an instance of EditableValueHolder, restore the state of the submittedValue property.

Overrides:

setRowIndex in class DataTable

Parameters:

rowIndex - The new row index value, or -1 for no associated row

setDayIndex

public void setDayIndex(int dayIndex)

setCurrentEvent

public void setCurrentEvent(ICalendarEvent event)

getDay

public ICalendarDay getDay()

getCurrentRow

public Object getCurrentRow()

getCurrentUnit

public CalendarUnit getCurrentUnit()

getEventCount

public int getEventCount()

getUnitStartDate

public Date getUnitStartDate()

getUnitEndDate

public Date getUnitEndDate()

isDayAvailable

public boolean isDayAvailable()

getCalendarContext

public CalendarTable.CalendarContext getCalendarContext()

formatDate

public static String formatDate(Locale locale,
                                String format,
                                Date date)

getDayVar

public String getDayVar()

setDayVar

public void setDayVar(String dayVar)

getEventVar

public String getEventVar()

setEventVar

public void setEventVar(String eventVar)