jf-roku/docs/api/components_data_SceneManager.brs.html

473 lines
149 KiB
HTML
Raw Normal View History

2023-10-06 03:18:36 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
components/data/SceneManager.brs - Documentation
</title>
<link href="https://www.braintreepayments.com/images/favicon-ccda0b14.png" rel="icon" type="image/png">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.7.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.0/jquery.min.js"></script>
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
<!-- start Mixpanel -->
<script type="text/javascript">(function(e,a){if(!a.__SV){var b=window;try{var c,l,i,j=b.location,g=j.hash;c=function(a,b){return(l=a.match(RegExp(b+"=([^&]*)")))?l[1]:null};g&&c(g,"state")&&(i=JSON.parse(decodeURIComponent(c(g,"state"))),"mpeditor"===i.action&&(b.sessionStorage.setItem("_mpcehash",g),history.replaceState(i.desiredHash||"",e.title,j.pathname+j.search)))}catch(m){}var k,h;window.mixpanel=a;a._i=[];a.init=function(b,c,f){function e(b,a){var c=a.split(".");2==c.length&&(b=b[c[0]],a=c[1]);b[a]=function(){b.push([a].concat(Array.prototype.slice.call(arguments,
0)))}}var d=a;"undefined"!==typeof f?d=a[f]=[]:f="mixpanel";d.people=d.people||[];d.toString=function(b){var a="mixpanel";"mixpanel"!==f&&(a+="."+f);b||(a+=" (stub)");return a};d.people.toString=function(){return d.toString(1)+".people (stub)"};k="disable time_event track track_pageview track_links track_forms register register_once alias unregister identify name_tag set_config reset people.set people.set_once people.increment people.append people.union people.track_charge people.clear_charges people.delete_user".split(" ");
for(h=0;h<k.length;h++)e(d,k[h]);a._i.push([b,c,f])};a.__SV=1.2;b=e.createElement("script");b.type="text/javascript";b.async=!0;b.src="undefined"!==typeof MIXPANEL_CUSTOM_LIB_URL?MIXPANEL_CUSTOM_LIB_URL:"file:"===e.location.protocol&&"//cdn.mxpnl.com/libs/mixpanel-2-latest.min.js".match(/^\/\//)?"https://cdn.mxpnl.com/libs/mixpanel-2-latest.min.js":"//cdn.mxpnl.com/libs/mixpanel-2-latest.min.js";c=e.getElementsByTagName("script")[0];c.parentNode.insertBefore(b,c)}})(document,window.mixpanel||[]);
mixpanel.init("1919205b2da72e4da3b9b6639b444d59");</script>
<!-- end Mixpanel -->
</head>
<body>
<svg style="display: none;">
<defs>
<symbol id="linkIcon" fill="#706d77" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg">
<path d="M0 0h24v24H0z" fill="none"/>
<path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7c-2.76 0-5 2.24-5 5s2.24 5 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1zM8 13h8v-2H8v2zm9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1s-1.39 3.1-3.1 3.1h-4V17h4c2.76 0 5-2.24 5-5s-2.24-5-5-5z"/>
</symbol>
</defs>
</svg>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<div class="top-nav-wrapper">
<ul>
<li >
<a href="index.html">
<svg fill="#6D6D6D" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg">
<path d="M10 20v-6h4v6h5v-8h3L12 3 2 12h3v8z"/>
<path d="M0 0h24v24H0z" fill="none"/>
</svg>
</a>
</li>
</ul>
</div>
<nav>
<h3 class="reference-title">
Braintree SDK Client Reference
</h3>
<h3>Classes</h3><ul><li id="Logger-nav"><a href="module-log.Logger.html">Logger</a><ul class='methods'><li data-type="method" id="Logger-debug-nav"><a href="module-log.Logger.html#debug">debug</a></li><li data-type="method" id="Logger-decreaseIndent-nav"><a href="module-log.Logger.html#decreaseIndent">decreaseIndent</a></li><li data-type="method" id="Logger-error-nav"><a href="module-log.Logger.html#error">error</a></li><li data-type="method" id="Logger-increaseIndent-nav"><a href="module-log.Logger.html#increaseIndent">increaseIndent</a></li><li data-type="method" id="Logger-info-nav"><a href="module-log.Logger.html#info">info</a></li><li data-type="method" id="Logger-log-nav"><a href="module-log.Logger.html#log">log</a></li><li data-type="method" id="Logger-method-nav"><a href="module-log.Logger.html#method">method</a></li><li data-type="method" id="Logger-resetIndent-nav"><a href="module-log.Logger.html#resetIndent">resetIndent</a></li><li data-type="method" id="Logger-toString-nav"><a href="module-log.Logger.html#toString">toString</a></li><li data-type="method" id="Logger-verbose-nav"><a href="module-log.Logger.html#verbose">verbose</a></li><li data-type="method" id="Logger-warn-nav"><a href="module-log.Logger.html#warn">warn</a></li></ul></li></ul><h3>Modules</h3><ul><li id="AlbumData-nav"><a href="module-AlbumData.html">AlbumData</a><ul class='methods'><li data-type="method" id="AlbumData-setFields-nav"><a href="module-AlbumData.html#.setFields">setFields</a></li></ul></li><li id="AlbumGrid-nav"><a href="module-AlbumGrid.html">AlbumGrid</a><ul class='methods'><li data-type="method" id="AlbumGrid-getData-nav"><a href="module-AlbumGrid.html#.getData">getData</a></li><li data-type="method" id="AlbumGrid-init-nav"><a href="module-AlbumGrid.html#.init">init</a></li><li data-type="method" id="AlbumGrid-onKeyEvent-nav"><a href="module-AlbumGrid.html#.onKeyEvent">onKeyEvent</a></li></ul></li><li id="AlbumTrackList-nav"><a href="module-AlbumTrackList.html">AlbumTrackList</a><ul class='methods'><li data-type="method" id="AlbumTrackList-getData-nav"><a href="module-AlbumTrackList.html#.getData">getData</a></li><li data-type="method" id="AlbumTrackList-init-nav"><a href="module-AlbumTrackList.html#.init">init</a></li></ul></li><li id="AlbumView-nav"><a href="module-AlbumView.html">AlbumView</a><ul class='methods'><li data-type="method" id="AlbumView-OnScreenHidden-nav"><a href="module-AlbumView.html#.OnScreenHidden">OnScreenHidden</a></li><li data-type="method" id="AlbumView-adjustScreenForNoOverview-nav"><a href="module-AlbumView.html#.adjustScreenForNoOverview">adjustScreenForNoOverview</a></li><li data-type="method" id="AlbumView-createDialogPallete-nav"><a href="module-AlbumView.html#.createDialogPallete">createDialogPallete</a></li><li data-type="method" id="AlbumView-createFullDscrDlg-nav"><a href="module-AlbumView.html#.createFullDscrDlg">createFullDscrDlg</a></li><li data-type="method" id="AlbumView-init-nav"><a href="module-AlbumView.html#.init">init</a></li><li data-type="method" id="AlbumView-onDoneLoading-nav"><a href="module-AlbumView.html#.onDoneLoading">onDoneLoading</a></li><li data-type="method" id="AlbumView-onKeyEvent-nav"><a href="module-AlbumView.html#.onKeyEvent">onKeyEvent</a></li><li data-type="method" id="AlbumView-pageContentChanged-nav"><a href="module-AlbumView.html#.pageContentChanged">pageContentChanged</a></li><li data-type="method" id="AlbumView-setOnScreenTextValues-nav"><a href="module-AlbumView.html#.setOnScreenTextValues">setOnScreenTextValues</a></li><li data-type="method" id="AlbumView-setPosterImage-nav"><a href="module-AlbumView.html#.setPosterImage">setPosterImage</a></li><li data-type="method" id="AlbumView-setScreenTitle-nav"><a href="module-AlbumView.html#.setScreenTitle">setScreenTitle</a></li><li data-type="method" id="AlbumView-setupMainNode-nav"><a href="module-AlbumView.html#.setupMainNode">setupMainNode</a></li></ul></li><li id="Alpha-nav"><a href="module-Alpha.html">Alpha</a><ul class='methods'><li data-type="method" id="Alpha-init-nav"><a href="module-Alpha.html#.init">
</nav>
<div id="main">
<h1 class="page-title">
components/data/SceneManager.brs
</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>import "pkg:/source/roku_modules/log/LogMixin.brs"
sub init()
m.log = log.Logger("SceneManager")
m.groups = []
m.scene = m.top.getScene()
m.content = m.scene.findNode("content")
m.overhang = m.scene.findNode("overhang")
end sub
'
' Push a new group onto the stack, replacing the existing group on the screen
sub pushScene(newGroup)
currentGroup = m.groups.peek()
if newGroup &lt;> invalid
if currentGroup &lt;> invalid
'Search through group and store off last focused item
if currentGroup.focusedChild &lt;> invalid
focused = currentGroup.focusedChild
while focused.hasFocus() = false
focused = focused.focusedChild
end while
currentGroup.lastFocus = focused
currentGroup.setFocus(false)
else
currentGroup.setFocus(false)
end if
if currentGroup.isSubType("JFGroup")
unregisterOverhangData(currentGroup)
end if
currentGroup.visible = false
if currentGroup.isSubType("JFScreen")
currentGroup.callFunc("OnScreenHidden")
end if
end if
m.groups.push(newGroup)
if currentGroup &lt;> invalid
m.content.replaceChild(newGroup, 0)
else
m.content.appendChild(newGroup)
end if
if newGroup.isSubType("JFScreen")
newGroup.callFunc("OnScreenShown")
end if
'observe info about new group, set overhang title, etc.
if newGroup.isSubType("JFGroup")
registerOverhangData(newGroup)
' Some groups set focus to a specific component within init(), so we don't want to
' change if that is the case.
if newGroup.isInFocusChain() = false
newGroup.setFocus(true)
end if
else if newGroup.isSubType("JFVideo")
newGroup.setFocus(true)
newGroup.control = "play"
m.overhang.visible = false
end if
else
currentGroup.focusedChild.setFocus(true)
end if
end sub
'
' Remove the current group and load the last group from the stack
sub popScene()
group = m.groups.pop()
if group &lt;> invalid
groupType = group.subtype()
if groupType = "JFGroup"
unregisterOverhangData(group)
else if groupType = "JFVideo"
' Stop video to make sure app communicates stop playstate to server
group.control = "stop"
end if
group.visible = false
if groupType = "JFScreen"
group.callFunc("OnScreenHidden")
end if
else
' Exit app if for some reason we don't have anything on the stack
m.scene.exit = true
end if
group = m.groups.peek()
if group &lt;> invalid
registerOverhangData(group)
if group.subtype() = "Home"
currentTime = CreateObject("roDateTime").AsSeconds()
if group.timeLastRefresh = invalid or (currentTime - group.timeLastRefresh) > 20
group.timeLastRefresh = currentTime
group.callFunc("refresh")
end if
end if
group.visible = true
m.content.replaceChild(group, 0)
if group.isSubType("JFScreen")
group.callFunc("OnScreenShown")
else
' Restore focus
if group.lastFocus &lt;> invalid
group.lastFocus.setFocus(true)
else
if group.focusedChild &lt;> invalid
group.focusedChild.setFocus(true)
else
group.setFocus(true)
end if
end if
end if
else
' Exit app if the stack is empty after removing group
m.scene.exit = true
end if
end sub
'
' Return group at top of stack without removing
function getActiveScene() as object
return m.groups.peek()
end function
'
' Clear all content from group stack
sub clearScenes()
if m.content &lt;> invalid then m.content.removeChildrenIndex(m.content.getChildCount(), 0)
m.groups = []
end sub
'
' Clear previous scene from group stack
sub clearPreviousScene()
m.groups.pop()
end sub
'
' Delete scene from group stack at passed index
sub deleteSceneAtIndex(index = 1)
m.groups.Delete(index)
end sub
'
' Display user/device settings screen
sub settings()
settingsScreen = createObject("roSGNode", "Settings")
pushScene(settingsScreen)
end sub
'
' Register observers for overhang data
sub registerOverhangData(group)
if group.isSubType("JFGroup")
if group.overhangTitle &lt;> invalid then m.overhang.title = group.overhangTitle
if group.optionsAvailable
m.overhang.showOptions = true
else
m.overhang.showOptions = false
end if
group.observeField("optionsAvailable", "updateOptions")
group.observeField("overhangTitle", "updateOverhangTitle")
if group.overhangVisible
m.overhang.visible = true
else
m.overhang.visible = false
end if
group.observeField("overhangVisible", "updateOverhangVisible")
else if group.isSubType("JFVideo")
m.overhang.visible = false
else
m.log.error("registerOverhangData(): Unexpected group type.", group, group.subtype())
end if
end sub
'
' Remove observers for overhang data
sub unregisterOverhangData(group)
group.unobserveField("overhangTitle")
end sub
'
' Update overhang title
sub updateOverhangTitle(msg)
m.overhang.title = msg.getData()
end sub
'
' Update options availability
sub updateOptions(msg)
m.overhang.showOptions = msg.getData()
end sub
'
' Update whether the overhang is visible or not
sub updateOverhangVisible(msg)
m.overhang.visible = msg.getData()
end sub
'
' Update username in overhang
sub updateUser()
' Passthrough to overhang
if m.overhang &lt;> invalid then m.overhang.currentUser = m.top.currentUser
end sub
'
' Reset time
sub resetTime()
' Passthrough to overhang
m.overhang.callFunc("resetTime")
end sub
'
' Display dialog to user with an OK button
sub userMessage(title as string, message as string)
dialog = createObject("roSGNode", "StandardMessageDialog")
dialog.title = title
dialog.message = message
dialog.buttons = [tr("OK")]
dialog.observeField("buttonSelected", "dismissDialog")
m.scene.dialog = dialog
end sub
'
' Display dialog to user with an OK button
sub standardDialog(title, message)
dialog = createObject("roSGNode", "StandardDialog")
dlgPalette = createObject("roSGNode", "RSGPalette")
dlgPalette.colors = {
DialogBackgroundColor: "0x262828FF",
DialogFocusColor: "0xcececeFF",
DialogFocusItemColor: "0x202020FF",
DialogSecondaryTextColor: "0xf8f8f8ff",
DialogSecondaryItemColor: "#00a4dcFF",
DialogTextColor: "0xeeeeeeFF"
}
dialog.palette = dlgPalette
dialog.observeField("buttonSelected", "dismissDialog")
dialog.title = title
dialog.contentData = message
dialog.buttons = [tr("OK")]
m.scene.dialog = dialog
end sub
'
' Display dialog to user with an OK button
sub radioDialog(title, message)
dialog = createObject("roSGNode", "RadioDialog")
dlgPalette = createObject("roSGNode", "RSGPalette")
dlgPalette.colors = {
DialogBackgroundColor: "0x262828FF",
DialogFocusColor: "0xcececeFF",
DialogFocusItemColor: "0x202020FF",
DialogSecondaryTextColor: "0xf8f8f8ff",
DialogSecondaryItemColor: "#00a4dcFF",
DialogTextColor: "0xeeeeeeFF"
}
dialog.palette = dlgPalette
dialog.observeField("buttonSelected", "dismissDialog")
dialog.title = title
dialog.contentData = message
dialog.buttons = [tr("OK")]
m.scene.dialog = dialog
end sub
'
' Display dialog to user with an OK button
sub optionDialog(title, message, buttons)
m.top.dataReturned = false
m.top.returnData = invalid
m.userselection = false
dialog = createObject("roSGNode", "StandardMessageDialog")
dlgPalette = createObject("roSGNode", "RSGPalette")
dlgPalette.colors = {
DialogBackgroundColor: "0x262828FF",
DialogFocusColor: "0xcececeFF",
DialogFocusItemColor: "0x202020FF",
DialogSecondaryTextColor: "0xf8f8f8ff",
DialogSecondaryItemColor: "#00a4dcFF",
DialogTextColor: "0xeeeeeeFF"
}
dialog.palette = dlgPalette
dialog.observeField("buttonSelected", "optionSelected")
dialog.observeField("wasClosed", "optionClosed")
dialog.title = title
dialog.message = message
dialog.buttons = buttons
m.scene.dialog = dialog
end sub
'
' Return button the user selected
sub optionClosed()
if m.userselection then return
m.top.returnData = {
indexSelected: -1,
buttonSelected: ""
}
m.top.dataReturned = true
end sub
'
' Return button the user selected
sub optionSelected()
m.userselection = true
m.top.returnData = {
indexSelected: m.scene.dialog.buttonSelected,
buttonSelected: m.scene.dialog.buttons[m.scene.dialog.buttonSelected]
}
m.top.dataReturned = true
dismissDialog()
end sub
'
' Close currently displayed dialog
sub dismissDialog()
m.scene.dialog.close = true
end sub
'
' Returns bool indicating if dialog is currently displayed
function isDialogOpen() as boolean
return m.scene.dialog &lt;> invalid
end function
</code></pre>
</article>
</section>
</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
</footer>
<script src="scripts/linenumber.js"></script>
<script src="scripts/pagelocation.js"></script>
</body>
</html>