Class: MenubarActions

MenubarActions

The action on the menu bar. This is a singleton.
Source:

Methods

activatePromptOnRefresh()

Should promptonrefresh be displayed or not this is determined by the global HASPROMPTS variable
Source:

applyZoom(contentWrapperInner, content)

Apply current zoom to inner Pages
Parameters:
Name Type Description
contentWrapperInner object document element of the inner content wrapper
content object document element of the content
Source:

assurePageIsPresent(page, fragment, finalFunction)

Make sure that the addressed page is present in the DOM
Parameters:
Name Type Description
page number number of page
fragment string URL fragement
finalFunction function function to call if page is loaded
Source:

createInnerContentWrapper(contentWrapperInnerNumber) → {object}

Create an inner Container that may contain the body
Parameters:
Name Type Description
contentWrapperInnerNumber number the number of the inner content wrapper to create
Source:
Returns:
the DOM element
Type
object

endlessMode(override, finishFunction)

Enable endless page mode - this could be a huge performance hit for long reports
Parameters:
Name Type Description
override boolean true to reset the report though single page mode is already the current mode
finishFunction function what to do when done loading the first page
Source:

firstPage(finishFunction, fragment)

Go to first Page
Parameters:
Name Type Description
finishFunction function Function when the page has loaded
fragment string (optional) a fragment to jump to after being done.
Source:

getCurrentPageName(contentWrapperInnerNumber, prefix) → {string}

Returns the page - element which is currently active, e.g. for loading
Parameters:
Name Type Description
contentWrapperInnerNumber number Number of content wrapper to generate name for
prefix string Name prefix
Source:
Returns:
name of the page for parameters
Type
string

getCurrentTab() → {object}

Retursn the currenly active tab
Source:
Returns:
the tab or null
Type
object

lastPage(finishFunction, fragment)

Go to last Page
Parameters:
Name Type Description
finishFunction function Function when the page has loaded
fragment string (optional) a fragment to jump to after being done.
Source:

loadEndlessPage(finishFunction)

Endlessly load pages until all are found and in the DOM
Parameters:
Name Type Description
finishFunction function function to execute when all have been loaded
Source:

nextPage(finishFunction, fragment)

Go to next Page
Parameters:
Name Type Description
finishFunction function Function when the page has loaded
fragment string (optional) a fragment to jump to after being done.
Source:

openSubreport(link, finishFunction)

Open a subreport denoted by the link
Parameters:
Name Type Description
link object subreport link
finishFunction function Function to call when the subreport is open
Source:

optimalHeight() → {number}

Calculates the optimal height of the current tab so that the page is fully visible
Source:
Returns:
height in pixel
Type
number

optimalWidth() → {number}

Calculates the optimal width of the current tab so that the page is fully visible
Source:
Returns:
width in pixel
Type
number

previousPage(finishFunction, fragment)

Go to previous Page
Parameters:
Name Type Description
finishFunction function Function when the page has loaded
fragment string (optional) a fragment to jump to after being done.
Source:

printReport()

Print the report using our printListener if it is available or use the window.print() function otherwise
Source:

promptonrefresh()

Is it active? Determined by the global PROMPTONREFRESH variable
Source:

refreshReport(resetGroupTree, finishFunction)

Resets the grouptree, closes all popups and loads the page again
Parameters:
Name Type Description
resetGroupTree boolean full reset?
finishFunction function function when done loading the page
Source:

reloadReport()

Reload a report. reset prompts if needed
Source:

resetReportPages()

Clean the content wrappers, full reset of the report pages
Source:

setPage(page, fragment, finalFunction)

Set the page and update loading status
Parameters:
Name Type Description
page number number of page
fragment string URL fragement
finalFunction function function to call if page is loaded
Source:

setPagingButtonStatus(currentPage)

Set the paging button status. Will disable if needed
Parameters:
Name Type Description
currentPage number the page that is currently set
Source:

setSafeZoom(zoom, event)

Set a specific zoom value, make sure the width/height is OK
Parameters:
Name Type Description
zoom string | number number in percent, optionally with '%' or a specific string value
event Event An event that triggered the change. may be null. can be used to determine the center point
Source:

setZoom(zoom, event)

Set a specific zoom value
Parameters:
Name Type Description
zoom string | number number in percent, optionally with '%' or a specific string value
event Event An event that triggered the change. may be null. can be used to determine the center point
Source:

singlePage(override, finishFunction)

Enable single page mode
Parameters:
Name Type Description
override boolean true to reset the report though single page mode is already the current mode
finishFunction function what to do when done loading the first page
Source:

updatePageStatus(newPage)

To be implemented, where needed
Parameters:
Name Type Description
newPage object the page
Source:

updatePermissions(the)

Update the permissions-based buttons
Parameters:
Name Type Description
the object page permissions
Source:

updateZoom(zoom, event)

Save zoom to storage and update the UI
Parameters:
Name Type Description
zoom number | string the zoom to set
event Event An event that triggered the change. may be null.
Source:

zoom(change, event)

Do a zoom depending on current value and input.
Parameters:
Name Type Description
change number New zoom
event Event An event that triggered the change. may be null.
Source:

zoomIn()

Zoom further in
Source:

zoomOut()

Zoom out
Source:

(inner) zoomAfterAction()

After the actual zoom is executed we need to update some of the view
Source:

(inner) zoomBeforeAction()

Before the actual zoom is executed we need to prepare some data
Source: