src/java/isac/wsdialog/IUIElement.java
branchjava_rename_format
changeset 3922 fcd5648113ca
equal deleted inserted replaced
963:b4896ce4d1b0 3922:fcd5648113ca
       
     1 /*
       
     2  * Created on Dec 12, 2003
       
     3  */
       
     4 package isac.wsdialog;
       
     5 
       
     6 /**
       
     7  * @author Alan Krempler
       
     8  * 
       
     9  * Constants describing interactions or request from the user
       
    10  */
       
    11 public interface IUIElement {
       
    12 
       
    13     /** ***************** NOTIFICATIONS: SPECIFYING PHASE ********************** */
       
    14 
       
    15     public static final int UI_DUMMY_FIRST_SPECIFY = 1;
       
    16 
       
    17     /**
       
    18      * get descriptions into all items of a model; these give hints for input to
       
    19      * the user
       
    20      */
       
    21     public static final int UI_SPECIFY_GET_DESCRIPTIONS = 2;
       
    22 
       
    23     /**
       
    24      * During the specifying phase, try to match a problem type to the data
       
    25      * entered so far WN //// ?items of the model entered so far
       
    26      */
       
    27     public static final int UI_SPECIFY_TRY_MATCH = 2;
       
    28 
       
    29     /**
       
    30      * During the specifying phase, try to refine the problem type. WN ////
       
    31      */
       
    32     public static final int UI_SPECIFY_TRY_REFINE = 3;
       
    33 
       
    34     /**
       
    35      * During the specifying phase, change the view on the CalcHead.
       
    36      */
       
    37     public static final int UI_SPECIFY_CHANGE_VIEW = 4;
       
    38 
       
    39     /**
       
    40      * During the specifying phase, have the CalcHead completed by the math
       
    41      * engine.
       
    42      */
       
    43     public static final int UI_SPECIFY_COMPLETE_CALCHEAD = 5;
       
    44 
       
    45     /**
       
    46      * During the specifying phase, have the Method field of the CalcHead
       
    47      * completed by the math engine.
       
    48      */
       
    49     public static final int UI_SPECIFY_COMPLETE_METHOD = 6;
       
    50 
       
    51     /**
       
    52      * During the specifying phase, have the Theory field of the CalcHead
       
    53      * completed by the math engine.
       
    54      */
       
    55     public static final int UI_SPECIFY_COMPLETE_THEORY = 7;
       
    56 
       
    57     /**
       
    58      * During the specifying phase, have the Problem field of the CalcHead
       
    59      * completed by the math engine.
       
    60      */
       
    61     public static final int UI_SPECIFY_COMPLETE_PROBLEM = 8;
       
    62 
       
    63     /**
       
    64      * During the specifying phase, have the Given field of the CalcHead
       
    65      * completed by the math engine.
       
    66      */
       
    67     public static final int UI_SPECIFY_COMPLETE_GIVEN = 9;
       
    68 
       
    69     /**
       
    70      * During the specifying phase, have the Find field of the CalcHead
       
    71      * completed by the math engine.
       
    72      */
       
    73     public static final int UI_SPECIFY_COMPLETE_FIND = 10;
       
    74 
       
    75     /**
       
    76      * During the specifying phase, have the Relate field of the CalcHead
       
    77      * completed by the math engine.
       
    78      */
       
    79     public static final int UI_SPECIFY_COMPLETE_RELATE = 11;
       
    80 
       
    81     /**
       
    82      * During the specifying phase, have the CalcHead checked for completeness
       
    83      * and consistency.
       
    84      */
       
    85     public static final int UI_SPECIFY_CHECK_CALCHEAD = 12;
       
    86 
       
    87     /**
       
    88      * Leave the specifying phase, enter the solving phase and calculate the
       
    89      * first step of the method.
       
    90      */
       
    91     public static final int UI_SPECIFY_TO_SOLVE = 13;
       
    92 
       
    93     /**
       
    94      * Leave the specifying phase, enter the solving phase and calculate until a
       
    95      * final result is reached.
       
    96      */
       
    97     public static final int UI_SPECIFY_CALCULATE_ALL = 14;
       
    98 
       
    99     public static final int UI_DUMMY_LAST_SPECIFY = 14;
       
   100 
       
   101     /** ***************** NOTIFICATIONS: SOLVING PHASE ********************** */
       
   102 
       
   103     public static final int UI_DUMMY_FIRST_SOLVE = 21;
       
   104 
       
   105     /**
       
   106      * During the solving phase, calculate one more step.
       
   107      */
       
   108     public static final int UI_SOLVE_CALCULATE_1 = 21;
       
   109 
       
   110     /**
       
   111      * During the solving phase, calculate until a final result is reached.
       
   112      */
       
   113     public static final int UI_SOLVE_CALCULATE_ALL = 22;
       
   114 
       
   115     /**
       
   116      * During the solving phase, calculate until the current subproblem is
       
   117      * solved.
       
   118      */
       
   119     public static final int UI_SOLVE_CALCULATE_SUBPROBLEM = 23;
       
   120 
       
   121     /**
       
   122      * During the solving phase, request editing the currently active formula.
       
   123      * 
       
   124      * WN0412 If request is conceded, do
       
   125      * 
       
   126      * @see UI_SOLVE_EDIT_ACTIVE_FORMULA_COMPLETE
       
   127      */
       
   128     public static final int UI_SOLVE_EDIT_ACTIVE_FORMULA = 24;
       
   129 
       
   130     /**
       
   131      * During the solving phase, notify that editing the currently active
       
   132      * formula is finished. This implies a request for updating the CalcTree.
       
   133      */
       
   134     public static final int UI_SOLVE_EDIT_ACTIVE_FORMULA_COMPLETE = 25;
       
   135 
       
   136     /**
       
   137      * During the solving phase, request inserting a new formula _after_ the
       
   138      * currently active formula, making the new formula the currently active
       
   139      * formula. At present, this does not imply editing the formula and must be
       
   140      * requested in a separate step. WN0412: ...??? is this right interpreted by
       
   141      * ... WN0412 If request is conceded, do
       
   142      * 
       
   143      * @see UI_SOLVE_EDIT_ACTIVE_FORMULA_COMPLETE
       
   144      */
       
   145     public static final int UI_SOLVE_APPEND_USER_FORMULA = 26;
       
   146 
       
   147     /**
       
   148      * During the solving phase, request making the referened formula the
       
   149      * currently active formula.
       
   150      */
       
   151     public static final int UI_SOLVE_MOVE_ACTIVE_FORMULA = 27;
       
   152 
       
   153     /**
       
   154      * During the solving phase, ask for the tactic the math engine would apply
       
   155      * to the current formula.
       
   156      */
       
   157     public static final int UI_SOLVE_GET_PROPOSED_TACTIC = 30;
       
   158 
       
   159     /**
       
   160      * During the solving phase, ask for a list of tactics to the current
       
   161      * formula.
       
   162      */
       
   163     public static final int UI_SOLVE_GET_APPLICABLE_TACTICS = 31;
       
   164 
       
   165     /**
       
   166      * During the solving phase, set the tactic to be applied to the current
       
   167      * formula.
       
   168      */
       
   169     public static final int UI_SOLVE_SET_NEXT_TACTIC = 32;
       
   170 
       
   171     /**
       
   172      * When entering a formula during the solving phase, request help on
       
   173      * entering the formula.
       
   174      */
       
   175     public static final int UI_SOLVE_HELP_ENTERING_FORMULA = 33;
       
   176 
       
   177     /**
       
   178      * During the solving phase, show which assumptions hold at the current
       
   179      * point of calculation.
       
   180      */
       
   181     public static final int UI_SOLVE_SHOW_ASSUMPTIONS = 40;
       
   182 
       
   183     /**
       
   184      * During the solving phase, request more detail about the currently
       
   185      * referenced element.
       
   186      */
       
   187     public static final int UI_SOLVE_SHOW_DETAILS = 41;
       
   188 
       
   189     public static final int UI_DUMMY_LAST_SOLVE = 41;
       
   190 
       
   191     /** ***************** NOTIFICATIONS: unaware of PHASE **************** */
       
   192 
       
   193     public static final int UI_CALCULATE_1 = 101;
       
   194 
       
   195     public static final int UI_CALCULATE_ALL = 102;
       
   196 
       
   197     /** ***************** ACTIVE REQUESTS TO THE UI ********************** */
       
   198 
       
   199     /**
       
   200      * Request editing the currently active formula. DG distinguishes between
       
   201      * SPECIFY and SOLVE; thus could drop UI_SOLVE_EDIT_ACTIVE_FORMULA : int
       
   202      */
       
   203     public static final int UI_DO_EDIT_FORMULA = 129;
       
   204 
       
   205     /**
       
   206      * Request appending a new, empty formula.
       
   207      */
       
   208     public static final int UI_DO_APPEND_FORMULA = 130;
       
   209 
       
   210     /**
       
   211      * Activate an UI element.
       
   212      */
       
   213     public static final int UI_DO_ACTIVATE = 131;
       
   214 
       
   215     /**
       
   216      * Deactivate an UI element.
       
   217      */
       
   218     public static final int UI_DO_DEACTIVATE = 132;
       
   219 
       
   220     /**
       
   221      * The Dialog Guide has detached the listener and will not send any more
       
   222      * control requests. If registered as a Data Change Listener, update
       
   223      * notifications will still arrive!
       
   224      */
       
   225     public static final int UI_DO_DETACH = 133; //WN ??? Design ???
       
   226 }