Calendar (Maximo API)

java.lang.Object
- psdi.webclient.system.controller.BaseInstance
- - psdi.webclient.system.controller.ControlInstance
  - - psdi.webclient.system.controller.DatasrcInstance
    - - psdi.webclient.controls.Calendar

All Implemented Interfaces:

java.lang.Cloneable, DataBeanListener
```
public class Calendar
extends DatasrcInstance
implements DataBeanListener
```
This class represents the controller for WallCalandar and Calendar controls. and WallCalendar control

Field Summary
- Fields inherited from class psdi.webclient.system.controller.DatasrcInstance
  databean
- Fields inherited from class psdi.webclient.system.controller.ControlInstance
  amIinitialize, DATASOURCE, errorChanged, errorLevel, errorsValidated, generatedControl, INPUTMODE, labelOverride, labelParams, LOG_CATEGORY, ONDATACAHNGE, originalControl, PARAM_APP, PARAM_APPTABTYPE, PARAM_DESIGNMODE, PARAM_LIGHTNING, PARAM_MOBILE, PARAM_MODULE, PARAM_PAGE, PARAM_PARENTCOMPONENT, PARAM_PARENTCONTROL, PARAM_PRESENTATION, PARAM_SCREENREADER, PARAM_SKINNAME, PARAM_TAB, PARAM_TABGROUP, PARAM_TABGROUP_MAIN, PARAM_TABLE, PARAM_USERINFO, PARAM_VERTICALLABEL, propertyOriginator, RERENDER_PROPERTY
- Fields inherited from class psdi.webclient.system.controller.BaseInstance
  changedProperties, EXCEPTION_ERROR, EXCEPTION_INFO, EXCEPTION_NONE, EXCEPTION_REQUIREDFIELD, EXCEPTION_SMARTFILL, EXCEPTION_WARNING, EXCEPTION_YESNOCANCEL, FORCE_WARNING_HANDLING, NO_PROMPT_WITH_WARNING, presentationTags, PROMPT_WHEN_WARNING_EXIST, properties, type

Constructor Summary

Constructors
Constructor and Description

Calendar()

Constructors
Constructor and Description
`Calendar()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`changedate()` Handles the change of date when user scroll month, year or current date.
`void`	`changedate(java.lang.String type, java.lang.String valueTyped)` Handles the change of date when user types time parts in the fields Also updates current calendar details and properties.
`void`	`dataChangedEvent(DataBean speaker)` Overridden from DataBean
`java.lang.String`	`getCurrentDateString()` Prepares and returns the current date string viz.
`java.lang.String`	`getCurrentMonth()` Returns current month name
`int`	`getDay()` Returns day of the current calendar
`java.lang.String[]`	`getDays()` Returns names of days
`int`	`getDaysInMonth()` Return number of days in months
`java.lang.String`	`getEndDateAttribute()` Returns end date attribute property
`int`	`getFirstDayOfWeek()` Returns first week of the day
`java.lang.String`	`getHours(int dayNum)` Returns Hours (HH:MM) for a given day for the current month
`java.lang.String`	`getHTMLNotes(int dayNum)` Returns HTML notes for a given day for the current month
`int`	`getMonth()` Returns month of the current calendar
`java.lang.String[]`	`getMonths()` Returns names of months
`java.lang.String`	`getStartDateAttribute()` Returns start date attribute property
`int`	`getStartDay()` Returns start day of the current calendar
`com.ibm.icu.util.Calendar`	`getToday()` Returns Calendar object for current date
`int`	`getTodaysDay()` Returns day number of the current date
`int`	`getTodaysMonth()` Returns month number of the current date
`int`	`getTodaysYear()` Returns year of the current date
`int`	`getYear()` Returns year of the current calendar
`void`	`initialize()` should be extended to do any setup required by the instance.
`int`	`invalidyear()` Handles the invalid year event
`boolean`	`isCurrent()` Returns true if the calendar is current (month and year)
`int`	`render()` Overridden to refresh variables and properties on control of render
`int`	`setdate()`
`void`	`spintime(java.lang.String type, boolean increment)` Handles the change of date when user types time parts in the fields Also updates current calendar details and properties.
`void`	`structureChangedEvent(DataBean speaker)` Sets up the calendar for refresh when user moves the record
`int`	`thisdayworkperiods()` Partially handles "thisdayworkperiods" event to prepare the gregorian calendar to pass on to the dialog.

Methods inherited from class psdi.webclient.system.controller.DatasrcInstance
broadcastEvent, cleanup, getDataBean, instantiatedatasrc, instantiatedatasrcdesign

Methods inherited from class psdi.webclient.system.controller.ControlInstance
addChild, addComponent, canInsert, canInsert, canRemove, childHasError, childHasErrorFocus, clearComponent, clearErrors, clearFlags, copy, createRenderId, determineErrorLevel, errorLevelChanged, eventCheck, findComponentByDescriptorId, findDesignerProperty, findProperty, findUseForLablledByComponent, getAdaptorInstance, getBoundComponent, getComponent, getComponents, getConditonallyChanged, getDataSource, getDescriptorControl, getDesignerProperty, getDesignerSelected, getDesignerSelectedControl, getElement, getErrorLevel, getGeneratedControl, getOriginalControl, getOriginalProperty, getProperties, getProperty, getProperty, getPropertyIgnoreFlags, getPropertyOriginator, getPropertyUncle, getRecordHover, getSkipPreRender, getTableControl, getTakesValueComponent, handleEvent, hasChanged, hasChangedConditionally, hasChildElements, hasMaskedChanged, hasRecordHover, hasSigOptionAccess, hasVisibleChildren, isDesignerEditedProperty, isDisabled, isFirstChildVisible, isFocusable, isGenerated, isHiddenByLicense, isIncluded, isLastChild, isMainrecActionMenu, isMasked, isOnTableFilterRow, isOnTableTitleRow, isPersistentProperty, isReInitialize, isSelected, isToBeDisplayedOnCurrentTab, isToBeDisplayedOnTab, isVisible, launchexternal, licenseCheck, moveChild, needsRender, parentPropertyChanged, parseParamvalues, preRender, preRenderChecks, propertyChanged, quickinsert, registerDesignerEditedProperty, reInitialize, removeChild, renderChildren, resetDataSource, resolveParam, resolveParams, setAttributeError, setBoundComponent, setChangedFlag, setChangedFlag, setConditionalProperties, setDesignerSelected, setDisabled, setElement, setErrorFocusOnControl, setFocus, setFocus, setFocusable, setFocusTable, setGenerated, setGeneratedControl, setIncluded, setIncluded, setNeedsRender, setOnTableFilterRow, setOnTableRow, setOnTableTitleRow, setOriginalControl, setPropertyOriginator, setPropertyUncle, setReInitialize, setReRenderFlags, setSelected, setSkipPreRender, setTableControl, setVisibility, sigOptionCheck, sigOptionCheckForLookups, stopRender, walkForId, walkForId

Methods inherited from class psdi.webclient.system.controller.BaseInstance
addChild, addChild, addRefreshListener, canSetProperty, clearChildren, clearPropChangeList, clearProperties, clone, clone, getBoolean, getChangedProperties, getChildCount, getChildIndex, getChildren, getConsiderInDesigner, getDescriptor, getId, getIdExtension, getInt, getLocalizedType, getPage, getParent, getParentInstance, getPropertyNames, getRefreshListeners, getRenderId, getRowNum, getSafeId, getString, getType, getWebClientSession, handleEvent, hasAnyPropertyChanged, hasLocalProperty, hasPropertyChanged, initProperty, isDynamicContainer, isOnTable, isOnTableRow, maintainControlId, removeProperty, setConsiderInDesigner, setDescriptor, setDynamicContainer, setOnTable, setParent, setProperty, setProperty, setRenderId, setType, setWebClientSession, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Calendar
```
public Calendar()
```
- Method Detail
  - initialize
```
public void initialize()
```
    Description copied from class: BaseInstance
    
    should be extended to do any setup required by the instance. for example, the DatasrcInstance will call initialize to create data sources found in the bind list.
    
    Overrides:
    
    initialize in class ControlInstance
  - setdate
```
public int setdate()
```
    Returns:
    
    See Also:
    
    BoundComponentInstance.datelookup()
  - thisdayworkperiods
```
public int thisdayworkperiods()
```
    Partially handles "thisdayworkperiods" event to prepare the gregorian calendar to pass on to the dialog.
    
    Returns:
    
    WebClientBean.EVENT_HANDLED;
  - changedate
```
public int changedate()
```
    Handles the change of date when user scroll month, year or current date. Also updates current calendar details and properties
    
    Returns:
    
    WebClientBean.EVENT_HANDLED;
  - changedate
```
public void changedate(java.lang.String type,
                       java.lang.String valueTyped)
```
    Handles the change of date when user types time parts in the fields Also updates current calendar details and properties. Can be extended later to include month and year, if these fields are not readonly.
  - spintime
```
public void spintime(java.lang.String type,
                     boolean increment)
```
    Handles the change of date when user types time parts in the fields Also updates current calendar details and properties. Can be extended later to include month and year, if these fields are not readonly.
  - invalidyear
```
public int invalidyear()
```
    Handles the invalid year event
    
    Returns:
  - getCurrentDateString
```
public java.lang.String getCurrentDateString()
```
    Prepares and returns the current date string viz. "Today is :..."
    
    Returns:
    
    currentDateString String
  - render
```
public int render()
           throws java.lang.NoSuchMethodException,
                  java.lang.IllegalAccessException,
                  java.lang.reflect.InvocationTargetException
```
    Overridden to refresh variables and properties on control of render
    
    Overrides:
    
    render in class DatasrcInstance
    
    Throws:
    
    java.lang.NoSuchMethodException
    
    java.lang.IllegalAccessException
    
    java.lang.reflect.InvocationTargetException
    
    See Also:
    
    ControlInstance.render()
  - getHTMLNotes
```
public java.lang.String getHTMLNotes(int dayNum)
```
    Returns HTML notes for a given day for the current month
    
    Parameters:
    
    dayNum - int
    
    Returns:
    
    notes String
  - getHours
```
public java.lang.String getHours(int dayNum)
```
    Returns Hours (HH:MM) for a given day for the current month
    
    Parameters:
    
    dayNum - int
    
    Returns:
    
    hours String
  - dataChangedEvent
```
public void dataChangedEvent(DataBean speaker)
```
    Overridden from DataBean
    
    Specified by:
    
    dataChangedEvent in interface DataBeanListener
    
    Parameters:
    
    speaker -
  - structureChangedEvent
```
public void structureChangedEvent(DataBean speaker)
```
    Sets up the calendar for refresh when user moves the record
    
    Specified by:
    
    structureChangedEvent in interface DataBeanListener
    
    See Also:
    
    DataBeanListener.structureChangedEvent(psdi.webclient.system.beans.DataBean)
  - getToday
```
public com.ibm.icu.util.Calendar getToday()
```
    Returns Calendar object for current date
    
    Returns:
    
    today Calendar
  - isCurrent
```
public boolean isCurrent()
```
    Returns true if the calendar is current (month and year)
    
    Returns:
    
    curent boolean
  - getDaysInMonth
```
public int getDaysInMonth()
```
    Return number of days in months
    
    Returns:
    
    daysInMonth int
  - getFirstDayOfWeek
```
public int getFirstDayOfWeek()
```
    Returns first week of the day
    
    Returns:
    
    firstDayOfWeek int
  - getTodaysMonth
```
public int getTodaysMonth()
```
    Returns month number of the current date
    
    Returns:
    
    todaysMonth int
  - getTodaysYear
```
public int getTodaysYear()
```
    Returns year of the current date
    
    Returns:
    
    todaysYear int
  - getTodaysDay
```
public int getTodaysDay()
```
    Returns day number of the current date
    
    Returns:
    
    todaysDay int
  - getStartDay
```
public int getStartDay()
```
    Returns start day of the current calendar
    
    Returns:
    
    startDay int
  - getMonth
```
public int getMonth()
```
    Returns month of the current calendar
    
    Returns:
    
    month int
  - getYear
```
public int getYear()
```
    Returns year of the current calendar
    
    Returns:
    
    year int
  - getDay
```
public int getDay()
```
    Returns day of the current calendar
    
    Returns:
    
    day int
  - getDays
```
public java.lang.String[] getDays()
```
    Returns names of days
    
    Returns:
    
    days String[]
  - getMonths
```
public java.lang.String[] getMonths()
```
    Returns names of months
    
    Returns:
    
    months String[]
  - getStartDateAttribute
```
public java.lang.String getStartDateAttribute()
```
    Returns start date attribute property
    
    Returns:
    
    String
  - getEndDateAttribute
```
public java.lang.String getEndDateAttribute()
```
    Returns end date attribute property
    
    Returns:
    
    String
  - getCurrentMonth
```
public java.lang.String getCurrentMonth()
```
    Returns current month name
    
    Returns:
    
    String

Fields inherited from class psdi.webclient.system.controller.DatasrcInstance

Fields inherited from class psdi.webclient.system.controller.ControlInstance

Fields inherited from class psdi.webclient.system.controller.BaseInstance

Methods inherited from class psdi.webclient.system.controller.DatasrcInstance

Methods inherited from class psdi.webclient.system.controller.ControlInstance

Methods inherited from class psdi.webclient.system.controller.BaseInstance

Methods inherited from class java.lang.Object

Calendar

initialize

setdate

thisdayworkperiods

changedate

changedate

spintime

invalidyear

getCurrentDateString

render

getHTMLNotes

getHours

dataChangedEvent

structureChangedEvent

getToday

isCurrent

getDaysInMonth

getFirstDayOfWeek

getTodaysMonth

getTodaysYear

getTodaysDay

getStartDay

getMonth

getYear

getDay

getDays

getMonths

getStartDateAttribute

getEndDateAttribute

getCurrentMonth