|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.odlabs.wiquery.core.options.Options
org.odlabs.wiquery.ui.datepicker.DatePickerOptions
public class DatePickerOptions
An options class to store date picker info so that both InlineDatePiker and datePicker can share them.
Constructor Summary | |
---|---|
DatePickerOptions(org.apache.wicket.Component owner)
Constructor |
Method Summary | |
---|---|
String |
getAltField()
|
String |
getAltFormat()
|
String |
getAppendText()
|
String |
getButtonImage()
|
String |
getButtonText()
|
String |
getCloseText()
|
String |
getCurrentText()
|
String |
getDateFormat()
Returns the ISO date format to use. |
ArrayOfDayNames |
getDayNames()
|
ArrayOfDayNames |
getDayNamesMin()
|
ArrayOfDayNames |
getDayNamesShort()
|
DateOption |
getDefaultDate()
|
DatePickerDuration |
getDuration()
|
short |
getFirstDay()
Returns the calendar's starting day. |
DateOption |
getMaxDate()
|
DateOption |
getMinDate()
|
ArrayOfMonthNames |
getMonthNames()
|
ArrayOfMonthNames |
getMonthNamesShort()
|
String |
getNextText()
|
DatePickerNumberOfMonths |
getNumberOfMonths()
Returns the number of months displayed on the date picker. |
Options |
getOptions()
|
String |
getPrevText()
|
DatePickerShortYearCutOff |
getShortYearCutoff()
Returns the shortYearCutoff option value. |
String |
getShowAnim()
|
short |
getShowCurrentAtPos()
|
DatePicker.ShowOnEnum |
getShowOn()
|
ListItemOptions<LiteralOption> |
getShowOptions()
|
boolean |
getShowOtherMonths()
Deprecated. will be removed in 1.2 Returns if the next/previous months are showed in the calendar. |
short |
getStepMonths()
Returns the number of months stepped when the next/previous button are hit. |
String |
getWeekHeader()
|
DatePickerYearRange |
getYearRange()
|
String |
getYearSuffix()
|
boolean |
isAutoSize()
|
boolean |
isButtonImageOnly()
|
boolean |
isChangeMonth()
Returns true if the date's month is selectable in a drop down list, returns false otherwise. |
boolean |
isChangeYear()
Returns true if the date's year is selectable in a drop down list, returns false otherwise. |
boolean |
isConstrainInput()
|
boolean |
isDisabled()
|
boolean |
isGotoCurrent()
|
boolean |
isHideIfNoPrevNext()
|
boolean |
isIsRTL()
|
boolean |
isNavigationAsDateFormat()
|
boolean |
isSelectOtherMonths()
|
boolean |
isShowButtonPanel()
|
boolean |
isShowMonthAfterYear()
|
boolean |
isShowOtherMonths()
Returns if the next/previous months are showed in the calendar. |
boolean |
isShowWeek()
|
void |
setAltField(String altField)
The jQuery selector for another field that is to be updated with the selected date from the datepicker. |
void |
setAltFormat(String altFormat)
The dateFormat to be used for the altField option. |
void |
setAppendText(String appendText)
Set's the text to display after each date field, e.g. |
void |
setAutoSize(boolean autoSize)
Set to true to automatically resize the input field to accomodate dates in the current dateFormat. |
void |
setBeforeShowDayEvent(JsScopeUiDatePickerEvent beforeShowDay)
The function takes a date as a parameter and must return an array with [0] equal to true/false indicating whether or not this date is selectable, [1] equal to a CSS class name(s) or '' for the default presentation and [2] an optional popup tooltip for this date. |
void |
setBeforeShowEvent(JsScopeUiEvent beforeShow)
Set's the callback before the datepicker is displayed. |
void |
setButtonImage(String buttonImage)
Set's URL for the popup button image. |
void |
setButtonImageOnly(boolean buttonImageOnly)
Set to true to place an image after the field to use as the trigger without it appearing on a button. |
void |
setButtonText(String buttonText)
Set's the text to display on the trigger button. |
void |
setCalculateWeek(JsScope calculateWeek)
A function to calculate the week of the year for a given date. |
void |
setChangeMonth(boolean changeMonth)
Sets if the date's month is selectable in a drop down list or not. |
void |
setChangeYear(boolean changeYear)
Sets if the date's year is selectable in a drop down list or not. |
void |
setCloseText(String closeText)
Set's the text to display for the close link. |
void |
setConstrainInput(boolean constrainInput)
True if the input field is constrained to the current date format. |
void |
setCurrentText(String currentText)
Set's the text to display for the current day link. |
void |
setDateFormat(String dateFormat)
Sets the ISO date format to use. |
void |
setDayNames(ArrayOfDayNames dayNames)
Set's the list of long day names, starting from Sunday, for use as requested via the dateFormat setting. |
void |
setDayNamesMin(ArrayOfDayNames dayNamesMin)
Set's the list of minimised day names, starting from Sunday, for use as column headers within the datepicker. |
void |
setDayNamesShort(ArrayOfDayNames dayNamesShort)
Set's the list of abbreviated day names, starting from Sunday, for use as requested via the dateFormat setting. |
void |
setDefaultDate(DateOption defaultDate)
Set the date to highlight on first opening if the field is blank. |
void |
setDisabled(boolean disabled)
Disables (true) or enables (false) the datepicker. |
void |
setDuration(DatePickerDuration duration)
Control the speed at which the datepicker appears, it may be a time in milliseconds, a string representing one of the three predefined speeds ("slow", "normal", "fast"), or '' for immediately. |
void |
setFirstDay(short firstDay)
Sets the calendar's starting day. |
void |
setGotoCurrent(boolean gotoCurrent)
If true, the current day link moves to the currently selected date instead of today. |
void |
setHideIfNoPrevNext(boolean hideIfNoPrevNext)
Normally the previous and next links are disabled when not applicable (see minDate/maxDate). |
void |
setIsRTL(boolean isRTL)
True if the current language is drawn from right to left. |
void |
setMaxDate(DateOption maxDate)
Set a maximum selectable date via a Date object, or a number of days from today (e.g. |
void |
setMinDate(DateOption minDate)
Set a minimum selectable date via a Date object, or a number of days from today (e.g. |
void |
setMonthNames(ArrayOfMonthNames monthNames)
Set's the list of full month names, as used in the month header on each datepicker and as requested via the dateFormat setting. |
void |
setMonthNamesShort(ArrayOfMonthNames monthNamesShort)
Set's the list of abbreviated month names, for use as requested via the dateFormat setting. |
void |
setNavigationAsDateFormat(boolean navigationAsDateFormat)
When true the formatDate function is applied to the prevText, nextText, and currentText values before display, allowing them to display the target month names for example. |
void |
setNextText(String nextText)
Set's the text to display for the next month link. |
void |
setNumberOfMonths(DatePickerNumberOfMonths numberOfMonths)
Sets the number of months displayed on the date picker. |
void |
setOnChangeMonthYearEvent(JsScopeUiDatePickerOnChangeEvent onChangeMonthYear)
Allows you to define your own event when the datepicker moves to a new month and/or year. |
void |
setOnCloseEvent(JsScopeUiDatePickerDateTextEvent onClose)
Allows you to define your own event when the datepicker is closed, whether or not a date is selected. |
void |
setOnSelectEvent(JsScopeUiDatePickerDateTextEvent onSelect)
Allows you to define your own event when the datepicker is selected. |
void |
setPrevText(String prevText)
Set's the text to display for the previous month link. |
void |
setSelectOtherMonths(boolean selectOtherMonths)
When true days in other months shown before or after the current month are selectable. |
void |
setShortYearCutoff(DatePickerShortYearCutOff shortYearCutoff)
Set the cutoff year for determining the century for a date |
void |
setShowAnim(String showAnim)
Set the name of the animation used to show/hide the datepicker. |
void |
setShowButtonPanel(boolean showButtonPanel)
Whether to show the button panel. |
void |
setShowCurrentAtPos(short showCurrentAtPos)
Specify where in a multi-month display the current month shows, starting from 0 at the top/left. |
void |
setShowMonthAfterYear(boolean showMonthAfterYear)
Whether to show the month after the year in the header. |
void |
setShowOn(DatePicker.ShowOnEnum showOn)
Have the datepicker appear automatically when the field receives focus ('focus'), appear only when a button is clicked ('button'), or appear when either event takes place ('both'). |
void |
setShowOptions(ListItemOptions<LiteralOption> showOptions)
If using one of the jQuery UI effects for showAnim, you can provide additional settings for that animation via this option. |
void |
setShowOtherMonths(boolean showOtherMonths)
Sets if the next/previous months are showed in the calendar. |
void |
setShowWeek(boolean showWeek)
When true a column is added to show the week of the year. |
void |
setStepMonths(short stepMonths)
Sets the number of months stepped when the next/previous button are hit. |
void |
setWeekHeader(String weekHeader)
The text to display for the week of the year column heading. |
void |
setYearRange(DatePickerYearRange yearRange)
Sets the selectable year range. |
void |
setYearSuffix(String yearSuffix)
Additional text to display after the year in the month headers. |
Methods inherited from class org.odlabs.wiquery.core.options.Options |
---|
containsKey, detach, get, getBoolean, getComplexOption, getDouble, getFloat, getInt, getJavaScriptOptions, getJsScope, getListItemOptions, getLiteral, getObject, getShort, isEmpty, put, put, put, put, put, put, put, put, put, put, putBoolean, putDouble, putFloat, putInteger, putLiteral, putLiteral, putLong, putShort, putString, removeOption, setObject, setOwner, setRenderer |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DatePickerOptions(org.apache.wicket.Component owner)
Method Detail |
---|
public void setAltField(String altField)
altField
- public String getAltField()
public void setAltFormat(String altFormat)
altFormat
- public String getAltFormat()
public void setAppendText(String appendText)
appendText
- public String getAppendText()
public void setAutoSize(boolean autoSize)
public boolean isAutoSize()
public void setButtonImage(String buttonImage)
buttonImage
- public String getButtonImage()
public void setButtonImageOnly(boolean buttonImageOnly)
buttonImageOnly
- public boolean isButtonImageOnly()
public void setButtonText(String buttonText)
buttonText
- public String getButtonText()
public void setCalculateWeek(JsScope calculateWeek)
calculateWeek
- public void setChangeMonth(boolean changeMonth)
public boolean isChangeMonth()
public void setWeekHeader(String weekHeader)
weekHeader
- public String getWeekHeader()
public void setYearRange(DatePickerYearRange yearRange)
yearRange
- public DatePickerYearRange getYearRange()
public void setYearSuffix(String yearSuffix)
yearSuffix
- public String getYearSuffix()
public void setChangeYear(boolean changeYear)
public boolean isChangeYear()
public void setCloseText(String closeText)
closeText
- public String getCloseText()
public void setConstrainInput(boolean constrainInput)
constrainInput
- public boolean isConstrainInput()
public void setCurrentText(String currentText)
currentText
- public String getCurrentText()
public void setFirstDay(short firstDay)
firstDay
- public short getFirstDay()
public void setGotoCurrent(boolean gotoCurrent)
gotoCurrent
- public boolean isGotoCurrent()
public void setHideIfNoPrevNext(boolean hideIfNoPrevNext)
hideIfNoPrevNext
- public boolean isHideIfNoPrevNext()
public void setIsRTL(boolean isRTL)
isRTL
- public boolean isIsRTL()
public void setMaxDate(DateOption maxDate)
maxDate
- public DateOption getMaxDate()
public void setMinDate(DateOption minDate)
minDate
- public DateOption getMinDate()
public void setMonthNames(ArrayOfMonthNames monthNames)
monthNames
- public ArrayOfMonthNames getMonthNames()
public void setMonthNamesShort(ArrayOfMonthNames monthNamesShort)
monthNamesShort
- public ArrayOfMonthNames getMonthNamesShort()
public void setNavigationAsDateFormat(boolean navigationAsDateFormat)
navigationAsDateFormat
- public boolean isNavigationAsDateFormat()
public void setNextText(String nextText)
nextText
- public String getNextText()
public void setShowOtherMonths(boolean showOtherMonths)
public boolean getShowOtherMonths()
public boolean isShowOtherMonths()
public void setNumberOfMonths(DatePickerNumberOfMonths numberOfMonths)
public DatePickerNumberOfMonths getNumberOfMonths()
public void setPrevText(String prevText)
prevText
- public String getPrevText()
public void setSelectOtherMonths(boolean selectOtherMonths)
selectOtherMonths
- public boolean isSelectOtherMonths()
public void setShortYearCutoff(DatePickerShortYearCutOff shortYearCutoff)
shortYearCutoff
- public DatePickerShortYearCutOff getShortYearCutoff()
public void setShowAnim(String showAnim)
showAnim
- public String getShowAnim()
public void setShowButtonPanel(boolean showButtonPanel)
showButtonPanel
- public boolean isShowButtonPanel()
public void setShowCurrentAtPos(short showCurrentAtPos)
showCurrentAtPos
- public short getShowCurrentAtPos()
public void setShowMonthAfterYear(boolean showMonthAfterYear)
showMonthAfterYear
- public boolean isShowMonthAfterYear()
public void setShowOn(DatePicker.ShowOnEnum showOn)
showOn
- public DatePicker.ShowOnEnum getShowOn()
public void setShowOptions(ListItemOptions<LiteralOption> showOptions)
showOptions
- public ListItemOptions<LiteralOption> getShowOptions()
public void setShowWeek(boolean showWeek)
public boolean isShowWeek()
public void setStepMonths(short stepMonths)
public short getStepMonths()
public void setDateFormat(String dateFormat)
public String getDateFormat()
public void setDayNames(ArrayOfDayNames dayNames)
dayNames
- public ArrayOfDayNames getDayNames()
public void setDayNamesMin(ArrayOfDayNames dayNamesMin)
dayNamesMin
- public ArrayOfDayNames getDayNamesMin()
public void setDayNamesShort(ArrayOfDayNames dayNamesShort)
dayNamesShort
- public ArrayOfDayNames getDayNamesShort()
public void setDefaultDate(DateOption defaultDate)
defaultDate
- public DateOption getDefaultDate()
public void setDisabled(boolean disabled)
disabled
- public boolean isDisabled()
public void setDuration(DatePickerDuration duration)
duration
- public DatePickerDuration getDuration()
public void setBeforeShowEvent(JsScopeUiEvent beforeShow)
beforeShow
- public void setBeforeShowDayEvent(JsScopeUiDatePickerEvent beforeShowDay)
beforeShowDay
- public void setOnChangeMonthYearEvent(JsScopeUiDatePickerOnChangeEvent onChangeMonthYear)
onChangeMonthYear
- public void setOnCloseEvent(JsScopeUiDatePickerDateTextEvent onClose)
onClose
- public void setOnSelectEvent(JsScopeUiDatePickerDateTextEvent onSelect)
onSelect
- public Options getOptions()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |