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