NextApp Echo3 Extras
v3.0.b8

nextapp.echo.extras.app
Class CalendarSelect

java.lang.Object
  extended by nextapp.echo.app.Component
      extended by nextapp.echo.extras.app.CalendarSelect
All Implemented Interfaces:
Serializable, RenderIdSupport

public class CalendarSelect
extends Component

CalendarSelect component: an input component which allows selection of a single date. Displays a representation of a calendar, showing the currently selected month/year. May not contain child components.

See Also:
Serialized Form

Field Summary
static String DATE_CHANGED_PROPERTY
           
static String PROPERTY_ADJACENT_MONTH_DATE_BACKGROUND
           
static String PROPERTY_ADJACENT_MONTH_DATE_FOREGROUND
           
static String PROPERTY_BACKGROUND_IMAGE
           
static String PROPERTY_BORDER
           
static String PROPERTY_DATE_BACKGROUND
           
static String PROPERTY_DATE_BACKGROUND_IMAGE
           
static String PROPERTY_DATE_BORDER
           
static String PROPERTY_DATE_FOREGROUND
           
static String PROPERTY_DAY_OF_WEEK_ABBREVIATION_LENGTH
           
static String PROPERTY_FIRST_DAY_OF_WEEK
           
static String PROPERTY_HEADER_BACKGROUND
           
static String PROPERTY_HEADER_BACKGROUND_IMAGE
           
static String PROPERTY_HEADER_FOREGROUND
           
static String PROPERTY_ROLLOVER_DATE_BACKGROUND
           
static String PROPERTY_ROLLOVER_DATE_BACKGROUND_IMAGE
           
static String PROPERTY_ROLLOVER_DATE_BORDER
           
static String PROPERTY_ROLLOVER_DATE_FOREGROUND
           
static String PROPERTY_SELECTED_DATE_BACKGROUND
           
static String PROPERTY_SELECTED_DATE_BACKGROUND_IMAGE
           
static String PROPERTY_SELECTED_DATE_BORDER
           
static String PROPERTY_SELECTED_DATE_FOREGROUND
           
 
Fields inherited from class nextapp.echo.app.Component
CHILD_VISIBLE_CHANGED_PROPERTY, CHILDREN_CHANGED_PROPERTY, ENABLED_CHANGED_PROPERTY, FOCUS_NEXT_ID_CHANGED_PROPERTY, FOCUS_PREVIOUS_ID_CHANGED_PROPERTY, LAYOUT_DIRECTION_CHANGED_PROPERTY, LOCALE_CHANGED_PROPERTY, PROPERTY_BACKGROUND, PROPERTY_FONT, PROPERTY_FOREGROUND, PROPERTY_LAYOUT_DATA, STYLE_CHANGED_PROPERTY, STYLE_NAME_CHANGED_PROPERTY, VISIBLE_CHANGED_PROPERTY
 
Constructor Summary
CalendarSelect()
          Creates a new CalendarSelect.
CalendarSelect(Date date)
          Creates a new CalendarSelect.
 
Method Summary
 Color getAdjacentMonthDateBackground()
          Returns the background color of dates in adjacent (previous/next) months.
 Color getAdjacentMonthDateForeground()
          Returns the foreground color of dates in adjacent (previous/next) months.
 FillImage getBackgroundImage()
          Returns the background image displayed within the entire component.
 Border getBorder()
          Returns the border surrounding the entire component.
 Date getDate()
          Returns the selected date.
 Color getDateBackground()
          Returns the default background color of date cells.
 FillImage getDateBackgroundImage()
          Returns the default background image of date cells.
 Border getDateBorder()
          Returns the default border of date cells.
 Color getDateForeground()
          Returns the default foreground color of date cells.
 int getFirstDayOfWeek()
          Returns the first day of the week.
 Color getHeaderBackground()
          Returns the background color of the week header.
 FillImage getHeaderBackgroundImage()
          Returns the background image of the week header.
 Color getHeaderForeground()
          Returns the foreground color of the week header.
 Color getRolloverDateBackground()
          Returns the rollover background color of date cells.
 FillImage getRolloverDateBackgroundImage()
          Returns the rollover background image of date cells.
 Border getRolloverDateBorder()
          Returns the rollover border of date cells.
 Color getRolloverDateForeground()
          Returns the rollover foreground color of date cells.
 Color getSelectedDateBackground()
          Returns the background color of the selected date
 FillImage getSelectedDateBackgroundImage()
          Returns the background image of the selected date
 Border getSelectedDateBorder()
          Returns the border of the selected date
 Color getSelectedDateForeground()
          Returns the foreground color of the selected date
 void processInput(String inputName, Object inputValue)
           
 void setAdjacentMonthDateBackground(Color newValue)
          Sets the background color of dates in adjacent (previous/next) months.
 void setAdjacentMonthDateForeground(Color newValue)
          Sets the foreground color of dates in adjacent (previous/next) months.
 void setBackgroundImage(FillImage newValue)
          Sets the background image displayed within the entire component.
 void setBorder(Border newValue)
          Sets the border surrounding the entire component.
 void setDate(Date newValue)
          Sets the selected date.
 void setDateBackground(Color newValue)
          Sets the default background color of date cells.
 void setDateBackgroundImage(FillImage newValue)
          Sets the default background image of date cells.
 void setDateBorder(Border newValue)
          Sets the default border of date cells.
 void setDateForeground(Color newValue)
          Sets the default foreground color of date cells.
 void setFirstDayOfWeek(int newValue)
          Sets the first day of the week.
 void setHeaderBackground(Color newValue)
          Sets the background color of the week header.
 void setHeaderBackgroundImage(FillImage newValue)
          Sets the background image of the week header.
 void setHeaderForeground(Color newValue)
          Sets the foreground color of the week header.
 void setRolloverDateBackground(Color newValue)
          Sets the rollover background color of date cells.
 void setRolloverDateBackgroundImage(FillImage newValue)
          Sets the rollover background image of date cells.
 void setRolloverDateBorder(Border newValue)
          Sets the rollover border of date cells.
 void setRolloverDateForeground(Color newValue)
          Sets the rollover foreground color of date cells.
 void setSelectedDateBackground(Color newValue)
          Sets the background color of the selected date.
 void setSelectedDateBackgroundImage(FillImage newValue)
          Sets the background image of the selected date.
 void setSelectedDateBorder(Border newValue)
          Sets the border of the selected date.
 void setSelectedDateForeground(Color newValue)
          Sets the foreground color of the selected date.
 
Methods inherited from class nextapp.echo.app.Component
add, add, addPropertyChangeListener, addPropertyChangeListener, dispose, firePropertyChange, get, getApplicationInstance, getBackground, getComponent, getComponent, getComponentCount, getComponents, getEventListenerList, getFocusNextId, getFocusPreviousId, getFont, getForeground, getId, getIndex, getLayoutData, getLayoutDirection, getLocale, getLocalStyle, getParent, getRenderId, getRenderIndexedProperty, getRenderIndexedProperty, getRenderLocale, getRenderProperty, getRenderProperty, getStyle, getStyleName, getVisibleComponent, getVisibleComponentCount, getVisibleComponents, hasEventListenerList, indexOf, init, isAncestorOf, isEnabled, isFocusTraversalParticipant, isRegistered, isRenderEnabled, isRenderVisible, isValidChild, isValidParent, isVisible, remove, remove, removeAll, removePropertyChangeListener, removePropertyChangeListener, set, setBackground, setComponents, setEnabled, setFocusNextId, setFocusPreviousId, setFocusTraversalParticipant, setFont, setForeground, setId, setIndex, setLayoutData, setLayoutDirection, setLocale, setRenderId, setStyle, setStyleName, setVisible, validate, verifyInput, visibleIndexOf
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DATE_CHANGED_PROPERTY

public static final String DATE_CHANGED_PROPERTY
See Also:
Constant Field Values

PROPERTY_ADJACENT_MONTH_DATE_BACKGROUND

public static final String PROPERTY_ADJACENT_MONTH_DATE_BACKGROUND
See Also:
Constant Field Values

PROPERTY_ADJACENT_MONTH_DATE_FOREGROUND

public static final String PROPERTY_ADJACENT_MONTH_DATE_FOREGROUND
See Also:
Constant Field Values

PROPERTY_BORDER

public static final String PROPERTY_BORDER
See Also:
Constant Field Values

PROPERTY_BACKGROUND_IMAGE

public static final String PROPERTY_BACKGROUND_IMAGE
See Also:
Constant Field Values

PROPERTY_DATE_BACKGROUND

public static final String PROPERTY_DATE_BACKGROUND
See Also:
Constant Field Values

PROPERTY_DATE_BACKGROUND_IMAGE

public static final String PROPERTY_DATE_BACKGROUND_IMAGE
See Also:
Constant Field Values

PROPERTY_DATE_BORDER

public static final String PROPERTY_DATE_BORDER
See Also:
Constant Field Values

PROPERTY_DATE_FOREGROUND

public static final String PROPERTY_DATE_FOREGROUND
See Also:
Constant Field Values

PROPERTY_DAY_OF_WEEK_ABBREVIATION_LENGTH

public static final String PROPERTY_DAY_OF_WEEK_ABBREVIATION_LENGTH
See Also:
Constant Field Values

PROPERTY_FIRST_DAY_OF_WEEK

public static final String PROPERTY_FIRST_DAY_OF_WEEK
See Also:
Constant Field Values

PROPERTY_HEADER_BACKGROUND

public static final String PROPERTY_HEADER_BACKGROUND
See Also:
Constant Field Values

PROPERTY_HEADER_BACKGROUND_IMAGE

public static final String PROPERTY_HEADER_BACKGROUND_IMAGE
See Also:
Constant Field Values

PROPERTY_HEADER_FOREGROUND

public static final String PROPERTY_HEADER_FOREGROUND
See Also:
Constant Field Values

PROPERTY_ROLLOVER_DATE_BACKGROUND

public static final String PROPERTY_ROLLOVER_DATE_BACKGROUND
See Also:
Constant Field Values

PROPERTY_ROLLOVER_DATE_BACKGROUND_IMAGE

public static final String PROPERTY_ROLLOVER_DATE_BACKGROUND_IMAGE
See Also:
Constant Field Values

PROPERTY_ROLLOVER_DATE_BORDER

public static final String PROPERTY_ROLLOVER_DATE_BORDER
See Also:
Constant Field Values

PROPERTY_ROLLOVER_DATE_FOREGROUND

public static final String PROPERTY_ROLLOVER_DATE_FOREGROUND
See Also:
Constant Field Values

PROPERTY_SELECTED_DATE_BACKGROUND

public static final String PROPERTY_SELECTED_DATE_BACKGROUND
See Also:
Constant Field Values

PROPERTY_SELECTED_DATE_BORDER

public static final String PROPERTY_SELECTED_DATE_BORDER
See Also:
Constant Field Values

PROPERTY_SELECTED_DATE_BACKGROUND_IMAGE

public static final String PROPERTY_SELECTED_DATE_BACKGROUND_IMAGE
See Also:
Constant Field Values

PROPERTY_SELECTED_DATE_FOREGROUND

public static final String PROPERTY_SELECTED_DATE_FOREGROUND
See Also:
Constant Field Values
Constructor Detail

CalendarSelect

public CalendarSelect()
Creates a new CalendarSelect.


CalendarSelect

public CalendarSelect(Date date)
Creates a new CalendarSelect.

Parameters:
date - the initially selected date
Method Detail

getAdjacentMonthDateBackground

public Color getAdjacentMonthDateBackground()
Returns the background color of dates in adjacent (previous/next) months.

Returns:
the background

getAdjacentMonthDateForeground

public Color getAdjacentMonthDateForeground()
Returns the foreground color of dates in adjacent (previous/next) months.

Returns:
the foreground

getBackgroundImage

public FillImage getBackgroundImage()
Returns the background image displayed within the entire component.

Returns:
the background image

getBorder

public Border getBorder()
Returns the border surrounding the entire component.

Returns:
the border

getDate

public Date getDate()
Returns the selected date.

Returns:
the selected date

getDateBackground

public Color getDateBackground()
Returns the default background color of date cells.

Returns:
the background

getDateBackgroundImage

public FillImage getDateBackgroundImage()
Returns the default background image of date cells.

Returns:
the background image

getDateBorder

public Border getDateBorder()
Returns the default border of date cells.

Returns:
the border

getDateForeground

public Color getDateForeground()
Returns the default foreground color of date cells.

Returns:
the foreground

getFirstDayOfWeek

public int getFirstDayOfWeek()
Returns the first day of the week. If set, this value overrides any localized setting. A value of 0 indicates Sunday, a value of 1 indicates Monday.

Returns:
the first day of the week

getHeaderBackground

public Color getHeaderBackground()
Returns the background color of the week header.

Returns:
the background

getHeaderBackgroundImage

public FillImage getHeaderBackgroundImage()
Returns the background image of the week header.

Returns:
the background image

getHeaderForeground

public Color getHeaderForeground()
Returns the foreground color of the week header.

Returns:
the foreground

getRolloverDateBackground

public Color getRolloverDateBackground()
Returns the rollover background color of date cells.

Returns:
the background

getRolloverDateBackgroundImage

public FillImage getRolloverDateBackgroundImage()
Returns the rollover background image of date cells.

Returns:
the background image

getRolloverDateBorder

public Border getRolloverDateBorder()
Returns the rollover border of date cells.

Returns:
the border

getRolloverDateForeground

public Color getRolloverDateForeground()
Returns the rollover foreground color of date cells.

Returns:
the foreground

getSelectedDateBackground

public Color getSelectedDateBackground()
Returns the background color of the selected date

Returns:
the background

getSelectedDateBackgroundImage

public FillImage getSelectedDateBackgroundImage()
Returns the background image of the selected date

Returns:
the background image

getSelectedDateBorder

public Border getSelectedDateBorder()
Returns the border of the selected date

Returns:
the border

getSelectedDateForeground

public Color getSelectedDateForeground()
Returns the foreground color of the selected date

Returns:
the foreground

processInput

public void processInput(String inputName,
                         Object inputValue)
Overrides:
processInput in class Component
See Also:
Component.processInput(java.lang.String, java.lang.Object)

setBackgroundImage

public void setBackgroundImage(FillImage newValue)
Sets the background image displayed within the entire component.

Parameters:
newValue - the new background image

setBorder

public void setBorder(Border newValue)
Sets the border surrounding the entire component.

Parameters:
newValue - the new border

setDate

public void setDate(Date newValue)
Sets the selected date.

Parameters:
newValue - the new date

setAdjacentMonthDateBackground

public void setAdjacentMonthDateBackground(Color newValue)
Sets the background color of dates in adjacent (previous/next) months.

Parameters:
newValue - the new background

setAdjacentMonthDateForeground

public void setAdjacentMonthDateForeground(Color newValue)
Sets the foreground color of dates in adjacent (previous/next) months.

Parameters:
newValue - the new foreground

setDateBackground

public void setDateBackground(Color newValue)
Sets the default background color of date cells.

Parameters:
newValue - the new background

setDateBackgroundImage

public void setDateBackgroundImage(FillImage newValue)
Sets the default background image of date cells.

Parameters:
newValue - the new background

setDateBorder

public void setDateBorder(Border newValue)
Sets the default border of date cells.

Parameters:
newValue - the new border

setDateForeground

public void setDateForeground(Color newValue)
Sets the default foreground color of date cells.

Parameters:
newValue - the new foreground

setFirstDayOfWeek

public void setFirstDayOfWeek(int newValue)
Sets the first day of the week. If set, this value overrides any localized setting. A value of 0 indicates Sunday, a value of 1 indicates Monday.

Parameters:
newValue - the first day of the week

setHeaderBackground

public void setHeaderBackground(Color newValue)
Sets the background color of the week header.

Parameters:
newValue - the new background

setHeaderBackgroundImage

public void setHeaderBackgroundImage(FillImage newValue)
Sets the background image of the week header.

Parameters:
newValue - the new background image

setHeaderForeground

public void setHeaderForeground(Color newValue)
Sets the foreground color of the week header.

Parameters:
newValue - the new foreground

setRolloverDateBackground

public void setRolloverDateBackground(Color newValue)
Sets the rollover background color of date cells.

Parameters:
newValue - the new background

setRolloverDateBackgroundImage

public void setRolloverDateBackgroundImage(FillImage newValue)
Sets the rollover background image of date cells.

Parameters:
newValue - the new background image

setRolloverDateBorder

public void setRolloverDateBorder(Border newValue)
Sets the rollover border of date cells.

Parameters:
newValue - the new border

setRolloverDateForeground

public void setRolloverDateForeground(Color newValue)
Sets the rollover foreground color of date cells.

Parameters:
newValue - the new foreground

setSelectedDateBackground

public void setSelectedDateBackground(Color newValue)
Sets the background color of the selected date.

Parameters:
newValue - the new background

setSelectedDateBackgroundImage

public void setSelectedDateBackgroundImage(FillImage newValue)
Sets the background image of the selected date.

Parameters:
newValue - the new background image

setSelectedDateBorder

public void setSelectedDateBorder(Border newValue)
Sets the border of the selected date.

Parameters:
newValue - the new border

setSelectedDateForeground

public void setSelectedDateForeground(Color newValue)
Sets the foreground color of the selected date.

Parameters:
newValue - the new foreground

NextApp Echo3 Extras
v3.0.b8