org.apache.myfaces.custom.schedule
Class AbstractUIScheduleBase

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          org.apache.myfaces.custom.schedule.AbstractUIScheduleBase

All Implemented Interfaces:

Serializable, javax.faces.component.StateHolder, javax.faces.component.ValueHolder

Direct Known Subclasses:

org.apache.myfaces.custom.schedule.UIScheduleBase

public abstract class AbstractUIScheduleBase
extends javax.faces.component.UIComponentBase
implements javax.faces.component.ValueHolder, Serializable

Base class for the Schedule component. This class contains all the properties for the schedule, but not the ActionSource stuff. Keeping these things separate should make the code a little easier to digest.

Since:

1.1.7

Version:

$Revision: 691856 $

Author:

Jurgen Lust

See Also:

Serialized Form

Field Summary

static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
protected static int	DEFAULT_COMPACT_MONTH_ROWHEIGHT
protected static int	DEFAULT_COMPACT_WEEK_ROWHEIGHT
protected static int	DEFAULT_DETAILED_ROWHEIGHT
protected static String	DEFAULT_ENABLED_ON_USER_ROLE
protected static boolean	DEFAULT_EXPAND_TO_FIT
protected static String	DEFAULT_HEADER_DATE_FORMAT
protected static boolean	DEFAULT_IMMEDIATE
protected static boolean	DEFAULT_READONLY
protected static boolean	DEFAULT_RENDER_ZEROLENGTH
protected static boolean	DEFAULT_SPLIT_WEEKEND
protected static boolean	DEFAULT_SUBMIT_ON_CLICK
protected static String	DEFAULT_THEME
protected static boolean	DEFAULT_TOOLTIP
protected static int	DEFAULT_VISIBLE_END_HOUR
protected static String	DEFAULT_VISIBLE_ON_USER_ROLE
protected static int	DEFAULT_VISIBLE_START_HOUR
protected static int	DEFAULT_WORKING_END_HOUR
protected static int	DEFAULT_WORKING_START_HOUR
protected static String	HOUR_NOTATION_12
protected static String	HOUR_NOTATION_24
static String	RENDERER_TYPE

Constructor Summary

AbstractUIScheduleBase()

Method Summary

abstract String	getCompactMonthDayOfWeekDateFormat()
abstract int	getCompactMonthRowHeight()
abstract int	getCompactWeekRowHeight()
abstract javax.faces.convert.Converter	getConverter()
abstract int	getDetailedRowHeight()
String	getFamily()
abstract String	getHeaderDateFormat()
abstract String	getHourNotation() Show dates in 24 hour notation or 12 hour notation.
abstract Object	getLocalValue()
ScheduleModel	getModel() The underlying model
abstract String	getTheme()
abstract Object	getValue()
abstract int	getVisibleEndHour()
abstract int	getVisibleStartHour()
abstract int	getWorkingEndHour()
abstract int	getWorkingStartHour()
abstract boolean	isExpandToFitEntries()
abstract boolean	isImmediate()
abstract boolean	isReadonly()
boolean	isRendersChildren()
abstract boolean	isRenderZeroLengthEntries()
abstract boolean	isSplitWeekend()
abstract boolean	isSubmitOnClick() Should the parent form of this schedule be submitted when the user clicks on a day? Note that this will only work when the readonly property is set to false.
abstract boolean	isTooltip()
void	setModel(ScheduleModel model) The underlying model

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

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.ValueHolder

setConverter, setValue

Field Detail

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

RENDERER_TYPE

public static final String RENDERER_TYPE

See Also:

Constant Field Values

HOUR_NOTATION_24

protected static final String HOUR_NOTATION_24

See Also:

Constant Field Values

HOUR_NOTATION_12

protected static final String HOUR_NOTATION_12

See Also:

Constant Field Values

DEFAULT_COMPACT_MONTH_ROWHEIGHT

protected static final int DEFAULT_COMPACT_MONTH_ROWHEIGHT

See Also:

Constant Field Values

DEFAULT_COMPACT_WEEK_ROWHEIGHT

protected static final int DEFAULT_COMPACT_WEEK_ROWHEIGHT

See Also:

Constant Field Values

DEFAULT_DETAILED_ROWHEIGHT

protected static final int DEFAULT_DETAILED_ROWHEIGHT

See Also:

Constant Field Values

DEFAULT_EXPAND_TO_FIT

protected static final boolean DEFAULT_EXPAND_TO_FIT

See Also:

Constant Field Values

DEFAULT_HEADER_DATE_FORMAT

protected static final String DEFAULT_HEADER_DATE_FORMAT

DEFAULT_IMMEDIATE

protected static final boolean DEFAULT_IMMEDIATE

See Also:

Constant Field Values

DEFAULT_READONLY

protected static final boolean DEFAULT_READONLY

See Also:

Constant Field Values

DEFAULT_RENDER_ZEROLENGTH

protected static final boolean DEFAULT_RENDER_ZEROLENGTH

See Also:

Constant Field Values

DEFAULT_THEME

protected static final String DEFAULT_THEME

See Also:

Constant Field Values

DEFAULT_TOOLTIP

protected static final boolean DEFAULT_TOOLTIP

See Also:

Constant Field Values

DEFAULT_VISIBLE_END_HOUR

protected static final int DEFAULT_VISIBLE_END_HOUR

See Also:

Constant Field Values

DEFAULT_VISIBLE_START_HOUR

protected static final int DEFAULT_VISIBLE_START_HOUR

See Also:

Constant Field Values

DEFAULT_WORKING_END_HOUR

protected static final int DEFAULT_WORKING_END_HOUR

See Also:

Constant Field Values

DEFAULT_WORKING_START_HOUR

protected static final int DEFAULT_WORKING_START_HOUR

See Also:

Constant Field Values

DEFAULT_ENABLED_ON_USER_ROLE

protected static final String DEFAULT_ENABLED_ON_USER_ROLE

DEFAULT_SUBMIT_ON_CLICK

protected static final boolean DEFAULT_SUBMIT_ON_CLICK

See Also:

Constant Field Values

DEFAULT_VISIBLE_ON_USER_ROLE

protected static final String DEFAULT_VISIBLE_ON_USER_ROLE

DEFAULT_SPLIT_WEEKEND

protected static final boolean DEFAULT_SPLIT_WEEKEND

See Also:

Constant Field Values

Constructor Detail

AbstractUIScheduleBase

public AbstractUIScheduleBase()

Method Detail

isSplitWeekend

public abstract boolean isSplitWeekend()

isSubmitOnClick

public abstract boolean isSubmitOnClick()

Should the parent form of this schedule be submitted when the user clicks on a day? Note that this will only work when the readonly property is set to false.

Returns:

the _submitOnClick

getCompactMonthRowHeight

public abstract int getCompactMonthRowHeight()

Returns:

the compactMonthRowHeight

getCompactWeekRowHeight

public abstract int getCompactWeekRowHeight()

Returns:

the compactWeekRowHeight

getConverter

public abstract javax.faces.convert.Converter getConverter()

Specified by:

getConverter in interface javax.faces.component.ValueHolder

See Also:

ValueHolder.getConverter()

getDetailedRowHeight

public abstract int getDetailedRowHeight()

Returns:

the detailedRowHeight

isExpandToFitEntries

public abstract boolean isExpandToFitEntries()

Returns:

the expandToFitEntries

getFamily

public String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

See Also:

UIComponent.getFamily()

getHeaderDateFormat

public abstract String getHeaderDateFormat()

Returns:

the headerDateFormat

isImmediate

public abstract boolean isImmediate()

Returns:

the immediate

getLocalValue

public abstract Object getLocalValue()

Specified by:

getLocalValue in interface javax.faces.component.ValueHolder

See Also:

ValueHolder.getLocalValue()

getModel

public ScheduleModel getModel()

The underlying model

Returns:

Returns the model.

isReadonly

public abstract boolean isReadonly()

Returns:

the readonly

isRendersChildren

public boolean isRendersChildren()

See Also:

UIComponentBase.getRendersChildren()

isRenderZeroLengthEntries

public abstract boolean isRenderZeroLengthEntries()

Returns:

the renderZeroLengthEntries

getTheme

public abstract String getTheme()

Returns:

the theme

isTooltip

public abstract boolean isTooltip()

Returns:

the tooltip

getValue

public abstract Object getValue()

Specified by:

getValue in interface javax.faces.component.ValueHolder

See Also:

ValueHolder.getValue()

getVisibleEndHour

public abstract int getVisibleEndHour()

Returns:

the visibleEndHour

getVisibleStartHour

public abstract int getVisibleStartHour()

Returns:

the visibleStartHour

getWorkingEndHour

public abstract int getWorkingEndHour()

Returns:

the workingEndHour

getWorkingStartHour

public abstract int getWorkingStartHour()

Returns:

the workingStartHour

getHourNotation

public abstract String getHourNotation()

Show dates in 24 hour notation or 12 hour notation.

Returns:

"12", "24" or null for the renderer default

getCompactMonthDayOfWeekDateFormat

public abstract String getCompactMonthDayOfWeekDateFormat()

Returns:

the headerDateFormat

setModel

public void setModel(ScheduleModel model)

The underlying model

Parameters:

model - The model to set.