presentation-mode -- Implement presentation mode

[deyan]

See PresentationMode. Meet the following requirements
Implement presentation mode

• The book preview should be opened with F5 key or with View-> Presentation mode
• The book should be opened in preview mode in full screen
• Esc should close the preview mode and return to the last state (preview or edit mode, fullscreen or not)
• Only the page should be shown (and not the frames that go outside of it), zoomed to fit in the display. Additionaly, equal black areas should appear on the left and right or top and bottom. This depends on aspect ratios of the display and book.
• Page down and page up buttons should go to previous/next pages

[deni]

Opening/closing presentation mode

• Add a menu item with accelarator F5
  • New class PresentationItem in org.sophie2.main.app.menus.view package.
  • The menu bar will not be visible in presentation mode, so the accelarator F5 won't be working. Thus, we won't be able to leave presentation mode using it. See the next point for a possible solution.
• Interaction entry in BaseSceneVisual. On pressing F5, a new event BaseSceneVisual.EventIds.TOGGLE_PRESENTATION_MODE should be fired.
• Add two new operations in ViewMenuLogic to handle events from the menu item and SceneVisual's interaction map, respectively. They should call a common static method.
• private static boolean togglePresentationMode(VisualElement source) contains the logic for entering/closing presentation mode.
  • If opening presentation mode:
    • Save the current document, so that it can be restored after closing presentation mode.
    • If the current book is not in preview mode, fire a PreviewModePanel.EventIds.OPEN_PREVIEW to open it in preview.
    • Fire a DefaultMainWindow.EventIds.SET_SCREEN_MODE to set to screen mode to presentation.
    • Calculate the appropriate zoom level and change the book view options.
  • If closing presentation mode:
    • If necessary fire PreviewModePanel.EventIds.CLOSE_PREVIEW to close the window showing the book in preview.
    • If necessary restore the current document (to the one that was current before entering presentation mode).
    • Fire a DefaultMainWindow.EventIds.SET_SCREEN_MODE to return to normal mode.

Hiding some controls in presentation mode

• Menu bar
  • Since MenuBar is in org.sophie2.base.menus and does not know about the MainWindow or MDMainWindow, it cannot compute its visibility based on the window's screen mode.
  • Instead, we can set the visibility of the corresponding JMenuBar in MDFrameWindow and MDAppletWindow.
• Flaps and tabs
  • Override computeVisible() in MDFlap to take into account the screen mode of the parent MDWindow.
  • In MDMainWindow.registerFlap(MDFlap), if the flap is null or invisible, call toolWindowManager().get().unregisterAllToolWindow() to remove all flaps.
• Tab bar
  • Override computeVisible() in TabBar to take into account the screen mode of the parent MainWindow.
• Book panel
  • Override computeVisible() in BookPanel to take into account the screen mode of the current window.
• Book window title bar
  • Add a new setup method to the swingComponen property of MDDocumentWindow to synchronize the visibility of the title bar with the window's screen mode. If in presentation mode, the north pane should be invisible and with zero preferred size. Otherwise - visible and with no preferred size.

Navigation using PageUp and PageDown keys

• Add two new interaction entries in BaseSceneVisual and two new events in BaseSceneVisual.EventIds.
• Add two new operations to hande them in ScenePageLogic.
• This is not yet implemented.

Unresolved issues

• Sometimes, the old book window (the one that is not in preview) is opened in presentation mode. This happens because after creating the preview window and setting it as current, the operation DocumentsLogic.ON_SELECT sets the current document to the old one. I couldn't find where the SELECT event is thrown in these cases.
• In order to close presentation mode, you have to click on the page before pressing F5.

[pap]

• Leaving preview mode should happen by pressing the ESC key. :)
• Probably the presentation mode item should be disabled when not editing a book (for example editing a script :) )
• Menu bar visibility can be computed in AppMenuBar that is not in a base model.
• What about changing the input map instead of adding interaction entries to the SceneVisual?
• Why don't you use the desktop document to show the only book visible in presentation mode? Thus you won't need to play with the titlebar of the JInternalFrame and no signs of an internal frame will be visible as it is now. You could save the state of all document windows and minimize them on entering presentation mode.
• Are you sure that the applet has a menu bar that needs to be hidden.
• Don't use the flapsShown property to determine the visibility of the tabbar! They have different semantics.
• Why do you @Own the mainWindow in MdMainWindow ???
• Not sure, but if you call unregisterAllToolWindows only once for the main window instead of once per flap things may get a bit faster.
• Making the main.app.menus module depend on the main.layout.mydoggy module in unacceptable.
  • As far as I understand you need this to get the size of the screen.
  • If you need such things they should be put in the interfaces/classes of the base.layout.module. This way you will have what you need no matter the layout engine used.
  • What you did totally breaks the idea of all the layou engines.
• I think that the visibility of MD(FLap, Tab, MainWindow, Palette, etc...) should be the same as the visibility of its model(flap, tab, main window, palette). And the latter should be computed for example using the MainWindowOptions. This may even reflect the performance in some cases.
• The event handling in BookPanelLogic regarding open/close preview isn't good I think, but it was so already.
• There are also requirements about changing pages with space key and about making the area around the book black.

[deni]

• Since restoring the previous state of the window will be too difficult (we should keep the previous current document, the previous desktop document, the previous screen mode, whether the book was in preview mode and the zoom level of its book view), a new window in presentation mode will be opened.
• The navigation using pageUp/pageDown will be in two operations that handle InputEventR3.KEY_PRESSED over the BaseSceneVisual. A new class was added for them - NavigationLogic.
• The dependency and own annotation from the design are removed. We will use Toolkit.getScreenSize() instead of the size of the current window.
• A new event was added - QUIT_SCREEN_MODE. It is fired when closing fullscreen and presentation mode and handled in special operacions. The operation for fullscreen mode just sets the screen mode to normal, while the operation for presetation mode closes the current window.

[deni]

• Updated the patch with an improved implementation :-)
• Known issues (maybe should be logged as bugs if the implementation passes as it is now):
  • On Linux, while opening presentation mode, a few other windows appear and disappear. This has something to do with the "Sophie is working label".
  • After dragging to select page elements, the scene visual no longer has focus and navigation through page up/down key is not working.

[deni]

Updated the patch again...

• Before showing the "Sophie is working" label, check whether its parent window is visible. This should solve the problem with the several windows appearing and disappearing on opening presentation mode.
• After dragging to select elements, the scene visual should request the focus.
• Added navigation using the arrow keys and space in presentation mode.
• Navigation using PageUp and PageDown keys now works in normal mode, too. However if the focus is in a palette or menu, it won't work.

[pap]

• Committed in [9235].
• BaseLayoutModule.showDefaultEngine - first the name is bad and second if the default provider changes the default engine will not. The method should be a bit smarter. Otherwise it is good. :)

[meddle]

Closing all the tickets before M Y1