src/java/isac/wsdialog/IUIElement.java
branchjava_rename_format
changeset 3922 fcd5648113ca
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/src/java/isac/wsdialog/IUIElement.java	Wed Jun 15 18:31:02 2005 +0200
     1.3 @@ -0,0 +1,226 @@
     1.4 +/*
     1.5 + * Created on Dec 12, 2003
     1.6 + */
     1.7 +package isac.wsdialog;
     1.8 +
     1.9 +/**
    1.10 + * @author Alan Krempler
    1.11 + * 
    1.12 + * Constants describing interactions or request from the user
    1.13 + */
    1.14 +public interface IUIElement {
    1.15 +
    1.16 +    /** ***************** NOTIFICATIONS: SPECIFYING PHASE ********************** */
    1.17 +
    1.18 +    public static final int UI_DUMMY_FIRST_SPECIFY = 1;
    1.19 +
    1.20 +    /**
    1.21 +     * get descriptions into all items of a model; these give hints for input to
    1.22 +     * the user
    1.23 +     */
    1.24 +    public static final int UI_SPECIFY_GET_DESCRIPTIONS = 2;
    1.25 +
    1.26 +    /**
    1.27 +     * During the specifying phase, try to match a problem type to the data
    1.28 +     * entered so far WN //// ?items of the model entered so far
    1.29 +     */
    1.30 +    public static final int UI_SPECIFY_TRY_MATCH = 2;
    1.31 +
    1.32 +    /**
    1.33 +     * During the specifying phase, try to refine the problem type. WN ////
    1.34 +     */
    1.35 +    public static final int UI_SPECIFY_TRY_REFINE = 3;
    1.36 +
    1.37 +    /**
    1.38 +     * During the specifying phase, change the view on the CalcHead.
    1.39 +     */
    1.40 +    public static final int UI_SPECIFY_CHANGE_VIEW = 4;
    1.41 +
    1.42 +    /**
    1.43 +     * During the specifying phase, have the CalcHead completed by the math
    1.44 +     * engine.
    1.45 +     */
    1.46 +    public static final int UI_SPECIFY_COMPLETE_CALCHEAD = 5;
    1.47 +
    1.48 +    /**
    1.49 +     * During the specifying phase, have the Method field of the CalcHead
    1.50 +     * completed by the math engine.
    1.51 +     */
    1.52 +    public static final int UI_SPECIFY_COMPLETE_METHOD = 6;
    1.53 +
    1.54 +    /**
    1.55 +     * During the specifying phase, have the Theory field of the CalcHead
    1.56 +     * completed by the math engine.
    1.57 +     */
    1.58 +    public static final int UI_SPECIFY_COMPLETE_THEORY = 7;
    1.59 +
    1.60 +    /**
    1.61 +     * During the specifying phase, have the Problem field of the CalcHead
    1.62 +     * completed by the math engine.
    1.63 +     */
    1.64 +    public static final int UI_SPECIFY_COMPLETE_PROBLEM = 8;
    1.65 +
    1.66 +    /**
    1.67 +     * During the specifying phase, have the Given field of the CalcHead
    1.68 +     * completed by the math engine.
    1.69 +     */
    1.70 +    public static final int UI_SPECIFY_COMPLETE_GIVEN = 9;
    1.71 +
    1.72 +    /**
    1.73 +     * During the specifying phase, have the Find field of the CalcHead
    1.74 +     * completed by the math engine.
    1.75 +     */
    1.76 +    public static final int UI_SPECIFY_COMPLETE_FIND = 10;
    1.77 +
    1.78 +    /**
    1.79 +     * During the specifying phase, have the Relate field of the CalcHead
    1.80 +     * completed by the math engine.
    1.81 +     */
    1.82 +    public static final int UI_SPECIFY_COMPLETE_RELATE = 11;
    1.83 +
    1.84 +    /**
    1.85 +     * During the specifying phase, have the CalcHead checked for completeness
    1.86 +     * and consistency.
    1.87 +     */
    1.88 +    public static final int UI_SPECIFY_CHECK_CALCHEAD = 12;
    1.89 +
    1.90 +    /**
    1.91 +     * Leave the specifying phase, enter the solving phase and calculate the
    1.92 +     * first step of the method.
    1.93 +     */
    1.94 +    public static final int UI_SPECIFY_TO_SOLVE = 13;
    1.95 +
    1.96 +    /**
    1.97 +     * Leave the specifying phase, enter the solving phase and calculate until a
    1.98 +     * final result is reached.
    1.99 +     */
   1.100 +    public static final int UI_SPECIFY_CALCULATE_ALL = 14;
   1.101 +
   1.102 +    public static final int UI_DUMMY_LAST_SPECIFY = 14;
   1.103 +
   1.104 +    /** ***************** NOTIFICATIONS: SOLVING PHASE ********************** */
   1.105 +
   1.106 +    public static final int UI_DUMMY_FIRST_SOLVE = 21;
   1.107 +
   1.108 +    /**
   1.109 +     * During the solving phase, calculate one more step.
   1.110 +     */
   1.111 +    public static final int UI_SOLVE_CALCULATE_1 = 21;
   1.112 +
   1.113 +    /**
   1.114 +     * During the solving phase, calculate until a final result is reached.
   1.115 +     */
   1.116 +    public static final int UI_SOLVE_CALCULATE_ALL = 22;
   1.117 +
   1.118 +    /**
   1.119 +     * During the solving phase, calculate until the current subproblem is
   1.120 +     * solved.
   1.121 +     */
   1.122 +    public static final int UI_SOLVE_CALCULATE_SUBPROBLEM = 23;
   1.123 +
   1.124 +    /**
   1.125 +     * During the solving phase, request editing the currently active formula.
   1.126 +     * 
   1.127 +     * WN0412 If request is conceded, do
   1.128 +     * 
   1.129 +     * @see UI_SOLVE_EDIT_ACTIVE_FORMULA_COMPLETE
   1.130 +     */
   1.131 +    public static final int UI_SOLVE_EDIT_ACTIVE_FORMULA = 24;
   1.132 +
   1.133 +    /**
   1.134 +     * During the solving phase, notify that editing the currently active
   1.135 +     * formula is finished. This implies a request for updating the CalcTree.
   1.136 +     */
   1.137 +    public static final int UI_SOLVE_EDIT_ACTIVE_FORMULA_COMPLETE = 25;
   1.138 +
   1.139 +    /**
   1.140 +     * During the solving phase, request inserting a new formula _after_ the
   1.141 +     * currently active formula, making the new formula the currently active
   1.142 +     * formula. At present, this does not imply editing the formula and must be
   1.143 +     * requested in a separate step. WN0412: ...??? is this right interpreted by
   1.144 +     * ... WN0412 If request is conceded, do
   1.145 +     * 
   1.146 +     * @see UI_SOLVE_EDIT_ACTIVE_FORMULA_COMPLETE
   1.147 +     */
   1.148 +    public static final int UI_SOLVE_APPEND_USER_FORMULA = 26;
   1.149 +
   1.150 +    /**
   1.151 +     * During the solving phase, request making the referened formula the
   1.152 +     * currently active formula.
   1.153 +     */
   1.154 +    public static final int UI_SOLVE_MOVE_ACTIVE_FORMULA = 27;
   1.155 +
   1.156 +    /**
   1.157 +     * During the solving phase, ask for the tactic the math engine would apply
   1.158 +     * to the current formula.
   1.159 +     */
   1.160 +    public static final int UI_SOLVE_GET_PROPOSED_TACTIC = 30;
   1.161 +
   1.162 +    /**
   1.163 +     * During the solving phase, ask for a list of tactics to the current
   1.164 +     * formula.
   1.165 +     */
   1.166 +    public static final int UI_SOLVE_GET_APPLICABLE_TACTICS = 31;
   1.167 +
   1.168 +    /**
   1.169 +     * During the solving phase, set the tactic to be applied to the current
   1.170 +     * formula.
   1.171 +     */
   1.172 +    public static final int UI_SOLVE_SET_NEXT_TACTIC = 32;
   1.173 +
   1.174 +    /**
   1.175 +     * When entering a formula during the solving phase, request help on
   1.176 +     * entering the formula.
   1.177 +     */
   1.178 +    public static final int UI_SOLVE_HELP_ENTERING_FORMULA = 33;
   1.179 +
   1.180 +    /**
   1.181 +     * During the solving phase, show which assumptions hold at the current
   1.182 +     * point of calculation.
   1.183 +     */
   1.184 +    public static final int UI_SOLVE_SHOW_ASSUMPTIONS = 40;
   1.185 +
   1.186 +    /**
   1.187 +     * During the solving phase, request more detail about the currently
   1.188 +     * referenced element.
   1.189 +     */
   1.190 +    public static final int UI_SOLVE_SHOW_DETAILS = 41;
   1.191 +
   1.192 +    public static final int UI_DUMMY_LAST_SOLVE = 41;
   1.193 +
   1.194 +    /** ***************** NOTIFICATIONS: unaware of PHASE **************** */
   1.195 +
   1.196 +    public static final int UI_CALCULATE_1 = 101;
   1.197 +
   1.198 +    public static final int UI_CALCULATE_ALL = 102;
   1.199 +
   1.200 +    /** ***************** ACTIVE REQUESTS TO THE UI ********************** */
   1.201 +
   1.202 +    /**
   1.203 +     * Request editing the currently active formula. DG distinguishes between
   1.204 +     * SPECIFY and SOLVE; thus could drop UI_SOLVE_EDIT_ACTIVE_FORMULA : int
   1.205 +     */
   1.206 +    public static final int UI_DO_EDIT_FORMULA = 129;
   1.207 +
   1.208 +    /**
   1.209 +     * Request appending a new, empty formula.
   1.210 +     */
   1.211 +    public static final int UI_DO_APPEND_FORMULA = 130;
   1.212 +
   1.213 +    /**
   1.214 +     * Activate an UI element.
   1.215 +     */
   1.216 +    public static final int UI_DO_ACTIVATE = 131;
   1.217 +
   1.218 +    /**
   1.219 +     * Deactivate an UI element.
   1.220 +     */
   1.221 +    public static final int UI_DO_DEACTIVATE = 132;
   1.222 +
   1.223 +    /**
   1.224 +     * The Dialog Guide has detached the listener and will not send any more
   1.225 +     * control requests. If registered as a Data Change Listener, update
   1.226 +     * notifications will still arrive!
   1.227 +     */
   1.228 +    public static final int UI_DO_DETACH = 133; //WN ??? Design ???
   1.229 +}
   1.230 \ No newline at end of file