| 26 | | * The code for every part of the UI should be reviewed. |
| | 11 | * Define the parts of the UI that need to be refactored. |
| | 12 | * Create wiki content with the problem areas of the UI parts. |
| | 13 | * Provide dependency relations between parts, so that they are refactored in proper order. |
| | 14 | * Link the tickets that will contain the actual refactoring. |
| | 15 | |
| | 16 | == Task result == |
| | 17 | * wiki content |
| | 18 | |
| | 19 | == Implementation idea == |
| | 20 | * Review source code. |
| | 21 | * Discuss with other team members known problem areas. |
| | 22 | |
| | 23 | == Related == |
| | 24 | * '''Only the most important things:''' |
| | 25 | * [wiki:APP_LAYOUT_MYDOGGY_R0] |
| | 26 | * [wiki:READER_PAGE_WORK_AREA_R0] |
| | 27 | * [wiki:AUTHOR_PAGE_WORK_AREA_R0] |
| | 28 | * [wiki:GROUP_BASE_HALOS_AND_FRAME_POSITION_R1], [wiki:BASE_HALOS_R0], [wiki:BASE_HALOS_R1] |
| | 29 | * [wiki:BASE_BOUND_CONTROLS_R1], [wiki:BASE_BOUND_CONTROLS_R0] |
| | 30 | * [wiki:BASE_DIALOGS_R0], [wiki:APP_FILE_DIALOGS_R0] |
| | 31 | * [wiki:APP_COLOR_PICKER_R0] |
| | 32 | * [wiki:GROUP_BASE_SKINS_R0] |
| | 33 | |
| | 34 | == How to demo == |
| | 35 | * Explain what are the things to be refactored and the dependencies between them. |
| | 36 | |
| | 37 | = Design = |
| | 38 | |
| | 39 | * Parts of the UI are listed bellow: |
| | 40 | * Layout |
| | 41 | * Halos |
| | 42 | * Menus |
| | 43 | * Buttons |
| | 44 | * Huds |
| | 45 | * Bound controls |
| | 46 | * Dialogs |
| | 47 | * Menus |
| | 48 | * Skins |
| | 49 | * Skin manager |
| | 50 | * BookView hierarchy |
| | 51 | * Non-categorized - things that are connected with more than one part of the UI. |
| | 52 | |
| | 53 | |
| | 54 | = Implementation = |
| | 55 | * The code for every part of the UI should be reviewed. |
| 64 | | * BoundColorPicker is not in the proper model - it should be independent of "...base.halos" (currently it depends on HudDialog and base bound things and cannot be put in the "...base.bound..." module). |
| 65 | | * Create diagrams of new designs if they appear to be complicated. |
| 66 | | |
| 67 | | |
| 68 | | == Task result == |
| 69 | | * Source code |
| 70 | | * Diagrams |
| 71 | | |
| 72 | | == Implementation idea == |
| 73 | | * Most of the ideas are already mentioned in some way or another in the requirements section. |
| 74 | | |
| 75 | | == Related == |
| 76 | | * '''Only the most important things:''' |
| 77 | | * [wiki:APP_LAYOUT_MYDOGGY_R0] |
| 78 | | * [wiki:READER_PAGE_WORK_AREA_R0] |
| 79 | | * [wiki:AUTHOR_PAGE_WORK_AREA_R0] |
| 80 | | * [wiki:GROUP_BASE_HALOS_AND_FRAME_POSITION_R1], [wiki:BASE_HALOS_R0], [wiki:BASE_HALOS_R1] |
| 81 | | * [wiki:BASE_BOUND_CONTROLS_R1], [wiki:BASE_BOUND_CONTROLS_R0] |
| 82 | | * [wiki:BASE_DIALOGS_R0], [wiki:APP_FILE_DIALOGS_R0] |
| 83 | | * [wiki:APP_COLOR_PICKER_R0] |
| 84 | | * [wiki:GROUP_BASE_SKINS_R0] |
| 85 | | |
| 86 | | == How to demo == |
| 87 | | * Open sophie and start explaining the new things that are improved. There are a lot of things and a simple how to demo cannot be defined. |
| 88 | | |
| 89 | | = Design = |
| 90 | | |
| 91 | | * Layout |
| 92 | | |
| 93 | | |
| 94 | | * Halos |
| 95 | | |
| 96 | | * Bound Controls |
| 97 | | * bugs |
| 98 | | * new bound controls |
| 99 | | * BookView hierarchy |
| 100 | | |
| 101 | | * Logics - AppLogic, BookLogic, PageLogic, FrameLogic -> LogicR3 |
| 102 | | |
| 103 | | * Menus |
| 104 | | * divide into modules |
| 105 | | |
| 106 | | * Dialogs |
| 107 | | |
| 108 | | * Skins |
| 109 | | |
| 110 | | |
| 111 | | * All interaction should go through the LogicR3 using EventR3. (This is refactoring of the old Logics). |
| 112 | | * When refactoring the code, have in mind that we need to have a sinle-document-interface for the workarea (preview mode, presentation mode etc.). So when redesigning we should implement such functionality. |
| 113 | | * Along with the Workspace and Layout consider having two separate windows for Author and Reader (one having all flaps and desktop book and one without these). |
| 114 | | * Halos - things there seem to be alright for the time being. A refactoring has already been made (see [wiki:GROUP_BASE_HALOS_AND_FRAME_POSITION_R1] for more details, where the menus were refactored.) |
| 115 | | |
| 116 | | * '''Bound Controls''': |
| 117 | | * The wiki page for this task -> [wiki:BASE_BOUND_CONTROLS_R1] |
| 118 | | * What should be refactored: |
| 119 | | * Fixing some bugs: |
| 120 | | * Implementations of bound controls using JTextField have a bug connected with the listeners attached to the text field. |
| 121 | | * Fixed a bug with zoom percentage combobox - When you enter any text (no matter digits or other symbols) and click somewhere else so the combobox loses focus a ClassCastException was thrown. The reason was that ComboInput used in ZoomPercentagePanel.validate() and ZoomPercentagePanel.submitData() should be of type ZoomLevel but in some cases it was of type String. The problem was fixed by adding a check for the type of ComboInput.getLevel(). Another problem came up with the separator used in float numbers. In the combobox was used ',' but it was impossible enter a valid float number using ',', only '.' was aloowed. The problem was fixed by replacing all ',' in the original string with '.'. This change remains invisible for the user as the text entered i nthe combobox doesn't change visually. This change takes palce in dataInputControlMethod(), which belongs to the base class for all bound comboboxes. So in order the change to be made only in Zoom Percenatage combox (we don't want to replace ',' with '.' in all comboboxes), this method was overriden in ZoomPercentagePanel class. |
| 122 | | * BoundCheckBox - a problem connected with Boolean.TRUE/Boolean.FALSE - does not update state properly with the pro lib. |
| 123 | | * Fix the layout of the components in the bound control.[[BR]] |
| 124 | | * Change the hierarchy so that the icon of the state can be dropped (controls should be able to chose whether with such an icon or without it).[[BR]] |
| 125 | | * Create new bound controls: |
| 126 | | * The "bound control" looking panel that most huds use for changing colors is not an actual bounds control. Create such a control: |
| 127 | | * The listener should be attached not to the whole panel, but rather to the color rectangle which may become a "ButtonBoundControl". |
| 128 | | * Introduce a "SliderBoundControl" that has a JSlider bound to some model.[[BR]] |
| 129 | | |
| 130 | | |
| 131 | | * '''Menus''' |
| 132 | | * The wiki page for this task -> [wiki:BASE_MENUS_R1] |
| 133 | | * All menus and menu items are in the same module. Every menu/menu item should be in a module that is responding to its functionality. |
| 134 | | * '''Dialogs''' |
| 135 | | * The wiki page for this task -> [wiki:BASE_DIALOGS_R1] |
| 136 | | * Color Picker - the color picker is already a bound to the model. |
| 137 | | * There is a bug with the gradient dialog - clicking the color button breaks Sophie2. Fix it. Consider redesigning the gradient in a similar way to the color picker. Nevertheless the gradient changing component should be bound to the model as all controls in Sophie2 are. |
| 138 | | * Skins - the new skin Sophie2 should be integrated. Icons are ready. Use tool-tips from the default skin. |
| 139 | | * Icons - inconsistent icons of all skins should be fixed. This means that no icons should be used from the fall-back skin, since icons in skins differ a lot for different skins and sophie looks ugly with different icon styles. |
| 140 | | * Tool-tips - Tool-tips of the default skin a OK. Tool-tips of the alternative skin however should be fixed since not all components have an alternative skin tool-tip defined. |
| 141 | | * Component titles - Same as tool-tips. |
| 142 | | * Make all code connected with UI consistent with the new model and resources (this is something that depends on new resources and model). |
| 143 | | * Create diagrams of new designs if they appear to be complicated. |
| 144 | | * Changesets: |
| 145 | | * [4303] - bugfix of the bound controls. |
| 146 | | * [4334] - bugfix of mydoggy library (LookAndFeel stuff). |
| 147 | | |
| 148 | | = Implementation = |
| 149 | | ^(Describe and link the implementation results here (from the wiki or the repository).)^ |
| | 93 | * There is a bug with the gradient dialog - clicking the color button breaks Sophie2. Fix it. Consider redesigning the gradient in a similar way to the color picker. Nevertheless the gradient changing component should be bound to the model as all controls in Sophie2 are. |
| | 94 | * '''Menus:''' |
| | 95 | * Divide into modules by functionality. |
| | 96 | * Every menu item should fire an event through the LogicR3. |
