FWD » Core Development » User Interface

** Copyright (c) 2018-2020, Golden Code Development Corporation.

** 008 SBI 20200225 Added Calendar widget support.

   <variable name="map6"           type="java.util.Map" />

   <variable name="ref3"           type="com.goldencode.ast.Aast" />

   <variable name="name3"          type="java.lang.String" />

         <action>widgetKwords.put("CALENDAR", prog.kw_calendar)</action>

         <action>widgetClasses.put("CALENDAR", classForName("com.goldencode.p2j.ui.Calendar"))</action>

         <action>map5.put("mousepointer"          , "MousePointerExt")</action>

         <action>map5.put("refresh"               , "refreshUI")</action>

         <!-- Calendar -->

         <action>map6 = create("java.util.HashMap")</action>

         <action>map6.put("value"            , "DateTimeValue")</action>

         <action>map6.put("CustomFormat"     , "CustomFormat")</action>

         <action>map6.put("font:name"        , "FontName")</action>

         <action>map6.put("font:size"        , "FontSize")</action>

         <action>map6.put("format"           , "FormatStyle")</action>

         <action>aliasMap.put("CALENDAR"   , map6)</action>

                  <action>ocxHandleKey = copy.text</action>

                        <action>ref2 = copy.parent.nextSibling</action>

                     <action>ref2 = execLib("processLegacyNode",copy, ref2, ocxHandle, ocxHandleKey, cache, isConversion)</action>

                        <action>execLib("processLegacyNode",copy, ref2, ocxHandle, ocxHandleKey, cache, isConversion)</action>

                     </rule>   

      <function name="processLegacyNode">

         <parameter name="copy" type="com.goldencode.ast.Aast" />

         <parameter name="ref2" type="com.goldencode.ast.Aast" />

         <parameter name="ocxHandle"       type="java.lang.String"/>

         <parameter name="ocxHandleKey"    type="java.lang.String"/>

         <parameter name="cache"           type="com.goldencode.ast.Aast"/>

         <parameter name="isConversion"    type="java.lang.Boolean"/>

         <return    name="ref3"            type="com.goldencode.ast.Aast"/>

         <variable name="ref1"     type="com.goldencode.ast.Aast" />

         <variable name="name"     type="java.lang.String"/>

         <variable name="name1"    type="java.lang.String"/>

         <variable name="name2"    type="java.lang.String"/>

         <variable name="name3"    type="java.lang.String"/>

         <variable name="ocxType"  type="java.lang.String" />

         <variable name="reftype"  type="java.lang.Integer"/>

         <variable name="reftype1" type="java.lang.Integer"/>

         <variable name="invoc"    type="com.goldencode.ast.Aast"/>

         <variable name="ref"      type="com.goldencode.ast.AnnotatedAst" />

         <variable name="rootComInvocCpy" type="com.goldencode.ast.Aast"/>

         <variable name="methPropCpy"     type="com.goldencode.ast.Aast"/>

                     <!-- convert legacy node -->

                     <rule>ref2 != null

                        <action>name = ref2.text</action>

                        <!-- get the method/prop alias -->

                        <action>ocxType = ch2wtype.get(ocxHandleKey)</action>

                        <action>ref3 = ref2.parent.nextSibling</action>

                        <action>map = aliasMap.get(ocxType)</action>

                        <rule>map != null

                           <action>name1 = name.toLowerCase()</action>

                           <action>name2 = map.get(name1)</action>

                           <rule>name2 != null

                             <action>name = name2</action>

                           </rule>

                           <rule>name2 == null

                             <!-- check for composed properties like font:name -->

                             <action>ref1 = copy.parent.parent.nextSibling</action>

                             <rule>ref1 != null and ref1.type == prog.com_property

                               <action>name2 = ref1.text.toLowerCase()</action>

                               <action>name1 = sprintf("%s:%s", name1, name2)</action>

                               <action>name2 = map.get(name1)</action>

                               <rule>name2 != null

                                  <action>ref1 = copy.parent.parent</action>

                                  <action>ref = copy.parent.parent.parent</action>

                                  <action>ref1.move(ref.parent, 0)</action>

                                  <action>ref.remove()</action>

                                  <action>name = name2</action>

                               </rule>

                             </rule>

                           </rule>

                        </rule>

                        <action>widgetClass = widgetClasses.get(ocxType)</action>

                        <!-- find the root com_invocation -->

                        <action>ref = copy.parent</action>

                        <action>rootComInvocCpy = ref</action>

                        <while>ref.type == prog.com_invocation

                           <action>rootComInvocCpy = ref</action>

                           <action>ref = ref.parent</action>

                        </while>

                        <!-- find the java counterpart method -->

                        <action>name1 = getLegacyName(widgetClass, name)</action>

                        <rule>name1 == null and

                              rootComInvocCpy.parent.type == prog.assign and

                              rootComInvocCpy.indexPos == 0

                           <!-- for prop assignment -->

                           <action>name1 = sprintf("set%s", name)</action>

                           <action>name1 = getLegacyName(widgetClass, name1)</action>

                        </rule>

                        <!-- for prop getter or method invocation -->

                        <rule>name1 == null

                           <action>name1 = sprintf("get%s", name)</action>

                           <action>name1 = getLegacyName(widgetClass, name1)</action>

                        </rule>

                        <!-- for prop getter or method invocation -->

                        <rule>name1 == null

                           <action>name1 = sprintf("is%s", name)</action>

                           <action>name1 = getLegacyName(widgetClass, name1)</action>

                        </rule>         

                        <rule>name1 == null

                           <action>printfln("WARN: FWD OCX Extension: Failed to resolve legacy name for %s. Is %s defined in %s?", name, name, widgetClass)</action>

                           <action>copy.putAnnotation("noop-com", true)</action>

                        </rule>

                        <rule>name1 != null

                           <action>reftype1 = -1</action>

                           <action>reftype = prog.lookupKeywordToken(name1)</action>

                           <rule>reftype == -1

                              <action>printfln("WARN: FWD OCX Extension: Failed to resolve keyword for %s.", name1)</action>

                              <action>copy.putAnnotation("noop-com", true)</action>

                              <action on="false">reftype1 = lookupAttributeOrMethod(reftype)</action>

                              <rule on="false">reftype1 == -1

                                 <action>printfln("WARN: FWD OCX Extension: Failed to resolve attribute or method type for %s.", name1)</action>

                                 <action>copy.putAnnotation("noop-com", true)</action>

                              </rule>

                           </rule>

                           <rule>reftype1 != -1

                              <!-- is this an indexed COM property being assigned? -->

                              <action>methPropCpy = rootComInvocCpy.getImmediateChild(createSet(prog.com_method, prog.com_property), null)</action>

                              <rule>rootComInvocCpy.parent.type == prog.assign and

                                    rootComInvocCpy.indexPos == 0 and

                                    methPropCpy.getImmediateChild(prog.com_parameter, null) != null

                                 <!-- get the assigning expression and make it a parameter -->

                                 <action>ref1 = rootComInvocCpy.nextSibling</action>

                                 <!-- the com parameter will be converted below -->

                                 <action>ref1.type = prog.com_parameter</action>

                                 <action>ref1.text = ""</action>

                                 <action>ref1.move(methPropCpy, -1)</action>

                              </rule>

                             <rule>map != null and ref3 != null and ref3.compareWith(methPropCpy, true)

                                 <action>printfln("hit: %s", ref3.text)</action>

                                 <action>name3=map.get(ref3.text.toLowerCase())</action>

                                 <action>printfln("name3= %s", name3)</action>

                                 <action>methPropCpy.text = name3</action>

                              </rule>

                              <!-- set legacy node properties -->

                              <action>ref2.type = reftype1</action>

                              <action>ref2.text = name1</action>

                              <action>ref2.putAnnotation("oldtype", #(long)reftype)</action>

                              <!-- lookup for com parameters and replace with parameters -->

                              <action>ref1 = ref2.firstChild</action>

                              <while>ref1 != null

                                 <action>ref2 = null</action>

                                 <rule>ref1.type == prog.com_parameter

                                    <action>ref1.type = prog.parameter</action>

                                    <action>ref2 = ref1</action>

                                 </rule>

                                 <action>ref1 = ref1.nextSibling</action>

                                 <!-- check for empty parameter and remove it -->

                                 <rule>ref2 != null and ref2.numChildren == 0

                                    <action>ref2.remove()</action>

                                 </rule>

                              </while>

                              <!-- convert var_com_handle into var_handle -->

                              <action>copy.type = prog.var_handle</action>

                              <action>copy.text = ocxHandle</action>

                              <!-- remove second token since is no longer needed -->

                              <rule>cache != null

                                 <action>cache.remove()</action>

                              </rule>

                              <!-- rearrange nodes and remove unnecessary node -->

                              <rule>isConversion == false and copy.parent.parent != null and copy.parent.parent.type == prog.com_invocation

                                 <action>ref1 = copy.parent</action>

                                 <action>invoc = copy.parent.parent</action>

                                 <action>invoc.type = prog.colon</action>

                                 <action>copy.move(invoc, 0)</action>

                                 <action>ref1.remove()</action>

                              </rule>

                              <!-- when is conversion  -->

                              <rule>isConversion == true and copy.parent != null and copy.parent.type == prog.com_invocation

                                 <action>invoc = copy.parent</action>

                                 <action>invoc.type = prog.colon</action>

                              </rule>

                           </rule>

                        </rule>

                     </rule>

      </function>

** Copyright (c) 2005-2020, Golden Code Development Corporation.

** 086 SBI 20200225          Added Calendar widget support.

** 216 SBI 20200225          Added Calendar widget support.

         <rule>list.put(prog.kw_calcufmt, execLib("cr_descr", "Calendar"                   , "getCustomFormat"        , "setCustomFormat"        , true       ))</rule>

         <rule>list.put(prog.kw_calfmtst, execLib("cr_descr", "Calendar"                   , "getFormatStyle"         , "setFormatStyle"         , true       ))</rule>

         <rule>list.put(prog.kw_calvalue, execLib("cr_descr", "Calendar"                   , "getDateTimeValue"       , "setDateTimeValue"       , true       ))</rule>

         <rule>list.put(prog.kw_msicon,   execLib("cr_descr", "WidgetExtension"            , "getMouseIcon"           , "setMouseIcon"        , true       ))</rule>

         <rule>list.put(prog.kw_mspntnum, execLib("cr_descr", "WidgetExtension"            , "getMousePointerNum"     , "setMousePointerNum"     , true       ))</rule>

         <rule>list.put(prog.kw_rfrsh_ui, execLib("cr_descr", "WidgetExtension"            , "refreshUI"              , null                     , true       ))</rule>

               (downPath("KW_CALENDAR") or evalLib("match_widget_type", "calendar"))

            <action>explicitw = "Calendar"</action>

         </rule>

         <rule>explicitw == null and 

         <rule>widAndQual.put(prog.kw_calendar , rw.cvt_lvl_partial    | rw.rt_lvl_partial)</rule>

         <rule>map.put(prog.kw_msicon,   rw.cvt_lvl_full    | rw.rt_lvl_full)</rule>

         <rule>map.put(prog.kw_mspntnum, rw.cvt_lvl_full    | rw.rt_lvl_full)</rule>

         <rule>map.put(prog.kw_rfrsh_ui, rw.cvt_lvl_full    | rw.rt_lvl_full)</rule>

** 384 SBI 20200225          Added Calendar widget support.

*/

      KW_MSICON;    // FWD extension, not real 4GL! WidgetExtension:MOUSE-ICON

      KW_MSPNTNUM;    // FWD extension, not real 4GL! WidgetExtension:MOUSE-POINTER-NUM

      KW_RFRSH_UI;    // FWD extension, not real 4GL! WidgetExtension:REFRESH-UI

         KW_MS_CLICK;   // begin PROGRESS-BAR

         KW_COM_DATA;    // end PROGRESS-BAR

         KW_CALBGCLR;    // CALENDAR:CalendarBackColor

         KW_CALFGCLR;    // CALENDAR:CalendarForeColor

         KW_CALTITBG;    // CALENDAR:TitleBackColor

         KW_CALTITFG;    // CALENDAR:TitleForeColor

         KW_CALTRLFG;    // CALENDAR:TrailingForeColor

         KW_CALENDAR;    // CALENDAR

         KW_CALCUFMT;    // CALENDAR:CustomFormat

         KW_CALFMTST;    // CALENDAR:FormatStyle

         KW_CALVALUE;    // CALENDAR:DateTimeValue

      attrsAndMethods.put( KW_CALBGCLR, ATTR_INT     ); // FWD CALENDAR extension, not real 4GL

      attrsAndMethods.put( KW_CALCUFMT, ATTR_CHAR    ); // FWD CALENDAR:CustomFormat extension, not real 4GL

      attrsAndMethods.put( KW_CALFGCLR, ATTR_INT     ); // FWD CALENDAR extension, not real 4GL

      attrsAndMethods.put( KW_CALFMTST, ATTR_INT     ); // FWD CALENDAR:FormatStyle extension, not real 4GL

      attrsAndMethods.put( KW_CALVALUE, ATTR_CHAR    ); // FWD CALENDAR:DateTimeValue extension, not real 4GL

      attrsAndMethods.put( KW_CALTITBG, ATTR_INT     ); // FWD CALENDAR extension, not real 4GL

      attrsAndMethods.put( KW_CALTITFG, ATTR_INT     ); // FWD CALENDAR extension, not real 4GL

      attrsAndMethods.put( KW_CALTRLFG, ATTR_INT     ); // FWD CALENDAR extension, not real 4GL

      attrsAndMethods.put( KW_MSICON,   ATTR_CHAR    ); // FWD extension, not real 4GL

      attrsAndMethods.put( KW_MSPNTNUM, ATTR_INT     ); // FWD extension, not real 4GL

      attrsAndMethods.put( KW_RFRSH_UI, METH_VOID    ); // FWD extension, not real 4GL

         | KW_CALENDAR   { is_widget = true; }

         new Keyword("calendar"                       ,  0, KW_CALENDAR, false), // FWD CALENDAR extension, not a real 4GL keyword

         new Keyword("CalendarBackColor"              ,  0, KW_CALBGCLR, false), // FWD CALENDAR extension

         new Keyword("CalendarForeColor"              ,  0, KW_CALFGCLR, false), // FWD CALENDAR extension

         new Keyword("CustomFormat"                   ,  0, KW_CALCUFMT, false),  // CALENDAR:CustomFormat extension

         new Keyword("DateTimeValue"                  ,  0, KW_CALVALUE, false),  // CALENDAR:VALUE extension

         new Keyword("FormatStyle"                    ,  0, KW_CALFMTST, false),  // FWD extension for CALENDAR:FormatStyle, not a real 4GL keyword

         new Keyword("mouse-icon"                     ,  0, KW_MSICON,   false),  // FWD WidgetExtension extension, not a real 4GL keyword

         new Keyword("mouse-pointer-num"              ,  0, KW_MSPNTNUM, false),  // FWD WidgetExtension extension, not a real 4GL keyword

         new Keyword("refresh-ui"                     ,  0, KW_RFRSH_UI, false),  // FWD WidgetExtension extension, not a real 4GL keyword

         new Keyword("TitleBackColor"                 ,  0, KW_CALTITBG, false),  // CALENDAR:TitleBackColor

         new Keyword("TitleForeColor"                 ,  0, KW_CALTITFG, false),  // CALENDAR:TitleForeColor

         new Keyword("TrailingForeColor"              ,  0, KW_CALTRLFG, false),  // CALENDAR:TrailingForeColor

/*

** Module   : Calendar.java

** Abstract : Calendar widget interface.

**

** Copyright (c) 2020, Golden Code Development Corporation.

**

** -#- -I- --Date-- --------------------------------Description-----------------------------------

** 001 SBI 20200114 Created initial version.

*/

/*

** This program is free software: you can redistribute it and/or modify

** it under the terms of the GNU Affero General Public License as

** published by the Free Software Foundation, either version 3 of the

** License, or (at your option) any later version.

**

** This program is distributed in the hope that it will be useful,

** but WITHOUT ANY WARRANTY; without even the implied warranty of

** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

** GNU Affero General Public License for more details.

**

** You may find a copy of the GNU Affero GPL version 3 at the following

** location: https://www.gnu.org/licenses/agpl-3.0.en.html

** 

** Additional terms under GNU Affero GPL version 3 section 7:

** 

**   Under Section 7 of the GNU Affero GPL version 3, the following additional

**   terms apply to the works covered under the License.  These additional terms

**   are non-permissive additional terms allowed under Section 7 of the GNU

**   Affero GPL version 3 and may not be removed by you.

** 

**   0. Attribution Requirement.

** 

**     You must preserve all legal notices or author attributions in the covered

**     work or Appropriate Legal Notices displayed by works containing the covered

**     work.  You may not remove from the covered work any author or developer

**     credit already included within the covered work.

** 

**   1. No License To Use Trademarks.

** 

**     This license does not grant any license or rights to use the trademarks

**     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks

**     of Golden Code Development Corporation. You are not authorized to use the

**     name Golden Code, FWD, or the names of any author or contributor, for

**     publicity purposes without written authorization.

** 

**   2. No Misrepresentation of Affiliation.

** 

**     You may not represent yourself as Golden Code Development Corporation or FWD.

** 

**     You may not represent yourself for publicity purposes as associated with

**     Golden Code Development Corporation, FWD, or any author or contributor to

**     the covered work, without written authorization.

** 

**   3. No Misrepresentation of Source or Origin.

** 

**     You may not represent the covered work as solely your work.  All modified

**     versions of the covered work must be marked in a reasonable way to make it

**     clear that the modified work is not originating from Golden Code Development

**     Corporation or FWD.  All modified versions must contain the notices of

**     attribution required in this license.

*/

package com.goldencode.p2j.ui;

import com.goldencode.p2j.util.*;

/**

 * Defines exported methods and constants for the calendar widget.

 */

@LegacyResource(resource = LegacyResource.CALENDAR)

public interface Calendar

extends WrappedResource,

        ComData,

        OcxMouse,

        OcxDragDrop,

        CommonWidget,

        CustomFont,

        Enabled,

        WidgetExtension

{

   /**

    * Returns the current date time value as a character value.

    * 

    * @return   The current date time value as a character value

    */

   @LegacyAttribute(name = "DateTimeValue")

   public character getDateTimeValue();

   /**

    * Sets the current date value.

    * 

    * @param    value

    *           The new current date value

    */

   @LegacyAttribute(name = "DateTimeValue", setter = true)

   public void setDateTimeValue(date value);

   /**

    * Sets the current date and time value.

    * 

    * @param    value

    *           The new current date and time value

    */

   @LegacyAttribute(name = "DateTimeValue", setter = true)

   public void setDateTimeValue(datetime value);

   /**

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

    * 

    * @param    value

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

    */

   @LegacyAttribute(name = "DateTimeValue", setter = true)

   public void setDateTimeValue(character value);

   /**

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

    * 

    * @param    value

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

    */

   @LegacyAttribute(name = "DateTimeValue", setter = true)

   public void setDateTimeValue(String value);

   /**

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

    * 

    * @return   The date and time display format style constant.

    */

   @LegacyAttribute(name = "FormatStyle")

   integer getFormatStyle();

   /**

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

    * 

    * @param    formatStyle

    *           The date and time display format style constant.

    */

   @LegacyAttribute(name = "FormatStyle", setter = true)

   void setFormatStyle(integer formatStyle);

   /**

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

    * 

    * @return   The background color for the dropdown calendar given by the BGR encoding

    */

   @LegacyAttribute(name = "CalendarBackColor")

   integer getCalendarBackColor();

   /**

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

    * 

    * @param    calendarBackColor

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

    */

   @LegacyAttribute(name = "CalendarBackColor", setter = true)

   void setCalendarBackColor(integer calendarBackColor);

   /**

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

    * 

    * @return   The foreground color for the dropdown calendar given by the BGR encoding

    */

   @LegacyAttribute(name = "CalendarForeColor")

   integer getCalendarForeColor();

   /**

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

    * 

    * @param    calendarForeColor

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

    */

   @LegacyAttribute(name = "CalendarForeColor", setter = true)

   void setCalendarForeColor(integer calendarForeColor);

   /**

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

    * 

    * @return   The background color for the title portion of the dropdown calendar given by

    *           the BGR encoding.

    */

   @LegacyAttribute(name = "TitleBackColor")

   integer getCalendarTitleBackColor();

   /**

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

    * 

    * @param    titleBackColor

    *           The background color for the title portion of the dropdown calendar given by

    *           the BGR encoding.

    */

   @LegacyAttribute(name = "TitleBackColor", setter = true)

   void setCalendarTitleBackColor(integer titleBackColor);

   /**

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

    * 

    * @return   The foreground color for the title portion of the dropdown calendar given by

    *           the BGR encoding.

    */

   @LegacyAttribute(name = "TitleForeColor")

   integer getCalendarTitleForeColor();

   /**

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

    * 

    * @param    titleForeColor

    *           The foreground color for the title portion of the dropdown calendar given by

    *           the BGR encoding.

    */

   @LegacyAttribute(name = "TitleForeColor", setter = true)

   void setCalendarTitleForeColor(integer titleForeColor);

   /**

    * 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.

    * 

    * @return   The foreground color for the previous and following months of

    *           the dropdown calendar given by the BGR encoding.

    */

   @LegacyAttribute(name = "TrailingForeColor")

   integer getCalendarTrailingForeColor();

   /**

    * 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.

    * 

    * @param    trailingForeColor

    *           The foreground color for the previous and following months of

    *           the dropdown calendar given by the BGR encoding.

    */

   @LegacyAttribute(name = "TrailingForeColor", setter = true)

   void setCalendarTrailingForeColor(integer trailingForeColor);

   /**

    * Returns whether the control displays a checkbox to the left of the date. When unchecked,

    * no date is selected.

    * 

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

    */

   @LegacyAttribute(name = "CheckBox")

   logical isCheckBox();

   /**

    * Sets whether the control displays a checkbox to the left of the date. When unchecked,

    * no date is selected.

    * 

    * @param    enabledCheckBox

    *           The logical value indicating a checkbox is displayed or not.

    */

   @LegacyAttribute(name = "CheckBox", setter = true)

   void setCheckBox(logical enabledCheckBox);

   /**

    * Returns the custom format string used to format the date and/or time displayed

    * in the control.

    * 

    * @return   The custom format string

    */

   @LegacyAttribute(name = "CustomFormat")

   character getCustomFormat();

   /**

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

    * 

    * @param    customFormat

    *           The custom format string

    */

   @LegacyAttribute(name = "CustomFormat", setter = true)

   void setCustomFormat(character customFormat);

   /**

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

    * 

    * @param    customFormat

    *           The custom format string

    */

   @LegacyAttribute(name = "CustomFormat", setter = true)

   void setCustomFormat(String customFormat);

   /**

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

    * 

    * @return   The day number for the current date

    */

   integer getDay();

   /**

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

    * 

    * @param    day

    *           The day number for the current date

    */

   void setDay(integer day);

   /**

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

    * 

    * @return   The day of the week for the current date

    */

   integer getDayOfWeek();

   /**

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

    * 

    * @param    dayOfWeek

    *           The day of the week for the current date

    */

   void setDayOfWeek(integer dayOfWeek);

   /**

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

    * 

    * @return   The hour number for the current time

    */

   integer getHour();

   /**

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

    * 

    * @param    hour

    *           The hour number for the current time

    */

   void setHour(integer hour);

   /**

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

    * 

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

    */ 

   date getMaxDate();

   /**

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

    * 

    * @param    dateMaxDate

    *           The new latest date

    */

   void setMaxDate(date dateMaxDate);

   /**

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

    * 

    * @return   The earliest date

    */

   date getMinDate();

   /**

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

    * 

    * @param    dateMinDate

    *           The new earliest date

    */

   void setMinDate(date dateMinDate);

   /**

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

    * 

    * @return   The minute number for the current time

    */

   integer getMinute();

   /**

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

    * 

    * @param    minute

    *           The minute number for the current time

    */

   void setMinute(integer minute);

   /**

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

    * 

    * @return   The month number for the current date

    */

   integer getMonth();

   /**

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

    * 

    * @param    month

    *           The month number for the current date

    */

   void setMonth(integer month);

   /**

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

    * 

    * @return   The second number for the current time

    */

   integer getSecond();

   /**

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

    * 

    * @param    second

    *           The second number for the current time

    */

   void setSecond(integer second);

   /**

    * Returns a value that determines whether an updown (spin) button is used to modify dates

    * instead of a dropdown calendar.

    * 

    * @return   True value if the updown spin button is used to modify dates instead of a dropdown

    *           calendar, otherwise false value.

    */

   @LegacyAttribute(name = "UpDown")

   logical isUpDown();

   /**

    * Sets a value that determines whether an updown (spin) buttons are used to modify dates

    * instead of a dropdown calendar.

    * 

    * @param    upDown

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

    */

   @LegacyAttribute(name = "UpDown", setter = true)

   void setUpDown(logical upDown);

   /**

    * Returns the year for the current date.

    * 

    * @return   The year for the current date

    */

   integer getYear();

   /**

    * Sets the year for the current date.

    * 

    * @param    year

    *           The year for the current date

    */

   void setYear(integer year);

}

/*

** Module   : CalendarConfig.java

** Abstract : The calendar widget configuration settings.

**

** Copyright (c) 2020, Golden Code Development Corporation.

**

** -#- -I- --Date-- --------------------------------Description-----------------------------------

** 001 SBI 20200114 Created initial version.

*/

/*

** This program is free software: you can redistribute it and/or modify

** it under the terms of the GNU Affero General Public License as

** published by the Free Software Foundation, either version 3 of the

** License, or (at your option) any later version.

**

** This program is distributed in the hope that it will be useful,

** but WITHOUT ANY WARRANTY; without even the implied warranty of

** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

** GNU Affero General Public License for more details.

**

** You may find a copy of the GNU Affero GPL version 3 at the following

** location: https://www.gnu.org/licenses/agpl-3.0.en.html

** 

** Additional terms under GNU Affero GPL version 3 section 7:

** 

**   Under Section 7 of the GNU Affero GPL version 3, the following additional

**   terms apply to the works covered under the License.  These additional terms

**   are non-permissive additional terms allowed under Section 7 of the GNU

**   Affero GPL version 3 and may not be removed by you.

** 

**   0. Attribution Requirement.

** 

**     You must preserve all legal notices or author attributions in the covered

**     work or Appropriate Legal Notices displayed by works containing the covered

**     work.  You may not remove from the covered work any author or developer

**     credit already included within the covered work.

** 

**   1. No License To Use Trademarks.

** 

**     This license does not grant any license or rights to use the trademarks

**     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks

**     of Golden Code Development Corporation. You are not authorized to use the

**     name Golden Code, FWD, or the names of any author or contributor, for

**     publicity purposes without written authorization.

** 

**   2. No Misrepresentation of Affiliation.

** 

**     You may not represent yourself as Golden Code Development Corporation or FWD.

** 

**     You may not represent yourself for publicity purposes as associated with

**     Golden Code Development Corporation, FWD, or any author or contributor to

**     the covered work, without written authorization.

** 

**   3. No Misrepresentation of Source or Origin.

** 

**     You may not represent the covered work as solely your work.  All modified

**     versions of the covered work must be marked in a reasonable way to make it

**     clear that the modified work is not originating from Golden Code Development

**     Corporation or FWD.  All modified versions must contain the notices of

**     attribution required in this license.

*/

package com.goldencode.p2j.ui;

import java.io.*;

import java.text.*;

import java.time.format.*;

import java.time.temporal.*;

import java.util.*;

import com.goldencode.p2j.util.*;

/**

 * Represents the calendar settings.

 */

public class CalendarConfig

extends WidgetConfigExt

{

   /**

    * Displays the date in long format. The default format string for this style is defined by

    * the current locale settings, which produces output like "Saturday, February 1, 2020". 

    */

   public static final int DTS_LONGDATEFORMAT  = 0;

   /**

    * Displays the date in short format. The default format string for this style is defined by

    * the current locale settings, which produces output like "02/01/20". 

    */

   public static final int DTS_SHORTDATEFORMAT = 1;

   /**

    * Displays the time. The default format string for this style is defined by the current locale

    * settings, which produces output like "10:29:00 AM". 

    */

   public static final int DTS_TIMEFORMAT      = 2;

   /**

    * Displays date and time using the format string specified in the 'CustomFormat' property.

    */

   public static final int DTS_CUSTOMFORMAT    = 3;

   /**

    * The format style constant, it can be one of DTS_LONGDATEFORMAT, DTS_SHORTDATEFORMAT,

    * DTS_TIMEFORMAT, DTS_CUSTOMFORMAT.

    */

   public int formatStyle;

   /** Holds the current date time format.*/

   public String customFormat;

   /** Holds the current date or time value as a string value in the ISO-8601 calendar system. */

   public String dateTimeValue;

   /** Holds the day number from 1 to 31. */

   public int day;

   /** Holds the month number from 1 to 12. */

   public int month;

   /** Holds the year number. */

   public int year;

   /** Holds the day of week number from 0 to 6 */

   public int dayOfWeek;

   /** Holds the hour number from 0 to 23. */

   public int hour;

   /** Holds the minute number from 0 to 59. */

   public int minute;

   /** Holds the second number from 0 to 59. */

   public int second;

   /** Holds the latest possible date */

   public date latestDate;

   /** Holds the earliest possible date */

   public date earliestDate;

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

   public int bodyBackgroundColor;

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

   public int bodyForegroundColor;

   /**

    * The background color for the title portion of the dropdown calendar

    * given by the BGR encoding.

    */

   public int titleBackgroundColor;

   /**

    * The foreground color for the title portion of the dropdown calendar

    * given by the BGR encoding.

    */

   public int titleForegroundColor;

   /**

    * The foreground color for the previous and following months of

    * the dropdown calendar given by the BGR encoding

    */

   public int trailingForegroundColor;

   /** True if a checkbox to the left of the date must be displayed, otherwise false */

   public boolean checkBox;

   /** Its value indicates if the up and down buttons are used to modify dates or not*/

   public boolean upDown;

   /** Represents an index of the selected field of the date/time content */

   public int selectedFieldIndex;

   /**

    * Converts the control format style to the pair of date and time legacy format style used

    * by java time api. If for the date format style element or for the time format style element

    * there doesn't exist a such correspondent legacy format style used by java time api,

    * then this element holds a null value.

    * 

    * @param    formatStyle

    *           The format style constant provided for the calendar widget

    * 

    * @return   The array of the date and time legacy format styles used by java time api.

    */

   public static final FormatStyle[] toDateTimeStyles(int formatStyle)

   {

      FormatStyle[] legacyStyles = new FormatStyle[2];

      switch(formatStyle)

      {

         case DTS_LONGDATEFORMAT:

            legacyStyles[0] = FormatStyle.FULL;

            break;

         case DTS_SHORTDATEFORMAT:

            legacyStyles[0] = FormatStyle.SHORT;

            break;

         case DTS_TIMEFORMAT:

            legacyStyles[1] = FormatStyle.SHORT;

            break;

         default:

      }

      return legacyStyles;

   }

   /**

    * Tests if the given format style is one of the predefined localized system date and time

    * formats to display dates as full or short form styles or to display times in a short form.

    *  

    * @param    formatStyle

    *           The given format style

    * 

    * @return   true if the given format style is one of the predefined formats, otherwise false.

    */

   public static final boolean isLocalizedFormat(int formatStyle)

   {

      return formatStyle != DTS_CUSTOMFORMAT;

   }

   /**

    * The default constructor.

    */

   public CalendarConfig()

   {

      selectedFieldIndex = 0;

   }

   /**

    * Creates this instance using the given identifier.

    * 

    * @param    id

    *           The widget identifier

    */

   public CalendarConfig(int id)

   {

      super(id);

      selectedFieldIndex = 0;

   }

   /**

    * Creates this instance using the given identifier.

    * 

    * @param    id

    *           The widget identifier

    */

   public CalendarConfig(WidgetId id)

   {

      super(id);

      selectedFieldIndex = 0;

   }

   /**

    * Set new values from the provided configuration instance.

    * 

    * @param    config

    *           The instance from which to take values.

    */

   @Override

   public void applyConfig(WidgetConfig config)

   {

      super.applyConfig(config);

      CalendarConfig cfg = (CalendarConfig) config;

      formatStyle   = cfg.formatStyle; 

      customFormat  = cfg.customFormat;

      dateTimeValue = cfg.dateTimeValue;

      day = cfg.day;

      month = cfg.month;

      year = cfg.year;

      dayOfWeek = cfg.dayOfWeek;

      hour = cfg.hour;

      minute = cfg.minute;

      second = cfg.second;

      latestDate   = cfg.latestDate;

      earliestDate = cfg.earliestDate;

      bodyBackgroundColor = cfg.bodyBackgroundColor;

      bodyForegroundColor = cfg.bodyForegroundColor;

      titleBackgroundColor = cfg.titleBackgroundColor;

      titleForegroundColor = cfg.titleForegroundColor;

      trailingForegroundColor = cfg.trailingForegroundColor;

      checkBox = cfg.checkBox;

      upDown   = cfg.upDown;

      selectedFieldIndex = cfg.selectedFieldIndex;

   }

   /**

    * Replacement for the default object reading method. The latest

    * state is read from the input source.  The parent's state is

    * read first.

    * 

    * @param    in

    *           The input source from which fields will be restored.

    *

    * @throws   IOException

    *           In case of I/O errors.

    * @throws   ClassNotFoundException

    *           If payload can't be instantiated.

    */

   @Override

   public void readExternal(ObjectInput in)

   throws IOException,

          ClassNotFoundException