Class DateChooser
- All Implemented Interfaces:
HasAttachHandlers,HasHandlers,EventListener,HasVisibility,IsWidget,LogicalStructure,HasClearHandlers,HasClickHandlers,HasDataChangedHandlers,HasDoubleClickHandlers,HasDragMoveHandlers,HasDragRepositionMoveHandlers,HasDragRepositionStartHandlers,HasDragRepositionStopHandlers,HasDragResizeMoveHandlers,HasDragResizeStartHandlers,HasDragResizeStopHandlers,HasDragStartHandlers,HasDragStopHandlers,HasDropHandlers,HasDropMoveHandlers,HasDropOutHandlers,HasDropOverHandlers,HasFocusChangedHandlers,HasHoverHandlers,HasHoverHiddenHandlers,HasKeyDownHandlers,HasKeyPressHandlers,HasMouseDownHandlers,HasMouseMoveHandlers,HasMouseOutHandlers,HasMouseOverHandlers,HasMouseStillDownHandlers,HasMouseUpHandlers,HasMouseWheelHandlers,HasMovedHandlers,HasParentMovedHandlers,HasResizedHandlers,HasRightMouseDownHandlers,HasRuleContextChangedHandlers,HasScrolledHandlers,HasShowContextMenuHandlers,HasVisibilityChangedHandlers,HasMembersChangedHandlers
DateItem class.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfaceA customizer that allows you to alter the year representations used in various places in the DateChooser widget.Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled -
Field Summary
Fields inherited from class com.smartgwt.client.widgets.BaseWidget
config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassNameFields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddDataChangedHandler(DataChangedHandler handler) Add a dataChanged handler.voidFired when the user clicks the cancel button in this date chooser.static voidchangeAutoChildDefaults(String autoChildName, Canvas defaults) Changes the defaults for Canvas AutoChildren namedautoChildName.static voidchangeAutoChildDefaults(String autoChildName, FormItem defaults) Changes the defaults for FormItem AutoChildren namedautoChildName.protected JavaScriptObjectcreate()The text appended to the style name when usingalternateWeekStyles.Whether alternating weeks should be drawn in alternating styles.When a DateChooser is configured fora "datetime" value, clicking on a date cell in thegridwill not automatically dismiss the DateChooser canvas.Title for theApplybutton.CSS style to apply to the buttons at the bottom of the DateChooser ("Today" and "Cancel").Base CSS style applied to this picker's buttons.Base CSS style applied to cells in thefiscal year column.CSS style to apply to navigation buttons and date display at the top of the component.Base CSS style applied to weekdays.Base CSS style applied to weekends.Base CSS style applied to cells in thefiscal week column.String[]Array of members to show in thebuttonLayout.A button shown below thecalendar gridwhich, when clicked, closes the DateChooser without selecting a value.Title for the cancellation button.When editing a "date" value, with no time portion, clicking on a date-cell selects the date and closes the DateChooser.booleanShould this dateChooser be dismissed if the user presses the Escape key?getData()Get the current value of the picker.AListGridsubclass, responsible for rendering the calendar view.intHow long (how many characters) should be day names be.Date[]An array of Date instances that should be disabled if they appear in the calendar view.Base CSS style applied to weekday dates which have beendisabled.Base CSS style applied to weekend dates which have beendisabled.Whether it should be valid to pick a weekend day.Limits the selectable range of this DateChooser.intLatest year that may be selected.WhenendYearis unset, this is the years after today that will be available for selection in the year menu.intDay of the week to show in the first column.Returns theFiscalCalendarobject that will be used by this DateChooser.A button shown in thenavigation layoutwhich, when clicked, shows a picker for selecting a specific fiscal year.Title for thefiscal yearfield in the date grid.Base CSS style applied to the header of thefiscal year columnin thecalendar view.Deprecated.CSS style applied to the day-of-week headers.Getter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.Base CSS style applied to cells in the Year, Week and Month popup-menus.A button shown in thenavigation layoutthat shows a picker for selecting a specific month.Style for the pop-up year menu.Height of buttons in thenavigation area, used for navigating thecalendar view.intHeight of thenavigation area, containing the various buttons for navigating thecalendar view.A button shown in thenavigation layoutthat shifts the calendar view forward by a month.Aria labelfor thenextMonthButton.Icon for the next month buttonintHeight of the icon for the next month buttonIcon for the next month buttonintWidth of the icon for the next month button ifPage.isRTL()is true.A button shown in thenavigation layoutthat shifts the calendar view forward by a year.Aria labelfor thenextYearButton.Icon for the next year buttonintHeight of the icon for the next year buttonIcon for the next year button ifPage.isRTL()is true.intWidth of the icon for the next year buttonstatic DateChoosergetOrCreateRef(JavaScriptObject jsObj) A button shown in thenavigation layoutthat shifts the calendar view backward by a month.Aria labelfor thepreviousMonthButton.A button shown in thenavigation layoutthat shifts the calendar view backward by a year.Aria labelfor thepreviousYearButton.Icon for the previous month buttonintHeight of the icon for the previous month buttonIcon for the previous month button ifPage.isRTL()is true.intWidth of the icon for the previous month buttonIcon for the previous year buttonintHeight of the icon for the previous year buttonIcon for the previous year button ifPage.isRTL()is true.intWidth of the icon for the previous year buttonCSS style applied to the Fiscal Year and Week columns for the currently selected week (the one being displayed in theweek chooser).Determines whether theapplyButtonwill be displayed.Determines whether the "Cancel" button will be displayed.When set to true, show a button that allows the calendar to be navigated by fiscal year.When showing thetime field, whether to show the "second" picker.Whether to show thetime fieldfor editing the time portion of the date.Determines whether the "Today" button will be displayed, allowing the user to select the current date.When set to true, show a button that allows the calendar to be navigated by week or fiscal week, depending on the value ofshowFiscalYearChooser.Whether weekend days should be shown.Overridden directory where images for this widget (such as the month and year button icons) may be found.Limits the selectable range of this DateChooser.intEarliest year that may be selected.WhenstartYearis unset, this is the years before today that will be available for selection in the year menu.Whether weekend days should be styled differently from weekdays.TimeItemfor editing the time portion of dates.Custom properties to apply to thetime fieldused for editing the time portion of the date.Title for thetime field.A button shown below thecalendar gridwhich, when clicked, navigates the calendar to today.If set specifies a fixed height for the Today and Cancel buttons.Title for "Today" button.When showing thetime field, whether theTimeItemshould be set to use 24-hour time.When showing thefiscal year chooser, should firstDayOfWeek be defaulted to the same day as the fiscal start date? If true and a fiscal year starts on a Tuesday, the calendar will display Tuesday to Monday from left to right.A button shown in thenavigation layoutwhich shows a picker for selecting a specific week of the year.int[]An array of integer day-numbers that should be considered to be weekend days by this DateChooser instance.Optional CSS style applied to the day-of-week headers for weekend days.Title for theweekfield in the date grid.Base CSS style applied to the header of thefiscal or calendar week columnin thecalendar view.Style for the pop-up week menu.A button shown in thenavigation layoutthat shows a picker for selecting a specific calendar year.Style for the pop-up year menu.setAlternateStyleSuffix(String alternateStyleSuffix) The text appended to the style name when usingalternateWeekStyles.setAlternateWeekStyles(Boolean alternateWeekStyles) Whether alternating weeks should be drawn in alternating styles.setApplyButtonTitle(String applyButtonTitle) Title for theApplybutton.setBaseBottomButtonStyle(String baseBottomButtonStyle) CSS style to apply to the buttons at the bottom of the DateChooser ("Today" and "Cancel").setBaseButtonStyle(String baseButtonStyle) Base CSS style applied to this picker's buttons.setBaseFiscalYearStyle(String baseFiscalYearStyle) Base CSS style applied to cells in thefiscal year column.setBaseNavButtonStyle(String baseNavButtonStyle) CSS style to apply to navigation buttons and date display at the top of the component.setBaseWeekdayStyle(String baseWeekdayStyle) Base CSS style applied to weekdays.setBaseWeekendStyle(String baseWeekendStyle) Base CSS style applied to weekends.setBaseWeekStyle(String baseWeekStyle) Base CSS style applied to cells in thefiscal week column.setButtonLayoutControls(String... buttonLayoutControls) Array of members to show in thebuttonLayout.setCancelButtonTitle(String cancelButtonTitle) Title for the cancellation button.setCloseOnDateClick(Boolean closeOnDateClick) When editing a "date" value, with no time portion, clicking on a date-cell selects the date and closes the DateChooser.setCloseOnEscapeKeypress(boolean closeOnEscapeKeypress) Should this dateChooser be dismissed if the user presses the Escape key?voidSet the picker to show the given date.setDayNameLength(int dayNameLength) How long (how many characters) should be day names be.static voidsetDefaultProperties(DateChooser dateChooserProperties) Class level method to set the default properties of this class.setDisabledDates(Date... disabledDates) An array of Date instances that should be disabled if they appear in the calendar view.setDisabledWeekdayStyle(String disabledWeekdayStyle) Base CSS style applied to weekday dates which have beendisabled.setDisabledWeekendStyle(String disabledWeekendStyle) Base CSS style applied to weekend dates which have beendisabled.setDisableWeekends(Boolean disableWeekends) Whether it should be valid to pick a weekend day.setEndDate(Date endDate) Limits the selectable range of this DateChooser.setEndYear(int endYear) Latest year that may be selected.setEndYearRange(Integer endYearRange) WhenendYearis unset, this is the years after today that will be available for selection in the year menu.setFirstDayOfWeek(int firstDayOfWeek) Day of the week to show in the first column.voidSets theFiscalCalendarobject that will be used by this DateChooser.voidsetFiscalCalendar(FiscalCalendar fiscalCalendar) Sets theFiscalCalendarobject that will be used by this DateChooser.setFiscalYearFieldTitle(String fiscalYearFieldTitle) Title for thefiscal yearfield in the date grid.setFiscalYearHeaderStyle(String fiscalYearHeaderStyle) Base CSS style applied to the header of thefiscal year columnin thecalendar view.setHeaderHeight(Integer headerHeight) Deprecated.in favor ofnavigationLayoutHeightsetHeaderStyle(String headerStyle) CSS style applied to the day-of-week headers.Setter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.setMenuItemStyle(String menuItemStyle) Base CSS style applied to cells in the Year, Week and Month popup-menus.setMonthMenuStyle(String monthMenuStyle) Style for the pop-up year menu.setNavigationButtonHeight(Integer navigationButtonHeight) Height of buttons in thenavigation area, used for navigating thecalendar view.setNavigationLayoutHeight(int navigationLayoutHeight) Height of thenavigation area, containing the various buttons for navigating thecalendar view.setNextMonthButtonAriaLabel(String nextMonthButtonAriaLabel) Aria labelfor thenextMonthButton.setNextMonthIcon(String nextMonthIcon) Icon for the next month buttonsetNextMonthIconHeight(int nextMonthIconHeight) Height of the icon for the next month buttonsetNextMonthIconRTL(String nextMonthIconRTL) Icon for the next month buttonsetNextMonthIconWidth(int nextMonthIconWidth) Width of the icon for the next month button ifPage.isRTL()is true.setNextYearButtonAriaLabel(String nextYearButtonAriaLabel) Aria labelfor thenextYearButton.setNextYearIcon(String nextYearIcon) Icon for the next year buttonsetNextYearIconHeight(int nextYearIconHeight) Height of the icon for the next year buttonsetNextYearIconRTL(String nextYearIconRTL) Icon for the next year button ifPage.isRTL()is true.setNextYearIconWidth(int nextYearIconWidth) Width of the icon for the next year buttonsetPreviousMonthButtonAriaLabel(String previousMonthButtonAriaLabel) Aria labelfor thepreviousMonthButton.setPreviousYearButtonAriaLabel(String previousYearButtonAriaLabel) Aria labelfor thepreviousYearButton.setPrevMonthIcon(String prevMonthIcon) Icon for the previous month buttonsetPrevMonthIconHeight(int prevMonthIconHeight) Height of the icon for the previous month buttonsetPrevMonthIconRTL(String prevMonthIconRTL) Icon for the previous month button ifPage.isRTL()is true.setPrevMonthIconWidth(int prevMonthIconWidth) Width of the icon for the previous month buttonsetPrevYearIcon(String prevYearIcon) Icon for the previous year buttonsetPrevYearIconHeight(int prevYearIconHeight) Height of the icon for the previous year buttonsetPrevYearIconRTL(String prevYearIconRTL) Icon for the previous year button ifPage.isRTL()is true.setPrevYearIconWidth(int prevYearIconWidth) Width of the icon for the previous year buttonsetSelectedWeekStyle(String selectedWeekStyle) CSS style applied to the Fiscal Year and Week columns for the currently selected week (the one being displayed in theweek chooser).setShowApplyButton(Boolean showApplyButton) Determines whether theapplyButtonwill be displayed.setShowCancelButton(Boolean showCancelButton) Determines whether the "Cancel" button will be displayed.setShowFiscalYearChooser(Boolean showFiscalYearChooser) When set to true, show a button that allows the calendar to be navigated by fiscal year.setShowSecondItem(Boolean showSecondItem) When showing thetime field, whether to show the "second" picker.setShowTimeItem(Boolean showTimeItem) Whether to show thetime fieldfor editing the time portion of the date.setShowTodayButton(Boolean showTodayButton) Determines whether the "Today" button will be displayed, allowing the user to select the current date.setShowWeekChooser(Boolean showWeekChooser) When set to true, show a button that allows the calendar to be navigated by week or fiscal week, depending on the value ofshowFiscalYearChooser.setShowWeekends(Boolean showWeekends) Whether weekend days should be shown.setSkinImgDir(String skinImgDir) Overridden directory where images for this widget (such as the month and year button icons) may be found.setStartDate(Date startDate) Limits the selectable range of this DateChooser.setStartYear(int startYear) Earliest year that may be selected.setStartYearRange(Integer startYearRange) WhenstartYearis unset, this is the years before today that will be available for selection in the year menu.setStyleWeekends(Boolean styleWeekends) Whether weekend days should be styled differently from weekdays.setTimeItemProperties(TimeItem timeItemProperties) Custom properties to apply to thetime fieldused for editing the time portion of the date.setTimeItemTitle(String timeItemTitle) Title for thetime field.setTodayButtonHeight(Integer todayButtonHeight) If set specifies a fixed height for the Today and Cancel buttons.setTodayButtonTitle(String todayButtonTitle) Title for "Today" button.setUse24HourTime(Boolean use24HourTime) When showing thetime field, whether theTimeItemshould be set to use 24-hour time.setUseFirstDayOfFiscalWeek(Boolean useFirstDayOfFiscalWeek) When showing thefiscal year chooser, should firstDayOfWeek be defaulted to the same day as the fiscal start date? If true and a fiscal year starts on a Tuesday, the calendar will display Tuesday to Monday from left to right.setWeekendDays(int... weekendDays) An array of integer day-numbers that should be considered to be weekend days by this DateChooser instance.setWeekendHeaderStyle(String weekendHeaderStyle) Optional CSS style applied to the day-of-week headers for weekend days.setWeekFieldTitle(String weekFieldTitle) Title for theweekfield in the date grid.setWeekHeaderStyle(String weekHeaderStyle) Base CSS style applied to the header of thefiscal or calendar week columnin thecalendar view.setWeekMenuStyle(String weekMenuStyle) Style for the pop-up week menu.setYearMenuStyle(String yearMenuStyle) Style for the pop-up year menu.voidvoidFired when the user clicks the Today button.Methods inherited from class com.smartgwt.client.widgets.layout.VLayout
setDefaultProperties, setLogicalStructureMethods inherited from class com.smartgwt.client.widgets.layout.Layout
addMember, addMember, addMember, addMember, addMemberPostCreate, addMemberPostCreate, addMemberPreCreate, addMemberPreCreate, addMembers, addMembers, addMembersChangedHandler, getAnimateMembers, getAnimateMemberTime, getCanDropComponents, getChildTabPosition, getDefaultResizeBars, getDropComponent, getDropLine, getDropLineThickness, getDropPosition, getEditProxyConstructor, getEnforcePolicy, getHPolicy, getLayoutBottomMargin, getLayoutEndMargin, getLayoutLeftMargin, getLayoutMargin, getLayoutRightMargin, getLayoutStartMargin, getLayoutTopMargin, getLeaveScrollbarGap, getLocateMembersBy, getLocateMembersType, getManagePercentBreadth, getMember, getMember, getMemberDefaultBreadth, getMemberNumber, getMemberNumber, getMemberOverlap, getMembers, getMembersLength, getMembersMargin, getMinMemberLength, getMinMemberSize, getOverflow, getPaddingAsLayoutMargin, getResizeBar, getResizeBarClass, getResizeBarSize, getReverseOrder, getShowDragPlaceHolder, getShowDropLines, getStackZIndex, getVertical, getVPolicy, hasMember, hideDropLine, hideMember, hideMember, layoutIsDirty, onInit, onInit_Layout, reflow, reflow, reflowNow, removeMember, removeMembers, removeMembers, reorderMember, reorderMembers, replaceMember, revealChild, revealChild, setAlign, setAlign, setAnimateMembers, setAnimateMemberTime, setCanDropComponents, setDefaultLayoutAlign, setDefaultLayoutAlign, setDefaultProperties, setDefaultResizeBars, setDropLineProperties, setDropLineThickness, setEditProxyConstructor, setEnforcePolicy, setHPolicy, setLayoutBottomMargin, setLayoutEndMargin, setLayoutLeftMargin, setLayoutMargin, setLayoutRightMargin, setLayoutStartMargin, setLayoutTopMargin, setLeaveScrollbarGap, setLocateMembersBy, setLocateMembersType, setLogicalStructure, setManagePercentBreadth, setMemberOverlap, setMembers, setMembersMargin, setMinBreadthMember, setMinBreadthMember, setMinBreadthMember, setMinMemberLength, setMinMemberSize, setOverflow, setPaddingAsLayoutMargin, setPlaceHolderDefaults, setPlaceHolderProperties, setResizeBarClass, setResizeBarSize, setReverseOrder, setShowDragPlaceHolder, setShowDropLines, setStackZIndex, setVertical, setVisibleMember, setVPolicy, showMember, showMemberMethods inherited from class com.smartgwt.client.widgets.Canvas
addChild, addChild, addChild, addChild, addChild, addClearHandler, addClickHandler, addDoubleClickHandler, addDragMoveHandler, addDragRepositionMoveHandler, addDragRepositionStartHandler, addDragRepositionStopHandler, addDragResizeMoveHandler, addDragResizeStartHandler, addDragResizeStopHandler, addDragStartHandler, addDragStopHandler, addDropHandler, addDropMoveHandler, addDropOutHandler, addDropOverHandler, addFocusChangedHandler, addHoverHandler, addHoverHiddenHandler, addKeyDownHandler, addKeyPressHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseStillDownHandler, addMouseUpHandler, addMouseWheelHandler, addMovedHandler, addParentMovedHandler, addPeer, addPeer, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addRuleContextChangedHandler, addScrolledHandler, addShowContextMenuHandler, addSnapAlignCandidate, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, asSGWTComponent, blur, bringToFront, clear, clearExplicitTabIndex, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsEventTarget, containsFocus, containsPoint, containsPoint, dataContextChanged, deparent, depeer, disable, enable, encloses, focus, focusAfterGroup, focusAtEnd, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAdaptiveHeightPriority, getAdaptiveWidthPriority, getAlwaysManageFocusNavigation, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideEffect, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeLayoutMode, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaHandleID, getAriaRole, getAriaStateDefaults, getAutoMaskComponents, getAutoParent, getAutoPopulateData, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBorderRadius, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanAdaptHeight, getCanAdaptWidth, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenResizeSnapAlign, getChildrenSnapAlign, getChildrenSnapCenterAlign, getChildrenSnapEdgeAlign, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getClassName, getComponentMask, getComponentMaskDefaults, getContentElement, getContents, getContextMenu, getCorrectZoomOverflow, getCursor, getDataContext, getDataPath, getDefaultHeight, getDefaultWidth, getDefiningProperty, getDefiningPropertyName, getDefiningPropertyNameOptions, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragMaxHeight, getDragMaxWidth, getDragMinHeight, getDragMinWidth, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragTargetAsString, getDragType, getDropTarget, getDropTargetAsString, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getElement, getElement, getEnableWhen, getEndLine, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFloatingScrollbars, getFormItemAutoChild, getForwardSVGeventsToObject, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupPadding, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverAutoFitMaxWidth, getHoverAutoFitMaxWidthAsString, getHoverAutoFitWidth, getHoverComponent, getHoverDelay, getHoverFocusKey, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverPersist, getHoverScreen, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlElementAsString, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getIsPrinting, getIsRuleScope, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeaveGroupLabelSpace, getLeavePageSpace, getLeft, getLeftAsString, getLocalId, getLocateByIDOnly, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getLocatorName, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMatchElementHeight, getMatchElementWidth, getMaxHeight, getMaxWidth, getMaxZoomOverflowError, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getName, getNativeAutoHideScrollbars, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPaletteDefaults, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPendingMarkerStyle, getPendingMarkerVisible, getPercentBox, getPercentSource, getPersistentMatchElement, getPointerSettings, getPointerTarget, getPointerTargetAsString, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrintStyleName, getPrompt, getProportionalResizeModifiers, getProportionalResizing, getReceiveScrollbarEvents, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getRuleContext, getRuleContext, getRuleScope, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowColor, getShadowDepth, getShadowHOffset, getShadowImage, getShadowOffset, getShadowSoftness, getShadowSpread, getShadowVOffset, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowPointer, getShowResizeBar, getShowShadow, getShowSnapGrid, getShrinkElementOnHide, getSizeMayChangeOnRedraw, getSnapAlignCandidates, getSnapAlignCenterLineStyle, getSnapAlignEdgeLineStyle, getSnapAxis, getSnapEdge, getSnapGridLineProperties, getSnapGridStyle, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapPosition, getSnapPosition, getSnapResizeToAlign, getSnapResizeToGrid, getSnapTo, getSnapToAlign, getSnapToCenterAlign, getSnapToEdgeAlign, getSnapToGrid, getSnapVDirection, getSnapVGap, getStartLine, getStyleName, getTabIndex, getTestDataContext, getTestInstance, getTitle, getTooltip, getTop, getTopAsString, getTopElement, getUISummary, getUpdateTabPositionOnDraw, getUpdateTabPositionOnReparent, getUseBackMask, getUseCSSShadow, getUseDragMask, getUseImageForSVG, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getValuesManagerAsString, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWhen, getVisibleWidth, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getWorkflows, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, initComplete, intersects, isDirty, isDisabled, isFocused, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, pageScrollDown, pageScrollUp, parentResized, placeNear, placeNear, placeNear, print, print, print, print, printComponents, provideRuleContext, provideRuleContext, redraw, redraw, registerFontScaledPaddingStyles, removeChild, removeChild, removePeer, removePeer, removeRuleContext, removeSnapAlignCandidate, resizeAutoChildAttributes, resizeBy, resizeControls, resizeControlsTo, resizeFonts, resizeFonts, resizeFonts, resizeFontsTo, resizeIcons, resizePadding, resizePadding, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAdaptHeightByCustomizer, setAdaptiveHeightPriority, setAdaptiveWidthPriority, setAdaptWidthByCustomizer, setAllowExternalFilters, setAlwaysManageFocusNavigation, setAlwaysShowScrollbars, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideEffect, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeLayoutMode, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoHeight, setAutoMaskComponents, setAutoParent, setAutoPopulateData, setAutoResizeAutoChildAttributes, setAutoResizeIcons, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBorderRadius, setBottom, setCanAcceptDrop, setCanAdaptHeight, setCanAdaptWidth, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContents, setContextMenu, setCorrectZoomOverflow, setCursor, setDataContext, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultShowCustomScrollbars, setDefaultWidth, setDefiningProperty, setDefiningPropertyNameOptions, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragMaxHeight, setDragMaxWidth, setDragMinHeight, setDragMinWidth, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragTarget, setDragType, setDropTarget, setDropTarget, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setElement, setEnableWhen, setEndLine, setExtraSpace, setFacetId, setFloatingScrollbars, setForwardSVGeventsToObject, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupPadding, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverAutoFitMaxWidth, setHoverAutoFitMaxWidth, setHoverAutoFitWidth, setHoverDelay, setHoverFocusKey, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverPersist, setHoverScreen, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setIsRuleScope, setIsSnapAlignCandidate, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeaveGroupLabelSpace, setLeavePageSpace, setLeft, setLeft, setLocateByIDOnly, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLocatorName, setLocatorParent, setLocatorParent, setLogicalStructure, setMargin, setMatchElement, setMatchElementHeight, setMatchElementWidth, setMaxHeight, setMaxWidth, setMaxZoomOverflowError, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setName, setNativeAutoHideScrollbars, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setOpacity, setPadding, setPageLeft, setPageTop, setPanelContainer, setParentCanvas, setParentElement, setPeers, setPendingMarkerStyle, setPendingMarkerVisible, setPercentBox, setPercentSource, setPersistentMatchElement, setPointerSettings, setPointerTarget, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrintStyleName, setPrompt, setProportionalResizeModifiers, setProportionalResizing, setReceiveScrollbarEvents, setRect, setRect, setRedrawOnResize, setRelativeTabPosition, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setRuleScope, setScrollbarConstructor, setScrollbarSize, setShadowColor, setShadowDepth, setShadowHOffset, setShadowImage, setShadowOffset, setShadowSoftness, setShadowSpread, setShadowVOffset, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowPointer, setShowResizeBar, setShowShadow, setShowSnapGrid, setShrinkElementOnHide, setSizeMayChangeOnRedraw, setSmoothFade, setSnapAlignCandidates, setSnapAlignCenterLineStyle, setSnapAlignEdgeLineStyle, setSnapAxis, setSnapEdge, setSnapGridLineProperties, setSnapGridStyle, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToAlign, setSnapResizeToGrid, setSnapTo, setSnapToAlign, setSnapToCenterAlign, setSnapToEdgeAlign, setSnapToGrid, setSnapVDirection, setSnapVGap, setStartLine, setStyleName, setTabIndex, setTestDataContext, setTitle, setTooltip, setTop, setTop, setUpdateTabPositionOnDraw, setUpdateTabPositionOnReparent, setUseBackMask, setUseCSSShadow, setUseDragMask, setUseImageForSVG, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setValuesManager, setVisibility, setVisible, setVisibleWhen, setWidth, setWidth, setWidth, setWidth100, setWorkflows, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPendingMarker, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, startDebuggingOverflow, stopDebuggingOverflow, updateChildTabPosition, updateChildTabPositions, updateEditNode, updateHover, updateHover, updateShadow, updateTabPositionForDraw, visibleAtPoint, willAcceptDropMethods inherited from class com.smartgwt.client.widgets.BaseWidget
addDrawHandler, addDynamicProperty, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, clearDynamicProperty, completeCreation, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hasDynamicProperty, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, isDrawn, isFactoryCreated, onBind, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDefaultProperties, setDragTracker, setFactoryCreated, setID, setJavaScriptObject, setLogicalStructure, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toStringMethods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEventsMethods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEventMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
-
Constructor Details
-
DateChooser
public DateChooser() -
DateChooser
-
-
Method Details
-
getOrCreateRef
-
changeAutoChildDefaults
Changes the defaults for Canvas AutoChildren namedautoChildName.- Parameters:
autoChildName- name of an AutoChild to customize the defaults for.defaults- Canvas defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, seeSGWTProperties.- See Also:
-
changeAutoChildDefaults
Changes the defaults for FormItem AutoChildren namedautoChildName.- Parameters:
autoChildName- name of an AutoChild to customize the defaults for.defaults- FormItem defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, seeSGWTProperties.- See Also:
-
create
-
setAlternateStyleSuffix
The text appended to the style name when usingalternateWeekStyles.- Parameters:
alternateStyleSuffix- New alternateStyleSuffix value. Default value is "Dark"- Returns:
DateChooserinstance, for chaining setter calls
-
getAlternateStyleSuffix
The text appended to the style name when usingalternateWeekStyles.- Returns:
- Current alternateStyleSuffix value. Default value is "Dark"
-
setAlternateWeekStyles
Whether alternating weeks should be drawn in alternating styles. If enabled, the cell style for alternate rows will havealternateStyleSuffixappended to it.- Parameters:
alternateWeekStyles- New alternateWeekStyles value. Default value is null- Returns:
DateChooserinstance, for chaining setter calls
-
getAlternateWeekStyles
Whether alternating weeks should be drawn in alternating styles. If enabled, the cell style for alternate rows will havealternateStyleSuffixappended to it.- Returns:
- Current alternateWeekStyles value. Default value is null
-
getApplyButton
When a DateChooser is configured fora "datetime" value, clicking on a date cell in thegridwill not automatically dismiss the DateChooser canvas. In this case, use theApplybutton to accept the selected date and time and dismiss the chooser.This component is an AutoChild named "applyButton". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current applyButton value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setApplyButtonTitle
Title for theApplybutton.- Parameters:
applyButtonTitle- New applyButtonTitle value. Default value is "Apply"- Returns:
DateChooserinstance, for chaining setter calls
-
getApplyButtonTitle
Title for theApplybutton.- Returns:
- Current applyButtonTitle value. Default value is "Apply"
-
setBaseBottomButtonStyle
CSS style to apply to the buttons at the bottom of the DateChooser ("Today" and "Cancel"). If null, the CSS style specified inbaseButtonStyleis used.- Parameters:
baseBottomButtonStyle- New baseBottomButtonStyle value. Default value is null- Returns:
DateChooserinstance, for chaining setter calls- See Also:
-
getBaseBottomButtonStyle
CSS style to apply to the buttons at the bottom of the DateChooser ("Today" and "Cancel"). If null, the CSS style specified inbaseButtonStyleis used.- Returns:
- Current baseBottomButtonStyle value. Default value is null
- See Also:
-
setBaseButtonStyle
Base CSS style applied to this picker's buttons. Will have "Over", "Selected" and "Down" suffix appended as the user interacts with buttons.See
CellStyleSuffixesfor details on how stateful suffixes are combined with the base style to generate stateful cell styles in Grids.- Parameters:
baseButtonStyle- New baseButtonStyle value. Default value is "dateChooserButton"- Returns:
DateChooserinstance, for chaining setter calls- See Also:
-
getBaseButtonStyle
Base CSS style applied to this picker's buttons. Will have "Over", "Selected" and "Down" suffix appended as the user interacts with buttons.See
CellStyleSuffixesfor details on how stateful suffixes are combined with the base style to generate stateful cell styles in Grids.- Returns:
- Current baseButtonStyle value. Default value is "dateChooserButton"
- See Also:
-
setBaseFiscalYearStyle
Base CSS style applied to cells in thefiscal year column.See
CellStyleSuffixesfor details on how stateful suffixes are combined with the base style to generate stateful cell styles in Grids.- Parameters:
baseFiscalYearStyle- New baseFiscalYearStyle value. Default value is "dateChooserFiscalYearCell"- Returns:
DateChooserinstance, for chaining setter calls- See Also:
-
getBaseFiscalYearStyle
Base CSS style applied to cells in thefiscal year column.See
CellStyleSuffixesfor details on how stateful suffixes are combined with the base style to generate stateful cell styles in Grids.- Returns:
- Current baseFiscalYearStyle value. Default value is "dateChooserFiscalYearCell"
- See Also:
-
setBaseWeekdayStyle
Base CSS style applied to weekdays. Will have "Over", "Selected" and "Down" suffix appended as the user interacts with buttons. Defaults tobaseButtonStyle.See
CellStyleSuffixesfor details on how stateful suffixes are combined with the base style to generate stateful cell styles in Grids.- Parameters:
baseWeekdayStyle- New baseWeekdayStyle value. Default value is "dateChooserWeekday"- Returns:
DateChooserinstance, for chaining setter calls- See Also:
-
getBaseWeekdayStyle
Base CSS style applied to weekdays. Will have "Over", "Selected" and "Down" suffix appended as the user interacts with buttons. Defaults tobaseButtonStyle.See
CellStyleSuffixesfor details on how stateful suffixes are combined with the base style to generate stateful cell styles in Grids.- Returns:
- Current baseWeekdayStyle value. Default value is "dateChooserWeekday"
- See Also:
-
setBaseWeekendStyle
Base CSS style applied to weekends. Will have "Over", "Selected" and "Down" suffix appended as the user interacts with buttons. Defaults tobaseWeekdayStyle.See
CellStyleSuffixesfor details on how stateful suffixes are combined with the base style to generate stateful cell styles in Grids.- Parameters:
baseWeekendStyle- New baseWeekendStyle value. Default value is "dateChooserWeekend"- Returns:
DateChooserinstance, for chaining setter calls- See Also:
-
getBaseWeekendStyle
Base CSS style applied to weekends. Will have "Over", "Selected" and "Down" suffix appended as the user interacts with buttons. Defaults tobaseWeekdayStyle.See
CellStyleSuffixesfor details on how stateful suffixes are combined with the base style to generate stateful cell styles in Grids.- Returns:
- Current baseWeekendStyle value. Default value is "dateChooserWeekend"
- See Also:
-
setBaseWeekStyle
Base CSS style applied to cells in thefiscal week column.- Parameters:
baseWeekStyle- New baseWeekStyle value. Default value is "dateChooserWeekCell"- Returns:
DateChooserinstance, for chaining setter calls- See Also:
-
getBaseWeekStyle
Base CSS style applied to cells in thefiscal week column.- Returns:
- Current baseWeekStyle value. Default value is "dateChooserWeekCell"
- See Also:
-
getButtonLayout
Ancom.smartgwt.client.types.AutoChildHLayout, rendered below thedate grid, and showing theToday,Canceland, when working with "datetime" values,Applybuttons.This component is an AutoChild named "buttonLayout". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current buttonLayout value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setButtonLayoutControls
public DateChooser setButtonLayoutControls(String... buttonLayoutControls) throws IllegalStateException Array of members to show in thebuttonLayout.The default value of
buttonLayoutControlsis an Array of Strings listing the standard buttons in their default order:buttonLayoutControls : ["todayButton", "cancelButton", "applyButton"]You can overridebuttonLayoutControlsto change the order of the standard buttons. You can also omit standard buttons this way, although it's more efficient to use the related "show" property if available (egshowTodayButton).By embedding a Canvas directly in this list you can add arbitrary additional controls to the buttonLayout.
Note that having added controls to buttonLayoutControls, you can still call APIs directly on those controls to change their appearance, and you can also show() and hide() them if they should not be shown in some circumstances.
Tip: custom controls need to set layoutAlign:"center" to appear vertically centered.
- Parameters:
buttonLayoutControls- New buttonLayoutControls value. Default value is (see below)- Returns:
DateChooserinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getButtonLayoutControls
Array of members to show in thebuttonLayout.The default value of
buttonLayoutControlsis an Array of Strings listing the standard buttons in their default order:buttonLayoutControls : ["todayButton", "cancelButton", "applyButton"]You can overridebuttonLayoutControlsto change the order of the standard buttons. You can also omit standard buttons this way, although it's more efficient to use the related "show" property if available (egshowTodayButton).By embedding a Canvas directly in this list you can add arbitrary additional controls to the buttonLayout.
Note that having added controls to buttonLayoutControls, you can still call APIs directly on those controls to change their appearance, and you can also show() and hide() them if they should not be shown in some circumstances.
Tip: custom controls need to set layoutAlign:"center" to appear vertically centered.
- Returns:
- Current buttonLayoutControls value. Default value is (see below)
-
getCancelButton
A button shown below thecalendar gridwhich, when clicked, closes the DateChooser without selecting a value.This component is an AutoChild named "cancelButton". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current cancelButton value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setCancelButtonTitle
Title for the cancellation button.- Parameters:
cancelButtonTitle- New cancelButtonTitle value. Default value is "Cancel"- Returns:
DateChooserinstance, for chaining setter calls
-
getCancelButtonTitle
Title for the cancellation button.- Returns:
- Current cancelButtonTitle value. Default value is "Cancel"
-
setCloseOnDateClick
When editing a "date" value, with no time portion, clicking on a date-cell selects the date and closes the DateChooser. When atime portionis required, however, theapply buttonmust be clicked to close the chooser, by default.Set this attribute to true to have the DateChooser close when a user clicks in a date-cell, even if the
timeItemis showing.- Parameters:
closeOnDateClick- New closeOnDateClick value. Default value is null- Returns:
DateChooserinstance, for chaining setter calls
-
getCloseOnDateClick
When editing a "date" value, with no time portion, clicking on a date-cell selects the date and closes the DateChooser. When atime portionis required, however, theapply buttonmust be clicked to close the chooser, by default.Set this attribute to true to have the DateChooser close when a user clicks in a date-cell, even if the
timeItemis showing.- Returns:
- Current closeOnDateClick value. Default value is null
-
setCloseOnEscapeKeypress
public DateChooser setCloseOnEscapeKeypress(boolean closeOnEscapeKeypress) throws IllegalStateException Should this dateChooser be dismissed if the user presses the Escape key?- Parameters:
closeOnEscapeKeypress- New closeOnEscapeKeypress value. Default value is false- Returns:
DateChooserinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getCloseOnEscapeKeypress
public boolean getCloseOnEscapeKeypress()Should this dateChooser be dismissed if the user presses the Escape key?- Returns:
- Current closeOnEscapeKeypress value. Default value is false
-
getDateGrid
AListGridsubclass, responsible for rendering the calendar view.This component is an AutoChild named "dateGrid". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current dateGrid value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setDayNameLength
How long (how many characters) should be day names be. May be 1, 2 or 3 characters.- Parameters:
dayNameLength- New dayNameLength value. Default value is 2- Returns:
DateChooserinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getDayNameLength
public int getDayNameLength()How long (how many characters) should be day names be. May be 1, 2 or 3 characters.- Returns:
- Current dayNameLength value. Default value is 2
-
setDisabledDates
An array of Date instances that should be disabled if they appear in the calendar view.- Parameters:
disabledDates- New disabledDates value. Default value is null- Returns:
DateChooserinstance, for chaining setter calls
-
getDisabledDates
An array of Date instances that should be disabled if they appear in the calendar view.- Returns:
- Current disabledDates value. Default value is null
-
setDisabledWeekdayStyle
Base CSS style applied to weekday dates which have beendisabled.- Parameters:
disabledWeekdayStyle- New disabledWeekdayStyle value. Default value is "dateChooserDisabledWeekday"- Returns:
DateChooserinstance, for chaining setter calls- See Also:
-
getDisabledWeekdayStyle
Base CSS style applied to weekday dates which have beendisabled.- Returns:
- Current disabledWeekdayStyle value. Default value is "dateChooserDisabledWeekday"
- See Also:
-
setDisabledWeekendStyle
Base CSS style applied to weekend dates which have beendisabled.- Parameters:
disabledWeekendStyle- New disabledWeekendStyle value. Default value is "dateChooserDisabledWeekend"- Returns:
DateChooserinstance, for chaining setter calls- See Also:
-
getDisabledWeekendStyle
Base CSS style applied to weekend dates which have beendisabled.- Returns:
- Current disabledWeekendStyle value. Default value is "dateChooserDisabledWeekend"
- See Also:
-
setDisableWeekends
Whether it should be valid to pick a weekend day. If set to true, weekend days appear in disabled style and cannot be picked.Which days are considered weekends is controlled by
weekendDaysif set or byweekendDaysotherwise.- Parameters:
disableWeekends- New disableWeekends value. Default value is false- Returns:
DateChooserinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getDisableWeekends
Whether it should be valid to pick a weekend day. If set to true, weekend days appear in disabled style and cannot be picked.Which days are considered weekends is controlled by
weekendDaysif set or byweekendDaysotherwise.- Returns:
- Current disableWeekends value. Default value is false
-
setEndDate
Limits the selectable range of this DateChooser.If unset, the chooser's range-end is dictated by
endYear.- Parameters:
endDate- New endDate value. Default value is null- Returns:
DateChooserinstance, for chaining setter calls- See Also:
-
getEndDate
Limits the selectable range of this DateChooser.If unset, the chooser's range-end is dictated by
endYear.- Returns:
- Current endDate value. Default value is null
- See Also:
-
setEndYear
Latest year that may be selected.If set to null, no minimum year is enforced.
If this chooser was opened by a
DateItem, the default is inherited fromDateItem.endDate. Otherwise, the default is 5 years after today.When opened from a
RelativeDateItem, this property andstartYearare defaulted to null, and the year-picker shows years surrounding the current year, according tostartYearRangeandendYearRange.- Parameters:
endYear- New endYear value. Default value is 2025- Returns:
DateChooserinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getEndYear
public int getEndYear()Latest year that may be selected.If set to null, no minimum year is enforced.
If this chooser was opened by a
DateItem, the default is inherited fromDateItem.endDate. Otherwise, the default is 5 years after today.When opened from a
RelativeDateItem, this property andstartYearare defaulted to null, and the year-picker shows years surrounding the current year, according tostartYearRangeandendYearRange.- Returns:
- Current endYear value. Default value is 2025
-
setEndYearRange
WhenendYearis unset, this is the years after today that will be available for selection in the year menu.- Parameters:
endYearRange- New endYearRange value. Default value is 10- Returns:
DateChooserinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getEndYearRange
WhenendYearis unset, this is the years after today that will be available for selection in the year menu.- Returns:
- Current endYearRange value. Default value is 10
-
setFirstDayOfWeek
Day of the week to show in the first column. 0=Sunday, 1=Monday, ..., 6=Saturday. The default value for this attribute is picked up from the current locale and can also be altered system-wide with theglobal setter.- Parameters:
firstDayOfWeek- New firstDayOfWeek value. Default value is 0- Returns:
DateChooserinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getFirstDayOfWeek
public int getFirstDayOfWeek()Day of the week to show in the first column. 0=Sunday, 1=Monday, ..., 6=Saturday. The default value for this attribute is picked up from the current locale and can also be altered system-wide with theglobal setter.- Returns:
- Current firstDayOfWeek value. Default value is 0
- See Also:
-
getFiscalYearChooserButton
A button shown in thenavigation layoutwhich, when clicked, shows a picker for selecting a specific fiscal year.This component is an AutoChild named "fiscalYearChooserButton". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current fiscalYearChooserButton value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setFiscalYearFieldTitle
Title for thefiscal yearfield in the date grid.- Parameters:
fiscalYearFieldTitle- New fiscalYearFieldTitle value. Default value is "Year"- Returns:
DateChooserinstance, for chaining setter calls
-
getFiscalYearFieldTitle
Title for thefiscal yearfield in the date grid.- Returns:
- Current fiscalYearFieldTitle value. Default value is "Year"
-
setFiscalYearHeaderStyle
Base CSS style applied to the header of thefiscal year columnin thecalendar view.- Parameters:
fiscalYearHeaderStyle- New fiscalYearHeaderStyle value. Default value is null- Returns:
DateChooserinstance, for chaining setter calls- See Also:
-
getFiscalYearHeaderStyle
Base CSS style applied to the header of thefiscal year columnin thecalendar view.- Returns:
- Current fiscalYearHeaderStyle value. Default value is null
- See Also:
-
setHeaderHeight
Deprecated.in favor ofnavigationLayoutHeightHeight of the header area (containing the navigation buttons) in pixels.- Parameters:
headerHeight- New headerHeight value. Default value is 20- Returns:
DateChooserinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getHeaderHeight
Deprecated.in favor ofnavigationLayoutHeightHeight of the header area (containing the navigation buttons) in pixels.- Returns:
- Current headerHeight value. Default value is 20
-
setHeaderStyle
CSS style applied to the day-of-week headers. By default this applies to all days of the week. To apply a separate style to weekend headers, setweekendHeaderStyle- Parameters:
headerStyle- New headerStyle value. Default value is "dateChooserButtonDisabled"- Returns:
DateChooserinstance, for chaining setter calls- See Also:
-
getHeaderStyle
CSS style applied to the day-of-week headers. By default this applies to all days of the week. To apply a separate style to weekend headers, setweekendHeaderStyle- Returns:
- Current headerStyle value. Default value is "dateChooserButtonDisabled"
- See Also:
-
setMenuItemStyle
Base CSS style applied to cells in the Year, Week and Month popup-menus. In some skins, this attribute is set to dateChooserMenuItem which provides custom styles for items in these menus.- Parameters:
menuItemStyle- New menuItemStyle value. Default value is "dateChooserButton"- Returns:
DateChooserinstance, for chaining setter calls- See Also:
-
getMenuItemStyle
Base CSS style applied to cells in the Year, Week and Month popup-menus. In some skins, this attribute is set to dateChooserMenuItem which provides custom styles for items in these menus.- Returns:
- Current menuItemStyle value. Default value is "dateChooserButton"
- See Also:
-
getMonthChooserButton
A button shown in thenavigation layoutthat shows a picker for selecting a specific month.This component is an AutoChild named "monthChooserButton". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current monthChooserButton value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setMonthMenuStyle
Style for the pop-up year menu.- Parameters:
monthMenuStyle- New monthMenuStyle value. Default value is "dateChooserMonthMenu"- Returns:
DateChooserinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getMonthMenuStyle
Style for the pop-up year menu.- Returns:
- Current monthMenuStyle value. Default value is "dateChooserMonthMenu"
- See Also:
-
getNextMonthButton
A button shown in thenavigation layoutthat shifts the calendar view forward by a month.This component is an AutoChild named "nextMonthButton". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current nextMonthButton value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setNextMonthButtonAriaLabel
public DateChooser setNextMonthButtonAriaLabel(String nextMonthButtonAriaLabel) throws IllegalStateException Aria labelfor thenextMonthButton.- Parameters:
nextMonthButtonAriaLabel- New nextMonthButtonAriaLabel value. Default value is "Next month"- Returns:
DateChooserinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getNextMonthButtonAriaLabel
Aria labelfor thenextMonthButton.- Returns:
- Current nextMonthButtonAriaLabel value. Default value is "Next month"
-
setNextMonthIcon
Icon for the next month button- Parameters:
nextMonthIcon- New nextMonthIcon value. Default value is "[SKIN]arrow_right.gif"- Returns:
DateChooserinstance, for chaining setter calls- See Also:
-
getNextMonthIcon
Icon for the next month button- Returns:
- Current nextMonthIcon value. Default value is "[SKIN]arrow_right.gif"
- See Also:
-
setNextMonthIconHeight
Height of the icon for the next month button- Parameters:
nextMonthIconHeight- New nextMonthIconHeight value. Default value is 7- Returns:
DateChooserinstance, for chaining setter calls
-
getNextMonthIconHeight
public int getNextMonthIconHeight()Height of the icon for the next month button- Returns:
- Current nextMonthIconHeight value. Default value is 7
-
setNextMonthIconRTL
Icon for the next month button- Parameters:
nextMonthIconRTL- New nextMonthIconRTL value. Default value is null- Returns:
DateChooserinstance, for chaining setter calls- See Also:
-
getNextMonthIconRTL
Icon for the next month button- Returns:
- Current nextMonthIconRTL value. Default value is null
- See Also:
-
setNextMonthIconWidth
Width of the icon for the next month button ifPage.isRTL()is true. If not set, and the page is in RTL mode, thenextMonthIconwill be used in place of theprevMonthIconand vice versa.- Parameters:
nextMonthIconWidth- New nextMonthIconWidth value. Default value is 7- Returns:
DateChooserinstance, for chaining setter calls
-
getNextMonthIconWidth
public int getNextMonthIconWidth()Width of the icon for the next month button ifPage.isRTL()is true. If not set, and the page is in RTL mode, thenextMonthIconwill be used in place of theprevMonthIconand vice versa.- Returns:
- Current nextMonthIconWidth value. Default value is 7
-
getNextYearButton
A button shown in thenavigation layoutthat shifts the calendar view forward by a year.This component is an AutoChild named "nextYearButton". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current nextYearButton value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setNextYearButtonAriaLabel
public DateChooser setNextYearButtonAriaLabel(String nextYearButtonAriaLabel) throws IllegalStateException Aria labelfor thenextYearButton.- Parameters:
nextYearButtonAriaLabel- New nextYearButtonAriaLabel value. Default value is "Next year"- Returns:
DateChooserinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getNextYearButtonAriaLabel
Aria labelfor thenextYearButton.- Returns:
- Current nextYearButtonAriaLabel value. Default value is "Next year"
-
setNextYearIcon
Icon for the next year button- Parameters:
nextYearIcon- New nextYearIcon value. Default value is "[SKIN]doubleArrow_right.gif"- Returns:
DateChooserinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
com.smartgwt.client.widgets.DateChooser#setShowDoubleYearIconURL
-
getNextYearIcon
Icon for the next year button- Returns:
- Current nextYearIcon value. Default value is "[SKIN]doubleArrow_right.gif"
- See Also:
-
com.smartgwt.client.widgets.DateChooser#getShowDoubleYearIconURL
-
setNextYearIconHeight
Height of the icon for the next year button- Parameters:
nextYearIconHeight- New nextYearIconHeight value. Default value is 7- Returns:
DateChooserinstance, for chaining setter calls
-
getNextYearIconHeight
public int getNextYearIconHeight()Height of the icon for the next year button- Returns:
- Current nextYearIconHeight value. Default value is 7
-
setNextYearIconRTL
Icon for the next year button ifPage.isRTL()is true. If not set, and the page is in RTL mode, thenextYearIconwill be used in place of theprevYearIconand vice versa.- Parameters:
nextYearIconRTL- New nextYearIconRTL value. Default value is null- Returns:
DateChooserinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
com.smartgwt.client.widgets.DateChooser#setShowDoubleYearIconURL
-
getNextYearIconRTL
Icon for the next year button ifPage.isRTL()is true. If not set, and the page is in RTL mode, thenextYearIconwill be used in place of theprevYearIconand vice versa.- Returns:
- Current nextYearIconRTL value. Default value is null
- See Also:
-
com.smartgwt.client.widgets.DateChooser#getShowDoubleYearIconURL
-
setNextYearIconWidth
Width of the icon for the next year button- Parameters:
nextYearIconWidth- New nextYearIconWidth value. Default value is 14- Returns:
DateChooserinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getNextYearIconWidth
public int getNextYearIconWidth()Width of the icon for the next year button- Returns:
- Current nextYearIconWidth value. Default value is 14
-
getPreviousMonthButton
A button shown in thenavigation layoutthat shifts the calendar view backward by a month.This component is an AutoChild named "previousMonthButton". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current previousMonthButton value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setPreviousMonthButtonAriaLabel
public DateChooser setPreviousMonthButtonAriaLabel(String previousMonthButtonAriaLabel) throws IllegalStateException Aria labelfor thepreviousMonthButton.- Parameters:
previousMonthButtonAriaLabel- New previousMonthButtonAriaLabel value. Default value is "Previous month"- Returns:
DateChooserinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getPreviousMonthButtonAriaLabel
Aria labelfor thepreviousMonthButton.- Returns:
- Current previousMonthButtonAriaLabel value. Default value is "Previous month"
-
getPreviousYearButton
A button shown in thenavigation layoutthat shifts the calendar view backward by a year.This component is an AutoChild named "previousYearButton". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current previousYearButton value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setPreviousYearButtonAriaLabel
public DateChooser setPreviousYearButtonAriaLabel(String previousYearButtonAriaLabel) throws IllegalStateException Aria labelfor thepreviousYearButton.- Parameters:
previousYearButtonAriaLabel- New previousYearButtonAriaLabel value. Default value is "Previous year"- Returns:
DateChooserinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getPreviousYearButtonAriaLabel
Aria labelfor thepreviousYearButton.- Returns:
- Current previousYearButtonAriaLabel value. Default value is "Previous year"
-
setPrevMonthIcon
Icon for the previous month button- Parameters:
prevMonthIcon- New prevMonthIcon value. Default value is "[SKIN]arrow_left.gif"- Returns:
DateChooserinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getPrevMonthIcon
Icon for the previous month button- Returns:
- Current prevMonthIcon value. Default value is "[SKIN]arrow_left.gif"
- See Also:
-
setPrevMonthIconHeight
Height of the icon for the previous month button- Parameters:
prevMonthIconHeight- New prevMonthIconHeight value. Default value is 7- Returns:
DateChooserinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getPrevMonthIconHeight
public int getPrevMonthIconHeight()Height of the icon for the previous month button- Returns:
- Current prevMonthIconHeight value. Default value is 7
-
setPrevMonthIconRTL
Icon for the previous month button ifPage.isRTL()is true. If not set, and the page is in RTL mode, thenextMonthIconwill be used in place of theprevMonthIconand vice versa.- Parameters:
prevMonthIconRTL- New prevMonthIconRTL value. Default value is null- Returns:
DateChooserinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getPrevMonthIconRTL
Icon for the previous month button ifPage.isRTL()is true. If not set, and the page is in RTL mode, thenextMonthIconwill be used in place of theprevMonthIconand vice versa.- Returns:
- Current prevMonthIconRTL value. Default value is null
- See Also:
-
setPrevMonthIconWidth
Width of the icon for the previous month button- Parameters:
prevMonthIconWidth- New prevMonthIconWidth value. Default value is 7- Returns:
DateChooserinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getPrevMonthIconWidth
public int getPrevMonthIconWidth()Width of the icon for the previous month button- Returns:
- Current prevMonthIconWidth value. Default value is 7
-
setPrevYearIcon
Icon for the previous year button- Parameters:
prevYearIcon- New prevYearIcon value. Default value is "[SKIN]doubleArrow_left.gif"- Returns:
DateChooserinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
com.smartgwt.client.widgets.DateChooser#setShowDoubleYearIconURL
-
getPrevYearIcon
Icon for the previous year button- Returns:
- Current prevYearIcon value. Default value is "[SKIN]doubleArrow_left.gif"
- See Also:
-
com.smartgwt.client.widgets.DateChooser#getShowDoubleYearIconURL
-
setPrevYearIconHeight
Height of the icon for the previous year button- Parameters:
prevYearIconHeight- New prevYearIconHeight value. Default value is 7- Returns:
DateChooserinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getPrevYearIconHeight
public int getPrevYearIconHeight()Height of the icon for the previous year button- Returns:
- Current prevYearIconHeight value. Default value is 7
-
setPrevYearIconRTL
Icon for the previous year button ifPage.isRTL()is true. If not set, and the page is in RTL mode, thenextYearIconwill be used in place of theprevYearIconand vice versa.- Parameters:
prevYearIconRTL- New prevYearIconRTL value. Default value is null- Returns:
DateChooserinstance, for chaining setter calls- See Also:
-
com.smartgwt.client.widgets.DateChooser#setShowDoubleYearIconURL
-
getPrevYearIconRTL
Icon for the previous year button ifPage.isRTL()is true. If not set, and the page is in RTL mode, thenextYearIconwill be used in place of theprevYearIconand vice versa.- Returns:
- Current prevYearIconRTL value. Default value is null
- See Also:
-
com.smartgwt.client.widgets.DateChooser#getShowDoubleYearIconURL
-
setPrevYearIconWidth
Width of the icon for the previous year button- Parameters:
prevYearIconWidth- New prevYearIconWidth value. Default value is 14- Returns:
DateChooserinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getPrevYearIconWidth
public int getPrevYearIconWidth()Width of the icon for the previous year button- Returns:
- Current prevYearIconWidth value. Default value is 14
-
setSelectedWeekStyle
CSS style applied to the Fiscal Year and Week columns for the currently selected week (the one being displayed in theweek chooser).- Parameters:
selectedWeekStyle- New selectedWeekStyle value. Default value is "dateChooserSelectedWeek"- Returns:
DateChooserinstance, for chaining setter calls- See Also:
-
getSelectedWeekStyle
CSS style applied to the Fiscal Year and Week columns for the currently selected week (the one being displayed in theweek chooser).- Returns:
- Current selectedWeekStyle value. Default value is "dateChooserSelectedWeek"
- See Also:
-
setShowApplyButton
Determines whether theapplyButtonwill be displayed.- Parameters:
showApplyButton- New showApplyButton value. Default value is null- Returns:
DateChooserinstance, for chaining setter calls
-
getShowApplyButton
Determines whether theapplyButtonwill be displayed.- Returns:
- Current showApplyButton value. Default value is null
-
setShowCancelButton
Determines whether the "Cancel" button will be displayed.- Parameters:
showCancelButton- New showCancelButton value. Default value is false- Returns:
DateChooserinstance, for chaining setter calls
-
getShowCancelButton
Determines whether the "Cancel" button will be displayed.- Returns:
- Current showCancelButton value. Default value is false
-
setShowFiscalYearChooser
When set to true, show a button that allows the calendar to be navigated by fiscal year.- Parameters:
showFiscalYearChooser- New showFiscalYearChooser value. Default value is false- Returns:
DateChooserinstance, for chaining setter calls
-
getShowFiscalYearChooser
When set to true, show a button that allows the calendar to be navigated by fiscal year.- Returns:
- Current showFiscalYearChooser value. Default value is false
-
setShowSecondItem
When showing thetime field, whether to show the "second" picker. When unset, the second field is not shown.- Parameters:
showSecondItem- New showSecondItem value. Default value is null- Returns:
DateChooserinstance, for chaining setter calls
-
getShowSecondItem
When showing thetime field, whether to show the "second" picker. When unset, the second field is not shown.- Returns:
- Current showSecondItem value. Default value is null
-
setShowTimeItem
Whether to show thetime fieldfor editing the time portion of the date. When unset, the time field is shown automatically if the field type is "datetime". Note that the item'ssecond chooseris not shown by default.- Parameters:
showTimeItem- New showTimeItem value. Default value is null- Returns:
DateChooserinstance, for chaining setter calls
-
getShowTimeItem
Whether to show thetime fieldfor editing the time portion of the date. When unset, the time field is shown automatically if the field type is "datetime". Note that the item'ssecond chooseris not shown by default.- Returns:
- Current showTimeItem value. Default value is null
-
setShowTodayButton
Determines whether the "Today" button will be displayed, allowing the user to select the current date.- Parameters:
showTodayButton- New showTodayButton value. Default value is true- Returns:
DateChooserinstance, for chaining setter calls
-
getShowTodayButton
Determines whether the "Today" button will be displayed, allowing the user to select the current date.- Returns:
- Current showTodayButton value. Default value is true
-
setShowWeekChooser
When set to true, show a button that allows the calendar to be navigated by week or fiscal week, depending on the value ofshowFiscalYearChooser.- Parameters:
showWeekChooser- New showWeekChooser value. Default value is false- Returns:
DateChooserinstance, for chaining setter calls
-
getShowWeekChooser
When set to true, show a button that allows the calendar to be navigated by week or fiscal week, depending on the value ofshowFiscalYearChooser.- Returns:
- Current showWeekChooser value. Default value is false
-
setShowWeekends
Whether weekend days should be shown. Which days are considered weekends is controlled byweekendDaysif set or byweekendDaysotherwise.- Parameters:
showWeekends- New showWeekends value. Default value is true- Returns:
DateChooserinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getShowWeekends
Whether weekend days should be shown. Which days are considered weekends is controlled byweekendDaysif set or byweekendDaysotherwise.- Returns:
- Current showWeekends value. Default value is true
-
setSkinImgDir
Overridden directory where images for this widget (such as the month and year button icons) may be found.Note : This is an advanced setting
- Overrides:
setSkinImgDirin classCanvas- Parameters:
skinImgDir- New skinImgDir value. Default value is "images/common/"- Returns:
DateChooserinstance, for chaining setter calls- See Also:
-
getSkinImgDir
Overridden directory where images for this widget (such as the month and year button icons) may be found.- Overrides:
getSkinImgDirin classCanvas- Returns:
- Current skinImgDir value. Default value is "images/common/"
- See Also:
-
setStartDate
Limits the selectable range of this DateChooser.If unset, the chooser's range-start is dictated by
startYear.- Parameters:
startDate- New startDate value. Default value is null- Returns:
DateChooserinstance, for chaining setter calls- See Also:
-
getStartDate
Limits the selectable range of this DateChooser.If unset, the chooser's range-start is dictated by
startYear.- Returns:
- Current startDate value. Default value is null
- See Also:
-
setStartYear
Earliest year that may be selected.If set to null, no minimum year is enforced.
If this chooser was opened by a
DateItem, the default is inherited fromDateItem.startDate. Otherwise, the default is 10 years before today.When opened from a
RelativeDateItem, this property andendYearare defaulted to null, and the year-picker shows years surrounding the current year, according tostartYearRangeandendYearRange.- Parameters:
startYear- New startYear value. Default value is 2010- Returns:
DateChooserinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getStartYear
public int getStartYear()Earliest year that may be selected.If set to null, no minimum year is enforced.
If this chooser was opened by a
DateItem, the default is inherited fromDateItem.startDate. Otherwise, the default is 10 years before today.When opened from a
RelativeDateItem, this property andendYearare defaulted to null, and the year-picker shows years surrounding the current year, according tostartYearRangeandendYearRange.- Returns:
- Current startYear value. Default value is 2010
-
setStartYearRange
WhenstartYearis unset, this is the years before today that will be available for selection in the year menu.- Parameters:
startYearRange- New startYearRange value. Default value is 30- Returns:
DateChooserinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getStartYearRange
WhenstartYearis unset, this is the years before today that will be available for selection in the year menu.- Returns:
- Current startYearRange value. Default value is 30
-
setStyleWeekends
Whether weekend days should be styled differently from weekdays. If false, suppresses the custombaseWeekendStyleandweekendHeaderStyle, instead using thebaseWeekdayStyleandweekendHeaderStyle.- Parameters:
styleWeekends- New styleWeekends value. Default value is true- Returns:
DateChooserinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getStyleWeekends
Whether weekend days should be styled differently from weekdays. If false, suppresses the custombaseWeekendStyleandweekendHeaderStyle, instead using thebaseWeekdayStyleandweekendHeaderStyle.- Returns:
- Current styleWeekends value. Default value is true
-
getTimeItem
TimeItemfor editing the time portion of dates. Visible by default for fields of type "datetime" and can be controlled by settingshowTimeItem.This component is an AutoChild named "timeItem". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current timeItem value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setTimeItemProperties
Custom properties to apply to thetime fieldused for editing the time portion of the date.Note : This is an advanced setting
- Parameters:
timeItemProperties- New timeItemProperties value. Default value is null- Returns:
DateChooserinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getTimeItemProperties
Custom properties to apply to thetime fieldused for editing the time portion of the date.- Returns:
- Current timeItemProperties value. Default value is null
-
setTimeItemTitle
Title for thetime field.- Parameters:
timeItemTitle- New timeItemTitle value. Default value is "Time"- Returns:
DateChooserinstance, for chaining setter calls
-
getTimeItemTitle
Title for thetime field.- Returns:
- Current timeItemTitle value. Default value is "Time"
-
getTodayButton
A button shown below thecalendar gridwhich, when clicked, navigates the calendar to today.This component is an AutoChild named "todayButton". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current todayButton value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setTodayButtonHeight
If set specifies a fixed height for the Today and Cancel buttons.- Parameters:
todayButtonHeight- New todayButtonHeight value. Default value is null- Returns:
DateChooserinstance, for chaining setter calls
-
getTodayButtonHeight
If set specifies a fixed height for the Today and Cancel buttons.- Returns:
- Current todayButtonHeight value. Default value is null
-
setTodayButtonTitle
Title for "Today" button.- Parameters:
todayButtonTitle- New todayButtonTitle value. Default value is "Today"- Returns:
DateChooserinstance, for chaining setter calls
-
getTodayButtonTitle
Title for "Today" button.- Returns:
- Current todayButtonTitle value. Default value is "Today"
-
setUse24HourTime
When showing thetime field, whether theTimeItemshould be set to use 24-hour time. The default is true.- Parameters:
use24HourTime- New use24HourTime value. Default value is true- Returns:
DateChooserinstance, for chaining setter calls
-
getUse24HourTime
When showing thetime field, whether theTimeItemshould be set to use 24-hour time. The default is true.- Returns:
- Current use24HourTime value. Default value is true
-
setUseFirstDayOfFiscalWeek
When showing thefiscal year chooser, should firstDayOfWeek be defaulted to the same day as the fiscal start date? If true and a fiscal year starts on a Tuesday, the calendar will display Tuesday to Monday from left to right.- Parameters:
useFirstDayOfFiscalWeek- New useFirstDayOfFiscalWeek value. Default value is true- Returns:
DateChooserinstance, for chaining setter calls
-
getUseFirstDayOfFiscalWeek
When showing thefiscal year chooser, should firstDayOfWeek be defaulted to the same day as the fiscal start date? If true and a fiscal year starts on a Tuesday, the calendar will display Tuesday to Monday from left to right.- Returns:
- Current useFirstDayOfFiscalWeek value. Default value is true
-
getWeekChooserButton
A button shown in thenavigation layoutwhich shows a picker for selecting a specific week of the year. WhenshowFiscalYearChooseris true, the week number represents a fiscal week number, one offset from the start of the fiscal year. Otherwise, it represents a week number offset from the start of the calendar year.This component is an AutoChild named "weekChooserButton". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current weekChooserButton value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setWeekendDays
An array of integer day-numbers that should be considered to be weekend days by this DateChooser instance. If unset, defaults to the set of days indicatedglobally.- Parameters:
weekendDays- New weekendDays value. Default value is null- Returns:
DateChooserinstance, for chaining setter calls- See Also:
-
getWeekendDays
public int[] getWeekendDays()An array of integer day-numbers that should be considered to be weekend days by this DateChooser instance. If unset, defaults to the set of days indicatedglobally.- Returns:
- Current weekendDays value. Default value is null
- See Also:
-
setWeekendHeaderStyle
Optional CSS style applied to the day-of-week headers for weekend days. If unsetheaderStylewill be applied to both weekdays and weekend days.- Parameters:
weekendHeaderStyle- New weekendHeaderStyle value. Default value is null- Returns:
DateChooserinstance, for chaining setter calls
-
getWeekendHeaderStyle
Optional CSS style applied to the day-of-week headers for weekend days. If unsetheaderStylewill be applied to both weekdays and weekend days.- Returns:
- Current weekendHeaderStyle value. Default value is null
-
setWeekFieldTitle
Title for theweekfield in the date grid.- Parameters:
weekFieldTitle- New weekFieldTitle value. Default value is "Wk"- Returns:
DateChooserinstance, for chaining setter calls
-
getWeekFieldTitle
Title for theweekfield in the date grid.- Returns:
- Current weekFieldTitle value. Default value is "Wk"
-
setWeekHeaderStyle
Base CSS style applied to the header of thefiscal or calendar week columnin thecalendar view.- Parameters:
weekHeaderStyle- New weekHeaderStyle value. Default value is null- Returns:
DateChooserinstance, for chaining setter calls- See Also:
-
getWeekHeaderStyle
Base CSS style applied to the header of thefiscal or calendar week columnin thecalendar view.- Returns:
- Current weekHeaderStyle value. Default value is null
- See Also:
-
setWeekMenuStyle
Style for the pop-up week menu.- Parameters:
weekMenuStyle- New weekMenuStyle value. Default value is "dateChooserWeekMenu"- Returns:
DateChooserinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getWeekMenuStyle
Style for the pop-up week menu.- Returns:
- Current weekMenuStyle value. Default value is "dateChooserWeekMenu"
- See Also:
-
getYearChooserButton
A button shown in thenavigation layoutthat shows a picker for selecting a specific calendar year.This component is an AutoChild named "yearChooserButton". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current yearChooserButton value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setYearMenuStyle
Style for the pop-up year menu.- Parameters:
yearMenuStyle- New yearMenuStyle value. Default value is "dateChooserYearMenu"- Returns:
DateChooserinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getYearMenuStyle
Style for the pop-up year menu.- Returns:
- Current yearMenuStyle value. Default value is "dateChooserYearMenu"
- See Also:
-
cancelClick
public void cancelClick()Fired when the user clicks the cancel button in this date chooser. Default implementation clears the date chooser. -
addDataChangedHandler
Add a dataChanged handler.Add a notification to be fired whenever the data changes.
Has no default behavior (so no need to call Super).
Use
DateChooser.getData()to get the current date value.- Specified by:
addDataChangedHandlerin interfaceHasDataChangedHandlers- Parameters:
handler- the dataChanged handler- Returns:
HandlerRegistrationused to remove this handler
-
getData
Get the current value of the picker.See
DateChooser.dataChanged()for how to respond to the user picking a date.- Returns:
- current date
-
getFiscalCalendar
Returns theFiscalCalendarobject that will be used by this DateChooser.- Returns:
- the fiscal calendar for this chooser, if set, or the global one otherwise
-
setData
Set the picker to show the given date.- Parameters:
date- new value
-
setFiscalCalendar
public void setFiscalCalendar()Sets theFiscalCalendarobject that will be used by this DateChooser. If unset, theglobal fiscal calendaris used. -
setFiscalCalendar
Sets theFiscalCalendarobject that will be used by this DateChooser. If unset, theglobal fiscal calendaris used.- Parameters:
fiscalCalendar- the fiscal calendar for this chooser
-
todayClick
public void todayClick()Fired when the user clicks the Today button. Default implementation will select the current date in the date chooser. -
setDefaultProperties
Class level method to set the default properties of this class. If set, then all existing and subsequently created instances of this class will automatically have default properties corresponding to the properties set on the SmartGWT class instance passed to this function before its underlying SmartClient JS object was created. This is a powerful feature that eliminates the need for users to create a separate hierarchy of subclasses that only alter the default properties of this class. Can also be used for skinning / styling purposes.Note: This method is intended for setting default attributes only and will affect all instances of the underlying class (including those automatically generated in JavaScript). This method should not be used to apply standard EventHandlers or override methods for a class - use a custom subclass instead. Calling this method after instances have been created can result in undefined behavior, since it bypasses any setters and a class instance may have already examined a particular property and not be expecting any changes through this route.
- Parameters:
dateChooserProperties- properties that should be used as new defaults when instances of this class are created- See Also:
-
setYearTitleFormatter
-
setLogicalStructure
Setter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility. -
getLogicalStructure
Getter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.- Specified by:
getLogicalStructurein interfaceLogicalStructure- Overrides:
getLogicalStructurein classVLayout
-
navigationLayoutHeight