public class FlexDateChooser extends FlexObject
The user can select a date, a range of dates, or multiple dates. The control contains forward and back arrow buttons for changing the month and year.
You can let users select multiple dates, disable the selection of certain dates, and limit the display to a range of dates.
Modifier | Constructor and Description |
---|---|
protected |
FlexDateChooser(JtfObjectHandle handle,
Desktop desktop)
Creates a new FlexDateChooser with a JtfObjectHandle.
|
Modifier and Type | Method and Description |
---|---|
void |
change(Date newDate)
Dispatched when a date is selected or changed.
|
Color |
getColor()
Gets the color of text in the component, including the component label.
|
Color |
getDisabledColor()
Gets the color of text in the component if it is disabled.
|
List<String> |
getDisabledDays()
Gets the days to disable in a week.
|
List<String> |
getDisabledRanges()
Gets the single and multiple days to disable.
|
int |
getDisplayedMonth()
Gets the month displayed in the DateChooser control.
|
int |
getDisplayedYear()
Gets the year displayed in the DateChooser control.
|
List<Color> |
getFillColors()
Gets the colors used to tint the background of the control.
|
int |
getFirstDayOfWeek()
Gets the number representing the day of the week to display in the first column of the DateChooser control.
|
String |
getFontFamily()
Gets the name of the font to use.
|
double |
getFontSize()
Gets the height of the text, in pixels.
|
String |
getFontStyle()
Gets whether the text is italic font.
|
String |
getFontWeight()
Gets whether the text is boldface.
|
List<Color> |
getHeaderColors()
Gets the colors of the band at the top of the DateChooser control.
|
int |
getMaxYear()
Gets the last year selectable in the control.
|
int |
getMinYear()
Gets the first year selectable in the control.
|
Color |
getRollOverColor()
Gets the color of the highlight area of the date when the user holds the mouse pointer over a date in the DateChooser control.
|
Date |
getSelectedDate()
Gets the date as selected in the DateChooser control.
|
List<String> |
getSelectedRanges()
Gets the selected date ranges.
|
Color |
getSelectionColor()
Gets the color of the highlight area of the currently selected date in the DateChooser control.
|
String |
getTextAlign()
Gets whether the text is boldface.
|
String |
getTextDecoration()
Gets whether the text is underlined.
|
int |
getTextIndent()
Gets the offset of first line of text from the left side of the container, in pixels.
|
Color |
getTodayColor()
Gets the color of the highlight of today's date in the DateChooser control.
|
boolean |
isAllowDisjointSelection()
Gets whether non-contiguous selection is allowed in the DateChooser control.
|
boolean |
isAllowMultipleSelection()
Gets whether multiple selection is allowed in the DateChooser control.
|
boolean |
isShowToday()
Gets whether today's date is highlighted in the DataChooser control.
|
boolean |
isYearNavigationEnabled()
Gets whether year navigation is enabled.
|
void |
scrollDate(FlexDateScrollDetail detail)
The DateChooserEvent.SCROLL constant defines the value of the type property of the event object for a scrollevent.
|
void |
type(String keyCode)
Dispatched when the user presses a key.
|
void |
type(String keyCode,
ModifierKey keyModifier)
Dispatched when the user presses a key.
|
changeFocus, changeFocus, changeFocus, getAutomationClassName, getAutomationIndex, getAutomationName, getClassName, getCurrentState, getErrorColor, getErrorString, getId, getNumAutomationChildren, getPercentHeight, getPercentWidth, getScaleX, getScaleY, getThemeColor, getToolTip, isEnabled, isFocusEnabled, isUseHandCursor, move, move, move, setFocus
click, click, click, click, doubleClick, doubleClick, doubleClick, doubleClick, getAlpha, getHeight, getStyle, getTabIndex, getWidth, getX, getY, isMouseEnabled, isTabChildren, isTabEnabled, isVisible, mouseMove, mouseMove, nativeToString, pressKeys, pressKeys, pressMouse, pressMouse, pressMouse, pressMouse, releaseKeys, releaseKeys, releaseMouse, releaseMouse, releaseMouse, releaseMouse, typeKeys, typeKeys, typeKeys, typePasswordKeys, typePasswordKeys, typePasswordKeys
captureBitmap, captureBitmap, exists, exists, generateLocator, getChildren, getDynamicMethodList, getParent, getPropertyList, getRect, getRect, getText, getValue, highlightObject, highlightObject, highlightObject, invokeMethods, textCapture, textCapture, textClick, textClick, textClick, textClick, textClick, textClick, textExists, textExists, textExists, textExists, textExists, textRectangle, textRectangle, textRectangle, textRectangle, textRectangle, waitForChildDisappearance, waitForChildDisappearance, waitForDisappearance, waitForDisappearance, waitForObject, waitForObject, waitForProperty, waitForProperty
equals, exists, find, find, findAll, findAll, getCustomTypeName, getDesktop, getHandle, getLocator, getProperty, getTypeName, hashCode, imageClick, imageClick, imageClick, imageClick, imageClick, imageClick, imageClickFile, imageClickFile, imageClickFile, imageClickFile, imageClickFile, imageClickFile, imageExists, imageExists, imageExists, imageExistsFile, imageExistsFile, imageExistsFile, imageRectangle, imageRectangle, imageRectangle, imageRectangleFile, imageRectangleFile, imageRectangleFile, invoke, preventFinalLocator, setProperty, toString
protected FlexDateChooser(JtfObjectHandle handle, Desktop desktop)
handle
- the handle that identifies the FlexDateChooserdesktop
- the desktop on which this object livespublic void change(Date newDate)
newDate
- the date selected in the controlpublic void scrollDate(FlexDateScrollDetail detail)
detail
- the scroll directionpublic void type(String keyCode)
keyCode
- the key code value of the key pressed or releasedpublic void type(String keyCode, ModifierKey keyModifier)
keyCode
- the key code value of the key pressed or releasedkeyModifier
- the key modifiers (for example, the Ctrl key) to usepublic boolean isAllowDisjointSelection()
If true, non-contiguous selection is allowed in the DateChooser control. This property has an effect only if the allowMultipleSelection property is true. Setting this property changes the appearance of the DateChooser control.
The default value is true.
public boolean isAllowMultipleSelection()
If true, specifies that multiple selection is allowed in the DateChooser control.
The default value is false.
public Color getColor()
public Color getDisabledColor()
public List<String> getDisabledDays()
All the dates in a month, for the specified day, are disabled. This property changes the appearance of the DateChooser control. The elements of this array can have values from 0 (Sunday) to 6 (Saturday).
public List<String> getDisabledRanges()
public int getDisplayedMonth()
Month numbers are zero-based, so January is 0 and December is 11. Setting this property changes the appearance of the DateChooser control.
The default value is the current month.
public int getDisplayedYear()
public List<Color> getFillColors()
Deprecated Since 3.0: Use nextMonthStyleFilters, prevMonthStyleFilters
Pass the same color for both values for a flat-looking control. The default value is [ 0xFFFFFF, 0xCCCCCC ].
public int getFirstDayOfWeek()
The value must be in the range 0 to 6, where 0 corresponds to Sunday, the first element of the dayNames Array.
Setting this property changes the order of the day columns. For example, setting it to 1 makes Monday the first column in the control.
The default value is 0 (Sunday).
public String getFontFamily()
Unlike in a full CSS implementation, comma-separated lists are not supported. You can use any font family name. If you specify a generic font name, it is converted to an appropriate device font. The default value is Verdana
.
public double getFontSize()
The default value is 10 for all controls except the ColorPicker control. For the ColorPicker control, the default value is 11.
public String getFontStyle()
Recognized values are normal
and italic
. The default value is normal
.
public String getFontWeight()
Recognized values are normal and bold. The default value for Button controls is bold. The default value for all other controls is normal.
public List<Color> getHeaderColors()
Deprecated Since 3.0: Use dateChooserStyleName
public int getMaxYear()
public int getMinYear()
public Color getRollOverColor()
public Date getSelectedDate()
public Color getSelectionColor()
public boolean isShowToday()
If true, specifies that today is highlighted in the DateChooser control. The default value is true.
public String getTextAlign()
Recognized values are normal and bold. The default value for Button controls is bold. The default value for all other controls is normal.
public String getTextDecoration()
Possible values are none
and underline
. The default value is none
.
public int getTextIndent()
public Color getTodayColor()
public boolean isYearNavigationEnabled()
When true an up and down button appear to the right of the displayed year. You can use these buttons to change the current year. These button appear to the left of the year in locales where year comes before the month in the date format.
The default value is false.
Copyright 2009-2012 Micro Focus. All Rights Reserved.