Component CALENDAR

Overview

The CALENDAR component represents a calendar that is directly embedded into the page.

Please also check the CALENDARFIELD component - in which the calendar is opens as popup dialog on a field.

Attribute summary

Typically used attributes

All attributes are

Positioning

Used inside: ADAPTIVETILECONTAINER, ADAPTIVETOOLBAR, AREASELECTOR, BLOCKABLEAREA, COLSYNCHEDROW, DRAWAREA, FOLDABLEPANEHEADERROW, GRIDCOL, GRIDFOOTER, GRIDHEADER, GRIDHEADERLABEL, GRIDLAYOUTROW, LABELCONTAINER, LAYEREDPANE, OVERLAYAREABASEITEM, OVERLAYAREAITEM, PAGEBEANROOT, PAINTAREAITEM, REPEAT, ROW, ROWADAPTIVELINE, ROWFLEXCOLUMNCONTAINER, ROWFLEXLINECONTAINER, ROWFOOTER, ROWHEADER, ROWTITLEBAR, SCHEDULEITEM, SCHEDULEITEMAREA, SIZEANIMATIONAREA, SPANGRIDCOL, STABLEAREA, TABBEDAREABEGIN, TABBEDAREAEND, TEXTWITHCONTROLS, TREENODE

Attribute details

actionListener

Binding to server side method that processes the events coming from this component.

The attribute value must be an expression.

#{methodBinding}Method binding

adapterbinding

Special binding to component adapter object instance on server side. The component adapter must be an instance of IComponentAdapterBinding. For some components (e.g. FIXGRID) there is an extended interface (e.g. IFIXGRIDComponentAdapterBinding).

The attribute value must be an expression.

#{tobedefined}Binding to IComponentAdapter instance

attributemacro

Name of macro that is used for generating certain attributes of this component. Please pay attention: the value of this attribute is read one time for each control and cannot be changed afterwards.

The attribute value must not be changed once the component is created.

calendarstyle

Parameters that define the look and feeld of the calendar. FX client only!

colalignmentx

In case the space provided by the container (e.g. gridlayoutcontainer) for the component is wider than the component itself: definition where to place the component

leftLeft (default)
centerCenter
rightRight

colspan

Spanning of columns if used inside a COLSYNCHEDROW or inside a GRIDLAYOUTPANE.

1Control spans one column (default)
22 columns
33 columns

comment

Comment that can be asigned to any component. The comment is not operationally used.

Any textAny text

configinfo

Configuration information that is attached to this component. This information is not functionally used by CaptainCasa, but may be used for any application specific purpose.

enabled

Indicator if component is enabled or not.

trueComponent is enabled.
falseComponent is not enabled.

exacttime

If set to true, then all date-parts that are not in the scope of the input are set to 0. E.g. if maintaining a date then hour, minute, second and millisecond wil be set to 0.

trueExact date/time - set 0
false(default) - no setting to 0

exacttimehhmmssmmm

Extended configuration for attribute EXACTTIME: here you can exactly define the time within the day that should be automatically chosen if the user selects a date.

 default - 00:00:00:000
11111101111:11:11:011
12000000012:00:00:000
23595999923:59:59:999

extcalendarinfos

Extended information that is passed into the visual calendar representation. The value is an XML string that is produces by using the Java class ExtCalendarInfos, method toXML().

flush

Indicator if data changed in the component are transferred immediately to the server, causing a normal round trip processing from client to server.

trueFlush is done on data change.
falseNo flush. Data is transferred to server with next round trip.

fromdate

reference

Reference to an outside object that is the content behind the component. E.g. a field is representing a certain field of a database table: in this case you could define the value table;column. The reference plays a siginficant role within the attributemacro management.

The attribute value must not be changed once the component is created.

refOne reference
ref1;ref2Two references
ref1;ref2;ref3Three references

rendered

Flag that indicated if this component is rendered at all. If set to false then the component is not rendered - there is no component data sent to the client.

The attribute value must be an expression.

trueComponent is rendered (default)
falseComponent is not rendered

rounding

Rounding radius of edges of border/background. This is optical rounding - so has nothing to do with mathematical rounding... The definition is either made for all corners - or as semicolon separated variant for each corner.

0Straight edges
5Rounding with radius 5
10Rounding with radius 10
0;5;5;0indiviual per corner: left top, right top, right bottom, left bottom
0;50%;5;2indiviual per corner: any mixing is allowed..

rowalignmenty

If more than one component is arranged within one row, then components need to decide how they want to be aligned vertically inside the row - in case the height of the row exceeds the height of the component itself.

topTop
centerCenter (default)
bottomBottom

rowspan

Spanning of rows if used inside a GRIDLAYOUTPANE.

1Control spans one row (default)
22 rows
33 rows

shadow

Shadow of component. The definition is done by several inner values: hoffset, voffset, blur and color.

hoffset:5;voffset:5;blur:5;color:#C0C0C0full shadow definition
color:#C0C0C0Definition only via color, rest of values is set to default values

styleseq

Style class names that are applied to this component.

stylevariant

In CaptainCasa you can define styles definitions for components. A style definition is a definition of a set of default attribute values that are applied to the component. In case you want to differenciate between different usage types of the component you can apply multiple styles - and use the stylevariant attribute to select between.

timezone

Timezone that is used for transferring the date input into a time stamp. Values need to correspond to TimeZone.getAvailableIDs().

LOCALTo be set if using LocalDate/LocalTime on server side
-------------------------
GMTGMT - Greenwich Mean Time (no daylight saving)
UTCUTC - Coordinated Universal Time (no daylight saving)
-------------------------
CETCET - Central European Time
Europe/ParisEurope/Paris
Africa/HarareAfrica/Harare
Asia/Tel_AvivAsia/Tel_Aviv
......

todate

transform

2 dimensional transformation that is applied to the component.

 no transformation (default)
rotate(10deg)Rotation by 10 degrees
rotate(-10deg)Rotation by -10 degrees
skewX(-10deg)Skew in horizontal direction by -10 degrees
skewY(10deg)Skew in vertical direction by 10 degrees
skew(10deg,20deg)Skew in both horizontal (10 degrees) and vertical (20 degrees) direction

value

Data value that is shown and (dependent from the component type) edited inside the component.

x

x-pixel-position: this attribute is only used if the component is directly placed into a PAINTAREA!

y

y-pixel-position: this attribute is only used if the component is directly placed into a PAINTAREA!