com.goldencode.p2j.ui

Interface Calendar

All Superinterfaces:

ComData, CommonField, CommonHandle, CommonHandleChain, CommonWidget, Coordinates, CustomFont, DatabaseInfo, DisableRedraw, Enabled, HasVisible, ImageSupport, ImageWidgetSupport, Nameable, OcxDragDrop, OcxMouse, Sizeable, WidgetExtension, WrappedResource, WriteProtectable

All Known Subinterfaces:

HandleCommon

All Known Implementing Classes:

CalendarWidget

public interface Calendar
extends WrappedResource, ComData, OcxMouse, OcxDragDrop, CommonWidget, CustomFont, Enabled, WidgetExtension

Defines exported methods and constants for the calendar widget.

Method Summary

Modifier and Type	Method and Description
integer	getCalendarBackColor() Returns the background color used to display the month portion of the dropdown calendar.
integer	getCalendarForeColor() Returns the foreground color used to display text in the month portion of the dropdown calendar.
integer	getCalendarTitleBackColor() Returns the background color used to display the title portion of the dropdown calendar.
integer	getCalendarTitleForeColor() Returns the foreground color used to display the title portion of the dropdown calendar.
integer	getCalendarTrailingForeColor() Returns the foreground color used to display the days at the beginning and end of the dropdown calendar that are from previous and following months.
character	getCalendarValue() Returns the current date time value as a character value.
character	getCustomFormat() Returns the custom format string used to format the date and/or time displayed in the control.
integer	getDay() Returns the day number [1-31] for the current date.
integer	getDayOfWeek() Returns the day of the week [0-6] for the current date.
integer	getFormatStyle() Determines whether dates and times are displayed using standard or custom formatting.
integer	getHour() Returns the hour number [0-23] for the current time.
date	getMaxDate() Returns the latest date that can be displayed or accepted by the control.
date	getMinDate() Returns the earliest date that can be displayed or accepted by the control.
integer	getMinute() Returns the minute number [0-59] for the current time.
integer	getMonth() Returns the month number [1-12] for the current date.
integer	getSecond() Returns the second number [0-59] for the current time.
integer	getYear() Returns the year for the current date.
logical	isCheckBox() Returns whether the control displays a checkbox to the left of the date.
logical	isUpDown() Returns a value that determines whether an updown (spin) button is used to modify dates instead of a dropdown calendar.
void	setCalendarBackColor(integer calendarBackColor) Sets the background color used to display the month portion of the dropdown calendar.
void	setCalendarForeColor(integer calendarForeColor) Sets the foreground color used to display text in the month portion of the dropdown calendar.
void	setCalendarTitleBackColor(integer titleBackColor) Sets the background color used to display the title portion of the dropdown calendar.
void	setCalendarTitleForeColor(integer titleForeColor) Sets the foreground color used to display the title portion of the dropdown calendar.
void	setCalendarTrailingForeColor(integer trailingForeColor) Sets the foreground color used to display the days at the beginning and end of the dropdown calendar that are from previous and following months.
void	setCalendarValue(character value) Sets the current date and time value as a character value.
void	setCalendarValue(date value) Sets the current date value.
void	setCalendarValue(datetime value) Sets the current date and time value.
void	setCalendarValue(java.lang.String value) Sets the current date and time value representing by a string.
void	setCheckBox(logical enabledCheckBox) Sets whether the control displays a checkbox to the left of the date.
void	setCustomFormat(character customFormat) Sets the custom format string used to format the date and/or time displayed in the control.
void	setCustomFormat(java.lang.String customFormat) Sets the custom format string used to format the date and/or time displayed in the control.
void	setDay(integer day) Sets the day number [1-31] for the current date.
void	setDayOfWeek(integer dayOfWeek) Sets the day of the week [0-6] for the current date.
void	setFormatStyle(integer formatStyle) Determines whether dates and times are displayed using standard or custom formatting.
void	setHour(integer hour) Sets the hour number [0-23] for the current time.
void	setMaxDate(date dateMaxDate) Sets the latest date that can be displayed or accepted by the control.
void	setMinDate(date dateMinDate) Sets the earliest date that can be displayed or accepted by the control.
void	setMinute(integer minute) Sets the minute number [0-59] for the current time.
void	setMonth(integer month) Sets the month number [1-12] for the current date.
void	setSecond(integer second) Sets the second number [0-59] for the current time.
void	setUpDown(logical upDown) Sets a value that determines whether an updown (spin) buttons are used to modify dates instead of a dropdown calendar.
void	setYear(integer year) Sets the year for the current date.

Methods inherited from interface com.goldencode.p2j.ui.ComData

getComData, setComData

Methods inherited from interface com.goldencode.p2j.ui.OcxMouse

getMouseButton, getMouseShift, getMouseX, getMouseY

Methods inherited from interface com.goldencode.p2j.ui.OcxDragDrop

getAllowedEffects, getDataFormat, getEffect, getOleDragMode, getOleDropMode, getOleX, getOleY, getState, isDefaultCursors, oleDrag, setAllowedEffects, setDataFormat, setDefaultCursors, setEffect, setOleDragMode, setOleDropMode, setOleX, setOleY, setState

Methods inherited from interface com.goldencode.p2j.ui.CommonWidget

apply, apply, apply, apply, asWidgetHandle, colorDisplay, colorPrompt, deselectRows, disable, editUndo, enable, getBgColor, getBgColorRgb, getColumnFont, getContextHelpId, getCursorOffset, getDColor, getFgColor, getFgColorRgb, getFont, getFrame, getFrameColumn, getFrameHandle, getFrameName, getFrameRow, getFrameX, getFrameY, getHWND, getId, getIdEx, getImage, getLabelFont, getLabelStr, getListItems, getMaxHeightChars, getMaxWidthChars, getMenuKey, getMenuMouse, getMousePointer, getMousePosition, getNextTabItem, getNumColumns, getNumSelectedRows, getParent, getParentHandle, getPfColor, getPopupMenu, getPreviousTabItem, getQuery, getScreenValue, getSideLabelHandle, getTabPosition, getTitle, getTitleFont, getTooltip, getVirtHeight, getVirtHeightPixels, getVirtWidth, getVirtWidthPixels, getWidgetId, getWindow, hide, hide, inputValue, isAutoCompletion, isAutoResize, isEditCanUndo, isEntered, isFocusedRowSelected, isHidden, isKeepFrameZOrder, isManualHighlight, isModified, isMovable, isMultiple, isNotEntered, isResizable, isScrollable, isSelectable, isSelected, isSelected, isSelected, isTabStop, isThreeD, isValidatable, loadMousePointer, loadMousePointer, moveAfterTabItem, moveAfterTabItem, moveBeforeTabItem, moveBeforeTabItem, moveToBottom, moveToTop, openPopup, preRealizeCheck, realize, refresh, selectAll, selectFocusedRow, setAtFormatLength, setAutoCompletion, setAutoCompletion, setAutoResize, setAutoResize, setBgColor, setBgColorRgb, setBlank, setColumnFont, setColumnFont, setContextHelpId, setContextHelpId, setCursorOffset, setCursorOffset, setDColor, setDColor, setDeblank, setDisableAutoZap, setFgColor, setFgColorRgb, setFont, setFont, setFormat, setFrame, setFrame, setFrame, setFrameHandle, setFrameHandle, setFrameHandle, setGroup, setHeader, setHidden, setHidden, setId, setKeepFrameZOrder, setKeepFrameZOrder, setLabelFont, setLabelFont, setListItems, setListItems, setManualHighlight, setManualHighlight, setMaxHeightChars, setMaxWidthChars, setMenuKey, setMenuKey, setMenuMouse, setMenuMouse, setModified, setModified, setMovable, setMovable, setMultiple, setMultiple, setNextTabItem, setNumSelectedRows, setParent, setParentHandle, setParentHandle, setPfColor, setPfColor, setPopupMenu, setPopupMenu, setQuery, setResizable, setResizable, setScreenValue, setScreenValue, setScrollable, setScrollable, setSelectable, setSelectable, setSelected, setSelected, setSensitive, setSideLabelHandle, setTabStop, setTabStop, setThreeD, setThreeD, setTitle, setTitle, setTitleFont, setTitleFont, setTooltip, setTooltip, setValidation, setValidation, setVertical, setVirtHeight, setVirtHeightPixels, setVirtWidth, setVirtWidthPixels, setWidgetId, setWidgetId, underline, underline, valid, validateFields, validateFields, validateFields, view

Methods inherited from interface com.goldencode.p2j.util.CommonHandleChain

getNextSibling, getPrevSibling, getPrivateData, setPrivateData, setPrivateData

Methods inherited from interface com.goldencode.p2j.util.CommonHandle

readOnlyError, readOnlyError, resourceType

Methods inherited from interface com.goldencode.p2j.util.WrappedResource

id, id, unknown

Methods inherited from interface com.goldencode.p2j.util.Nameable

name, name, name

Methods inherited from interface com.goldencode.p2j.util.CommonField

getColumnLabel, getDataType, getFormat, getHelp, getLabel, setColumnLabel, setColumnLabel, setDataType, setDataType, setFormat, setHelp, setHelp, setLabel, setLabel, setLabel

Methods inherited from interface com.goldencode.p2j.util.DatabaseInfo

getDbName, getTable

Methods inherited from interface com.goldencode.p2j.ui.DisableRedraw

isDisableRedraw, setDisableRedraw, setDisableRedraw

Methods inherited from interface com.goldencode.p2j.util.HasVisible

isVisible, setVisible, setVisible

Methods inherited from interface com.goldencode.p2j.util.Sizeable

getHeight, getHeightChars, getHeightPixels, getWidth, getWidthChars, getWidthPixels, setHeight, setHeightChars, setHeightChars, setHeightPixels, setHeightPixels, setWidth, setWidthChars, setWidthChars, setWidthPixels, setWidthPixels

Methods inherited from interface com.goldencode.p2j.util.Coordinates

getColumn, getRow, getX, getY, setColumn, setColumn, setRow, setRow, setX, setX, setY, setY

Methods inherited from interface com.goldencode.p2j.ui.ImageWidgetSupport

getRetainShape, getStretchToFit, getTransparent, setRetainShape, setRetainShape, setStretchToFit, setStretchToFit, setTransparent, setTransparent

Methods inherited from interface com.goldencode.p2j.ui.ImageSupport

getConvert3D, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, setConvert3D, setConvert3D

Methods inherited from interface com.goldencode.p2j.ui.WriteProtectable

isReadOnly, setReadOnly, setReadOnly

Methods inherited from interface com.goldencode.p2j.ui.CustomFont

getFontInfo, getFontName, getFontSize, isFontBold, isFontItalic, isFontUnderline, setFontBold, setFontItalic, setFontName, setFontSize, setFontUnderline

Methods inherited from interface com.goldencode.p2j.util.Enabled

isEnabled, setEnabled, setEnabled

Methods inherited from interface com.goldencode.p2j.ui.WidgetExtension

getMouseIcon, getMousePointerNum, refreshUI, setMouseIcon, setMouseIcon, setMousePointerNum, setMousePointerNum

Method Detail

getCalendarValue

character getCalendarValue()

Returns the current date time value as a character value.

Returns:

The current date time value as a character value

setCalendarValue

void setCalendarValue(date value)

Sets the current date value.

Parameters:

value - The new current date value

setCalendarValue

void setCalendarValue(datetime value)

Sets the current date and time value.

Parameters:

value - The new current date and time value

setCalendarValue

void setCalendarValue(character value)

Sets the current date and time value as a character value.

Parameters:

value - The new current date and time value as a character value

setCalendarValue

void setCalendarValue(java.lang.String value)

Sets the current date and time value representing by a string.

Parameters:

value - The new current date and time value representing by a string

getFormatStyle

integer getFormatStyle()

Determines whether dates and times are displayed using standard or custom formatting.

Returns:

The date and time display format style constant.

setFormatStyle

void setFormatStyle(integer formatStyle)

Determines whether dates and times are displayed using standard or custom formatting.

Parameters:

formatStyle - The date and time display format style constant.

getCalendarBackColor

integer getCalendarBackColor()

Returns the background color used to display the month portion of the dropdown calendar.

Returns:

The background color for the dropdown calendar given by the BGR encoding

setCalendarBackColor

void setCalendarBackColor(integer calendarBackColor)

Sets the background color used to display the month portion of the dropdown calendar.

Parameters:

calendarBackColor - The background color for the dropdown calendar given by the BGR encoding

getCalendarForeColor

integer getCalendarForeColor()

Returns the foreground color used to display text in the month portion of the dropdown calendar.

Returns:

The foreground color for the dropdown calendar given by the BGR encoding

setCalendarForeColor

void setCalendarForeColor(integer calendarForeColor)

Sets the foreground color used to display text in the month portion of the dropdown calendar.

Parameters:

calendarForeColor - The foreground color for the dropdown calendar given by the BGR encoding

getCalendarTitleBackColor

integer getCalendarTitleBackColor()

Returns the background color used to display the title portion of the dropdown calendar.

Returns:

The background color for the title portion of the dropdown calendar given by the BGR encoding.

setCalendarTitleBackColor

void setCalendarTitleBackColor(integer titleBackColor)

Sets the background color used to display the title portion of the dropdown calendar.

Parameters:

titleBackColor - The background color for the title portion of the dropdown calendar given by the BGR encoding.

getCalendarTitleForeColor

integer getCalendarTitleForeColor()

Returns the foreground color used to display the title portion of the dropdown calendar.

Returns:

The foreground color for the title portion of the dropdown calendar given by the BGR encoding.

setCalendarTitleForeColor

void setCalendarTitleForeColor(integer titleForeColor)

Sets the foreground color used to display the title portion of the dropdown calendar.

Parameters:

titleForeColor - The foreground color for the title portion of the dropdown calendar given by the BGR encoding.

getCalendarTrailingForeColor

integer getCalendarTrailingForeColor()

Returns the foreground color used to display the days at the beginning and end of the dropdown calendar that are from previous and following months.

Returns:

The foreground color for the previous and following months of the dropdown calendar given by the BGR encoding.

setCalendarTrailingForeColor

void setCalendarTrailingForeColor(integer trailingForeColor)

Sets the foreground color used to display the days at the beginning and end of the dropdown calendar that are from previous and following months.

Parameters:

trailingForeColor - The foreground color for the previous and following months of the dropdown calendar given by the BGR encoding.

isCheckBox

logical isCheckBox()

Returns whether the control displays a checkbox to the left of the date. When unchecked, no date is selected.

Returns:

True if it displays a checkbox to the left of the date, otherwise false.

setCheckBox

void setCheckBox(logical enabledCheckBox)

Sets whether the control displays a checkbox to the left of the date. When unchecked, no date is selected.

Parameters:

enabledCheckBox - The logical value indicating a checkbox is displayed or not.

getCustomFormat

character getCustomFormat()

Returns the custom format string used to format the date and/or time displayed in the control.

Returns:

The custom format string

setCustomFormat

void setCustomFormat(character customFormat)

Sets the custom format string used to format the date and/or time displayed in the control.

Parameters:

customFormat - The custom format string

setCustomFormat

void setCustomFormat(java.lang.String customFormat)

Sets the custom format string used to format the date and/or time displayed in the control.

Parameters:

customFormat - The custom format string

getDay

integer getDay()

Returns the day number [1-31] for the current date.

Returns:

The day number for the current date

setDay

void setDay(integer day)

Sets the day number [1-31] for the current date.

Parameters:

day - The day number for the current date

getDayOfWeek

integer getDayOfWeek()

Returns the day of the week [0-6] for the current date.

Returns:

The day of the week for the current date

setDayOfWeek

void setDayOfWeek(integer dayOfWeek)

Sets the day of the week [0-6] for the current date.

Parameters:

dayOfWeek - The day of the week for the current date

getHour

integer getHour()

Returns the hour number [0-23] for the current time.

Returns:

The hour number for the current time

setHour

void setHour(integer hour)

Sets the hour number [0-23] for the current time.

Parameters:

hour - The hour number for the current time

getMaxDate

date getMaxDate()

Returns the latest date that can be displayed or accepted by the control.

Returns:

The latest date that can be displayed or accepted by this control

setMaxDate

void setMaxDate(date dateMaxDate)

Sets the latest date that can be displayed or accepted by the control.

Parameters:

dateMaxDate - The new latest date

getMinDate

date getMinDate()

Returns the earliest date that can be displayed or accepted by the control.

Returns:

The earliest date

setMinDate

void setMinDate(date dateMinDate)

Sets the earliest date that can be displayed or accepted by the control.

Parameters:

dateMinDate - The new earliest date

getMinute

integer getMinute()

Returns the minute number [0-59] for the current time.

Returns:

The minute number for the current time

setMinute

void setMinute(integer minute)

Sets the minute number [0-59] for the current time.

Parameters:

minute - The minute number for the current time

getMonth

integer getMonth()

Returns the month number [1-12] for the current date.

Returns:

The month number for the current date

setMonth

void setMonth(integer month)

Sets the month number [1-12] for the current date.

Parameters:

month - The month number for the current date

getSecond

integer getSecond()

Returns the second number [0-59] for the current time.

Returns:

The second number for the current time

setSecond

void setSecond(integer second)

Sets the second number [0-59] for the current time.

Parameters:

second - The second number for the current time

isUpDown

logical isUpDown()

Returns a value that determines whether an updown (spin) button is used to modify dates instead of a dropdown calendar.

Returns:

True value if the updown spin button is used to modify dates instead of a dropdown calendar, otherwise false value.

setUpDown

void setUpDown(logical upDown)

Sets a value that determines whether an updown (spin) buttons are used to modify dates instead of a dropdown calendar.

Parameters:

upDown - The logical value indicating if the up and down buttons are used to modify dates

getYear

integer getYear()

Returns the year for the current date.

Returns:

The year for the current date

setYear

void setYear(integer year)

Sets the year for the current date.

Parameters:

year - The year for the current date