Module: alfresco/core/FullScreenMixin

alfresco/core/FullScreenMixin

This module can be mixed into any other widget that has a requirement to make it's DOM element either full-screen or full-window. However, rather than making the actual DOM element full screen or window it actually maximises the size of the DOM element so that it fills the window and then the document body is made full screen (or window). This is done so that any popups or dialogs that are placed outside of the target element will still be displayed.
Author:
  • Dave Draper
Copyright:
  • Copyright (C) 2005-2020 Alfresco Software Limited
License:
Source:

Members

cssRequirements :object[]

An array of the CSS files to use with this widget.
Type:
  • object[]
Default Value:
  • [{cssFile:"./css/FullScreenMixin.css"}]
Source:

fullScreenTopic :string

The topic to publish on to toggle full screen mode.
Type:
  • string
Default Value:
  • "ALF_FULL_SCREEN"
Source:

fullWindowTopic :string

The topic to publish on to toggle full window mode.
Type:
  • string
Default Value:
  • "ALF_FULL_WINDOW"
Source:

isWindowOnly :boolean

The current full screen mode
Type:
  • boolean
Default Value:
  • true
Source:

Methods

cancelFullScreen()

Exits full-screen mode for the current context element
Source:

onFullScreenChange()

Handles changes to the full screen mode
Source:

onFullScreenEnterComplete()

This function is called when entering fullscreen mode. It should be overridden by mixing modules if they need to perform some post processing.
Source:

onFullScreenExitComplete()

This function is called when exiting fullscreen mode. It should be overridden by mixing modules if they need to perform some post processing.
Source:

onKeyUp(evt)

This function is called when a key is pressed in full screen or full window mode. If the key that has been pressed happens to be the ESCAPE key then the current mode is exited.
Parameters:
Name Type Description
evt object The key up event
Source:

requestFullScreen(isWindowOnly)

Enters full-screen mode for the current context element
Parameters:
Name Type Description
isWindowOnly boolean Indicates whether to make the element the size of the window
Source:

toggleFullScreen()

Toggles full-screen mode for the current context element
Source:

toggleFullWindow(enable)

Toggles full-window mode for the current context element for browsers that don't support full-screen or explicit setting of params.isWindowOnly=true.
Parameters:
Name Type Description
enable boolean Whether to enable the mode
Source: