components_ItemGrid_ItemGrid.bs

import "pkg:/source/api/baserequest.bs"
import "pkg:/source/roku_modules/log/LogMixin.brs"
import "pkg:/source/utils/config.bs"
import "pkg:/source/utils/deviceCapabilities.bs"
import "pkg:/source/utils/misc.bs"

sub init()
  m.log = log.Logger("ItemGrid")
  m.log.debug("start init()")
  userSettings = m.global.session.user.settings

  m.options = m.top.findNode("options")

  m.showItemCount = userSettings["itemgrid.showItemCount"]

  m.tvGuide = invalid
  m.channelFocused = invalid

  m.itemGrid = m.top.findNode("itemGrid")
  m.backdrop = m.top.findNode("backdrop")
  m.newBackdrop = m.top.findNode("backdropTransition")
  m.emptyText = m.top.findNode("emptyText")

  m.genreList = m.top.findNode("genrelist")
  m.genreList.observeField("itemSelected", "onGenreItemSelected")
  m.genreData = CreateObject("roSGNode", "ContentNode")
  m.genreList.content = m.genreData

  m.swapAnimation = m.top.findNode("backroundSwapAnimation")
  m.swapAnimation.observeField("state", "swapDone")

  m.loadedRows = 0
  m.loadedItems = 0

  m.data = CreateObject("roSGNode", "ContentNode")

  m.itemGrid.content = m.data
  m.itemGrid.setFocus(true)

  m.itemGrid.observeField("itemFocused", "onItemFocused")
  m.itemGrid.observeField("itemSelected", "onItemSelected")

  'Voice filter setup
  m.voiceBox = m.top.findNode("voiceBox")
  m.voiceBox.opacity = 0.0001
  m.voiceBox.voiceEnabled = true
  m.voiceBox.active = true
  m.voiceBox.observeField("text", "onvoiceFilter")
  'set voice help text
  m.voiceBox.hintText = tr("Use voice remote to search")

  'backdrop
  m.newBackdrop.observeField("loadStatus", "newBGLoaded")

  'Background Image Queued for loading
  m.queuedBGUri = ""

  'Item sort - maybe load defaults from user prefs?
  m.sortField = "SortName"
  m.sortAscending = true

  m.filter = "All"
  m.favorite = "Favorite"

  m.loadItemsTask = createObject("roSGNode", "LoadItemsTask2")

  'set inital counts for overhang before content is loaded.
  m.loadItemsTask.totalRecordCount = 0

  m.alpha = m.top.findNode("alpha")
  m.alphaMenu = m.alpha.findNode("alphaMenu")

  'Get reset folder setting
  m.resetGrid = userSettings["itemgrid.reset"]

  m.top.gridTitles = userSettings["itemgrid.gridTitles"]
  m.log.debug("end init()")
end sub

'Genre Item Selected
sub onGenreItemSelected()
  m.top.selectedItem = m.genreList.content.getChild(m.genreList.rowItemSelected[0]).getChild(m.genreList.rowItemSelected[1])
end sub

'Load initial set of Data
sub loadInitialItems()
  m.log.debug("start loadInitialItems()")
  m.loadItemsTask.control = "stop"
  startLoadingSpinner()
  userSettings = m.global.session.user.settings

  if m.top.parentItem.json.Type = "CollectionFolder" 'or m.top.parentItem.json.Type = "Folder"
    m.top.HomeLibraryItem = m.top.parentItem.Id
  end if

  if m.top.parentItem.backdropUrl <> invalid
    SetBackground(m.top.parentItem.backdropUrl)
  end if

  ' Read view/sort/filter settings
  if m.top.parentItem.collectionType = "livetv"
    ' Translate between app and server nomenclature
    viewSetting = userSettings["display.livetv.landing"]
    if viewSetting = "guide"
      m.view = "tvGuide"
    else
      m.view = "livetv"
    end if
    m.sortField = userSettings["display.livetv.sortField"]
    sortAscendingStr = userSettings["display.livetv.sortAscending"]
    m.filter = userSettings["display.livetv.filter"]
  else if m.top.parentItem.collectionType = "music"
    m.view = userSettings["display.music.view"]
    m.sortField = userSettings["display." + m.top.parentItem.Id + ".sortField"]
    sortAscendingStr = userSettings["display." + m.top.parentItem.Id + ".sortAscending"]
    m.filter = userSettings["display." + m.top.parentItem.Id + ".filter"]
  else
    m.sortField = userSettings["display." + m.top.parentItem.Id + ".sortField"]
    sortAscendingStr = userSettings["display." + m.top.parentItem.Id + ".sortAscending"]
    m.filter = userSettings["display." + m.top.parentItem.Id + ".filter"]
    m.view = userSettings["display." + m.top.parentItem.Id + ".landing"]
  end if

  if m.sortField = invalid
    ' Set the default order for boxsets to the Release Date - API calls it PremiereDate
    if LCase(m.top.parentItem.json.Type) = "boxset"
      m.sortField = "PremiereDate"
    else
      m.sortField = "SortName"
    end if
  end if

  if m.filter = invalid then m.filter = "All"

  if sortAscendingStr = invalid or sortAscendingStr = true
    m.sortAscending = true
  else
    m.sortAscending = false
  end if
  ' Set Studio Id
  if m.top.parentItem.json.type = "Studio"
    m.loadItemsTask.studioIds = m.top.parentItem.id
    m.loadItemsTask.itemId = m.top.parentItem.parentFolder
    m.loadItemsTask.genreIds = ""
    ' Set Genre Id
  else if m.top.parentItem.json.type = "Genre"
    m.loadItemsTask.genreIds = m.top.parentItem.id
    m.loadItemsTask.itemId = m.top.parentItem.parentFolder
    m.loadItemsTask.studioIds = ""
  else if (m.view = "Shows" or m.options.view = "Shows") or (m.view = "Movies" or m.options.view = "Movies")
    m.loadItemsTask.studioIds = ""
    m.loadItemsTask.genreIds = ""
  else
    m.loadItemsTask.itemId = m.top.parentItem.Id
  end if

  ' if we already searched for this alpha text than reset filter
  if m.loadItemsTask.nameStartsWith = m.top.alphaSelected
    m.loadItemsTask.nameStartsWith = ""
  else
    m.loadItemsTask.nameStartsWith = m.alpha.letterSelected
  end if
  updateTitle()

  m.loadItemsTask.searchTerm = m.voiceBox.text
  m.emptyText.visible = false
  m.loadItemsTask.sortField = m.sortField
  m.loadItemsTask.sortAscending = m.sortAscending
  m.loadItemsTask.filter = m.filter
  m.loadItemsTask.startIndex = 0

  ' Load Item Types
  if getCollectionType() = "movies"
    m.loadItemsTask.itemType = "Movie"
    m.loadItemsTask.itemId = m.top.parentItem.Id
  else if getCollectionType() = "tvshows"
    m.loadItemsTask.itemType = "Series"
    m.loadItemsTask.itemId = m.top.parentItem.Id
  else if getCollectionType() = "music"
    ' Default Settings
    m.loadItemsTask.recursive = true
    m.itemGrid.itemSize = "[290, 290]"

    m.loadItemsTask.itemType = "MusicArtist"
    m.loadItemsTask.itemId = m.top.parentItem.Id

    m.view = userSettings["display.music.view"]

    if m.view = "music-album"
      m.loadItemsTask.itemType = "MusicAlbum"
    end if
  else if m.top.parentItem.collectionType = "livetv"
    m.loadItemsTask.itemType = "TvChannel"
    m.loadItemsTask.itemId = " "
    ' For LiveTV, we want to "Fit" the item images, not zoom
    m.top.imageDisplayMode = "scaleToFit"

    if userSettings["display.livetv.landing"] = "guide" and m.options.view <> "livetv"
      showTvGuide()
    end if
  else if m.top.parentItem.collectionType = "CollectionFolder" or m.top.parentItem.type = "CollectionFolder" or m.top.parentItem.collectionType = "boxsets" or m.top.parentItem.Type = "Boxset" or m.top.parentItem.Type = "Boxsets" or m.top.parentItem.Type = "Folder" or m.top.parentItem.Type = "Channel"
    if m.voiceBox.text <> ""
      m.loadItemsTask.recursive = true
    else
      ' non recursive for collections (folders, boxsets, photo albums, etc)
      m.loadItemsTask.recursive = false
    end if
  else if m.top.parentItem.json.type = "Studio"
    m.loadItemsTask.itemId = m.top.parentItem.parentFolder
    m.loadItemsTask.itemType = "Series,Movie"
    m.top.imageDisplayMode = "scaleToFit"
  else if m.top.parentItem.json.type = "Genre"
    m.loadItemsTask.itemType = "Series,Movie"
    m.loadItemsTask.itemId = m.top.parentItem.parentFolder
  else
    m.log.warn("Unknown Item Type", m.top.parentItem)
  end if

  if m.top.parentItem.type <> "Folder" and (m.options.view = "Networks" or m.view = "Networks" or m.options.view = "Studios" or m.view = "Studios")
    m.loadItemsTask.view = "Networks"
    m.top.imageDisplayMode = "scaleToFit"
  else if m.top.parentItem.type <> "Folder" and (m.options.view = "Genres" or m.view = "Genres")
    m.loadItemsTask.StudioIds = m.top.parentItem.Id
    m.loadItemsTask.view = "Genres"
  else if m.top.parentItem.type <> "Folder" and (m.options.view = "Shows" or m.view = "Shows")
    m.loadItemsTask.studioIds = ""
    m.loadItemsTask.view = "Shows"
  else if m.top.parentItem.type <> "Folder" and (m.options.view = "Movies" or m.view = "Movies")
    m.loadItemsTask.studioIds = ""
    m.loadItemsTask.view = "Movies"
  end if

  m.loadItemsTask.observeField("content", "ItemDataLoaded")
  startLoadingSpinner(false)
  m.loadItemsTask.control = "RUN"
  SetUpOptions()
  m.log.debug("end loadInitialItems()")
end sub

' Set Movies view, sort, and filter options
sub setMoviesOptions(options)
  options.views = [
    { "Title": tr("Movies"), "Name": "Movies" },
    { "Title": tr("Studios"), "Name": "Studios" },
    { "Title": tr("Genres"), "Name": "Genres" }
  ]
  options.sort = [
    { "Title": tr("TITLE"), "Name": "SortName,ProductionYear" },
    { "Title": tr("Random"), "Name": "Random" },
    { "Title": tr("IMDB_RATING"), "Name": "CommunityRating,SortName,ProductionYear" },
    { "Title": tr("CRITIC_RATING"), "Name": "CriticRating,SortName,ProductionYear" },
    { "Title": tr("DATE_ADDED"), "Name": "DateCreated,SortName,ProductionYear" },
    { "Title": tr("DATE_PLAYED"), "Name": "DatePlayed,SortName,ProductionYear" },
    { "Title": tr("OFFICIAL_RATING"), "Name": "OfficialRating,SortName,ProductionYear" },
    { "Title": tr("PLAY_COUNT"), "Name": "PlayCount,SortName,ProductionYear" },
    { "Title": tr("RELEASE_DATE"), "Name": "PremiereDate,SortName,ProductionYear" },
    { "Title": tr("RUNTIME"), "Name": "Runtime,SortName,ProductionYear" },

  ]
  options.filter = [
    { "Title": tr("All"), "Name": "All" },
    { "Title": tr("Favorites"), "Name": "Favorites" },
    { "Title": tr("Played"), "Name": "Played" },
    { "Title": tr("Unplayed"), "Name": "Unplayed" },
    { "Title": tr("Resumable"), "Name": "Resumable" }
  ]
end sub

' Set Boxset view, sort, and filter options
sub setBoxsetsOptions(options)
  options.views = [{ "Title": tr("Shows"), "Name": "shows" }]
  options.sort = [
    { "Title": tr("TITLE"), "Name": "SortName" },
    { "Title": tr("Random"), "Name": "Random" },
    { "Title": tr("IMDB_RATING"), "Name": "CommunityRating,SortName" },
    { "Title": tr("CRITIC_RATING"), "Name": "CriticRating,SortName" },
    { "Title": tr("DATE_ADDED"), "Name": "DateCreated,SortName" },
    { "Title": tr("DATE_PLAYED"), "Name": "DatePlayed,SortName" },
    { "Title": tr("Folders"), "Name": "IsFolder,SortName" },
    { "Title": tr("OFFICIAL_RATING"), "Name": "OfficialRating,SortName" },
    { "Title": tr("PLAY_COUNT"), "Name": "PlayCount,SortName" },
    { "Title": tr("RELEASE_DATE"), "Name": "ProductionYear,PremiereDate,SortName" },
    { "Title": tr("RUNTIME"), "Name": "Runtime,SortName" }
  ]
  options.filter = [
    { "Title": tr("All"), "Name": "All" },
    { "Title": tr("Favorites"), "Name": "Favorites" },
    { "Title": tr("Played"), "Name": "Played" },
    { "Title": tr("Unplayed"), "Name": "Unplayed" }
  ]
end sub

' Set TV Show view, sort, and filter options
sub setTvShowsOptions(options)
  options.views = [
    { "Title": tr("Shows"), "Name": "Shows" },
    { "Title": tr("Networks"), "Name": "Networks" },
    { "Title": tr("Genres"), "Name": "Genres" }

  ]
  options.sort = [
    { "Title": tr("TITLE"), "Name": "SortName" },
    { "Title": tr("Random"), "Name": "Random" },
    { "Title": tr("IMDB_RATING"), "Name": "CommunityRating,SortName" },
    { "Title": tr("DATE_SHOW_ADDED"), "Name": "DateCreated,SortName" },
    { "Title": tr("DATE_EPISODE_ADDED"), "Name": "DateLastContentAdded,SortName" }
    { "Title": tr("DATE_PLAYED"), "Name": "SeriesDatePlayed,SortName" },
    { "Title": tr("OFFICIAL_RATING"), "Name": "OfficialRating,SortName" },
    { "Title": tr("RELEASE_DATE"), "Name": "PremiereDate,SortName" },
  ]
  options.filter = [
    { "Title": tr("All"), "Name": "All" },
    { "Title": tr("Favorites"), "Name": "Favorites" },
    { "Title": tr("Played"), "Name": "Played" },
    { "Title": tr("Unplayed"), "Name": "Unplayed" }
  ]

  if isValid(m.view)
    if LCase(m.options.view) = "genres" or LCase(m.view) = "genres"
      options.sort = [{ "Title": tr("TITLE"), "Name": "SortName" }]
      options.filter = []
    end if
  end if

end sub

' Set Live TV view, sort, and filter options
sub setLiveTvOptions(options)
  options.views = [
    { "Title": tr("Channels"), "Name": "livetv" },
    { "Title": tr("TV Guide"), "Name": "tvGuide" }
  ]
  options.sort = [
    { "Title": tr("TITLE"), "Name": "SortName" }
  ]
  options.filter = [
    { "Title": tr("All"), "Name": "All" },
    { "Title": tr("Favorites"), "Name": "Favorites" }
  ]
  options.favorite = [
    { "Title": tr("Favorite"), "Name": "Favorite" }
  ]
end sub

' Set Music view, sort, and filter options
sub setMusicOptions(options)
  options.views = [
    { "Title": tr("Artists"), "Name": "music-artist" },
    { "Title": tr("Albums"), "Name": "music-album" },
  ]
  options.sort = [
    { "Title": tr("TITLE"), "Name": "SortName" },
    { "Title": tr("DATE_ADDED"), "Name": "DateCreated" },
    { "Title": tr("DATE_PLAYED"), "Name": "DatePlayed" },
    { "Title": tr("RELEASE_DATE"), "Name": "PremiereDate" },
    { "Title": tr("Random"), "Name": "Random" },
  ]
  options.filter = [
    { "Title": tr("All"), "Name": "All" },
    { "Title": tr("Favorites"), "Name": "Favorites" }
  ]
end sub

' Set Photo Album view, sort, and filter options
sub setPhotoAlbumOptions(options)
  options.views = [
    { "Title": tr("Slideshow Off"), "Name": "singlephoto" }
    { "Title": tr("Slideshow On"), "Name": "slideshowphoto" }
    { "Title": tr("Random Off"), "Name": "singlephoto" }
    { "Title": tr("Random On"), "Name": "randomphoto" }
  ]
  options.sort = []
  options.filter = []
end sub

' Set Default view, sort, and filter options
sub setDefaultOptions(options)
  options.views = [
    { "Title": tr("Default"), "Name": "default" }
  ]
  options.sort = [
    { "Title": tr("TITLE"), "Name": "SortName" }
  ]
end sub

' Return parent collection type
function getCollectionType() as string
  if m.top.parentItem.collectionType = invalid
    return m.top.parentItem.Type
  else
    return m.top.parentItem.CollectionType
  end if
end function

' Search string array for search value. Return if it's found
function inStringArray(array, searchValue) as boolean
  for each item in array
    if lcase(item) = lcase(searchValue) then return true
  end for
  return false
end function

' Data to display when options button selected
sub SetUpOptions()
  options = {}
  options.filter = []
  options.favorite = []

  if getCollectionType() = "movies"
    setMoviesOptions(options)
  else if inStringArray(["boxsets", "Boxset"], getCollectionType())
    setBoxsetsOptions(options)
  else if getCollectionType() = "tvshows"
    setTvShowsOptions(options)
  else if getCollectionType() = "livetv"
    setLiveTvOptions(options)
  else if inStringArray(["photoalbum", "photo", "homevideos"], getCollectionType())
    setPhotoAlbumOptions(options)
  else if getCollectionType() = "music"
    setMusicOptions(options)
  else
    setDefaultOptions(options)
  end if

  ' Set selected view option
  for each o in options.views
    if o.Name = m.view
      o.Selected = true
      o.Ascending = m.sortAscending
      m.options.view = o.Name
    end if
  end for

  ' Set selected sort option
  for each o in options.sort
    if o.Name = m.sortField
      o.Selected = true
      o.Ascending = m.sortAscending
      m.options.sortField = o.Name
    end if
  end for

  ' Set selected filter option
  for each o in options.filter
    if o.Name = m.filter
      o.Selected = true
      m.options.filter = o.Name
    end if
  end for

  m.options.options = options
end sub

'Handle loaded data, and add to Grid
sub ItemDataLoaded(msg)
  m.log.debug("start ItemDataLoaded()")
  itemData = msg.GetData()
  m.loadItemsTask.unobserveField("content")
  m.loadItemsTask.content = []

  if itemData = invalid
    m.Loading = false
    stopLoadingSpinner()
    return
  end if

  if m.loadItemsTask.view = "Genres"
    ' Reset genre list data
    m.genreData.removeChildren(m.genreData.getChildren(-1, 0))

    for each item in itemData
      m.genreData.appendChild(item)
    end for

    m.itemGrid.opacity = "0"
    m.genreList.opacity = "1"

    m.itemGrid.setFocus(false)
    m.genreList.setFocus(true)

    m.loading = false
    stopLoadingSpinner()
    return
  end if

  for each item in itemData
    m.data.appendChild(item)
  end for

  ' keep focus on alpha menu when loading new data
  if m.top.alphaActive
    m.alphaMenu.setFocus(true)
  else
    m.itemGrid.opacity = "1"
    m.genreList.opacity = "0"

    m.alphaMenu.setFocus(false)
    m.itemGrid.setFocus(true)
    m.genreList.setFocus(false)
  end if

  'Update the stored counts
  m.loadedItems = m.itemGrid.content.getChildCount()
  m.loadedRows = m.loadedItems / m.itemGrid.numColumns
  m.Loading = false
  'If there are no items to display, show message
  if m.loadedItems = 0
    m.emptyText.text = tr("NO_ITEMS").Replace("%1", m.top.parentItem.Type)
    m.emptyText.visible = true
  end if

  stopLoadingSpinner()
  m.log.debug("end ItemDataLoaded()")
end sub

'Set Background Image
sub SetBackground(backgroundUri as string)
  m.log.debug("start SetBackground()", backgroundUri, m.swapAnimation.state, m.newBackdrop.loadStatus)
  'If a new image is being loaded, or transitioned to, store URL to load next
  if not m.top.alphaActive
    if m.swapAnimation.state <> "stopped" or m.newBackdrop.loadStatus = "loading"
      m.log.debug("caching new background URI")
      m.queuedBGUri = backgroundUri
      return
    end if
  end if

  m.newBackdrop.uri = backgroundUri
  m.log.debug("end SetBackground()")
end sub

'Handle new item being focused
sub onItemFocused()
  m.log.debug("start onItemFocused()", m.itemGrid.currFocusRow, m.itemGrid.itemFocused)

  focusedRow = m.itemGrid.currFocusRow

  itemInt = m.itemGrid.itemFocused

  updateTitle()

  ' If no selected item, set background to parent backdrop
  if itemInt = -1 or focusedRow = -1
    return
  end if

  m.selectedFavoriteItem = m.itemGrid.content.getChild(m.itemGrid.itemFocused)

  ' Set Background to item backdrop
  SetBackground(m.itemGrid.content.getChild(m.itemGrid.itemFocused).backdropUrl)

  ' Load more data if focus is within last 5 rows, and there are more items to load
  if focusedRow >= m.loadedRows - 5 and m.loadeditems < m.loadItemsTask.totalRecordCount
    loadMoreData()
  end if
  m.log.debug("end onItemFocused()")
end sub

'When Image Loading Status changes
sub newBGLoaded()
  'If image load was sucessful, start the fade swap
  if m.newBackdrop.loadStatus = "ready"
    m.swapAnimation.control = "start"
  end if
end sub

'Swap Complete
sub swapDone()
  if isValid(m.swapAnimation) and m.swapAnimation.state = "stopped"
    'Set main BG node image and hide transitioning node
    m.backdrop.uri = m.newBackdrop.uri
    m.backdrop.opacity = 0.25
    m.newBackdrop.opacity = 0

    'If there is another one to load
    if m.newBackdrop.uri <> m.queuedBGUri and m.queuedBGUri <> ""
      m.log.debug("Loading queued backdrop image", m.queuedBGUri)
      SetBackground(m.queuedBGUri)
      m.queuedBGUri = ""
    end if
  end if
end sub

'Load next set of items
sub loadMoreData()
  m.log.debug("start loadMoreData()")
  if m.Loading = true then return

  startLoadingSpinner(false)
  m.Loading = true
  m.loadItemsTask.startIndex = m.loadedItems
  m.loadItemsTask.observeField("content", "ItemDataLoaded")
  m.loadItemsTask.control = "RUN"
  m.log.debug("end loadMoreData()")
end sub

'Item Selected
sub onItemSelected()
  m.top.selectedItem = m.itemGrid.content.getChild(m.itemGrid.itemSelected)
end sub

sub alphaSelectedChanged()
  if m.top.alphaSelected <> ""
    m.loadedRows = 0
    m.loadedItems = 0
    m.data = CreateObject("roSGNode", "ContentNode")
    m.itemGrid.content = m.data
    m.loadItemsTask.searchTerm = ""
    m.VoiceBox.text = ""

    loadInitialItems()
  end if
end sub

sub onvoiceFilter()
  if m.VoiceBox.text <> ""
    m.loadedRows = 0
    m.loadedItems = 0
    m.data = CreateObject("roSGNode", "ContentNode")
    m.itemGrid.content = m.data
    m.top.alphaSelected = ""
    m.loadItemsTask.NameStartsWith = " "
    m.loadItemsTask.searchTerm = m.voiceBox.text
    m.loadItemsTask.recursive = true
    if m.voiceBox.text.len() = 1
      ' move focus to the letter spoken
      alphaMenu = m.top.findNode("alphaMenu")
      intConversion = m.voiceBox.text.ToInt() ' non numeric input returns as 0

      if m.voiceBox.text = "0" or (isValid(intConversion) and intConversion <> 0)
        alphaMenu.jumpToItem = 0
      else
        ' loop through each option until we find a match
        for i = 1 to alphaMenu.numRows - 1
          alphaMenuOption = alphaMenu.content.getChild(i)
          if Lcase(alphaMenuOption.TITLE) = Lcase(m.voiceBox.text)
            alphaMenu.jumpToItem = i
            exit for
          end if
        end for
      end if
    end if
    loadInitialItems()
  end if
end sub

'Check if options updated and any reloading required
sub optionsClosed()
  if m.top.parentItem.collectionType = "livetv" and m.options.view <> m.view
    if m.options.view = "tvGuide"
      m.view = "tvGuide"
      set_user_setting("display.livetv.landing", "guide")
      showTVGuide()
      return
    else
      m.view = "livetv"
      set_user_setting("display.livetv.landing", "channels")

      if m.tvGuide <> invalid
        ' Try to hide the TV Guide
        m.top.removeChild(m.tvGuide)
      end if
    end if
  end if

  if m.top.parentItem.Type = "CollectionFolder" or m.top.parentItem.Type = "Folder" or m.top.parentItem.CollectionType = "CollectionFolder"
    ' Did the user just request "Random" on a PhotoAlbum?
    if m.options.view = "singlephoto"
      set_user_setting("photos.slideshow", "false")
      set_user_setting("photos.random", "false")
    else if m.options.view = "slideshowphoto"
      set_user_setting("photos.slideshow", "true")
      set_user_setting("photos.random", "false")
    else if m.options.view = "randomphoto"
      set_user_setting("photos.random", "true")
      set_user_setting("photos.slideshow", "false")
    end if
  end if

  reload = false

  if m.top.parentItem.collectionType = "music"
    if m.options.view <> m.view
      m.view = m.options.view
      set_user_setting("display.music.view", m.view)
      reload = true
    end if
  else
    m.view = m.global.session.user.settings["display." + m.top.parentItem.Id + ".landing"]
    if m.options.view <> m.view
      'reload and store new view setting
      m.view = m.options.view
      set_user_setting("display." + m.top.parentItem.Id + ".landing", m.view)
      reload = true
    end if
  end if

  if m.options.sortField <> m.sortField or m.options.sortAscending <> m.sortAscending
    m.sortField = m.options.sortField
    m.sortAscending = m.options.sortAscending
    reload = true

    'Store sort settings
    if m.sortAscending = true
      sortAscendingStr = "true"
    else
      sortAscendingStr = "false"
    end if

    if m.top.parentItem.collectionType = "livetv"
      set_user_setting("display.livetv.sortField", m.sortField)
      set_user_setting("display.livetv.sortAscending", sortAscendingStr)
    else
      set_user_setting("display." + m.top.parentItem.Id + ".sortField", m.sortField)
      set_user_setting("display." + m.top.parentItem.Id + ".sortAscending", sortAscendingStr)
    end if
  end if
  if m.options.filter <> m.filter
    m.filter = m.options.filter
    updateTitle()
    reload = true
    'Store filter setting
    if m.top.parentItem.collectionType = "livetv"
      set_user_setting("display.livetv.filter", m.options.filter)
    else
      set_user_setting("display." + m.top.parentItem.Id + ".filter", m.options.filter)
    end if
  end if
  if reload
    m.loadedRows = 0
    m.loadedItems = 0
    m.data = CreateObject("roSGNode", "ContentNode")
    m.itemGrid.content = m.data
    loadInitialItems()
  end if

  m.itemGrid.setFocus(m.itemGrid.opacity = 1)
  m.genreList.setFocus(m.genreList.opacity = 1)

  if m.tvGuide <> invalid
    m.tvGuide.lastFocus.setFocus(true)
  end if

end sub

sub showTVGuide()
  if m.tvGuide = invalid
    m.tvGuide = createObject("roSGNode", "Schedule")
    m.top.signalBeacon("EPGLaunchInitiate") ' Required Roku Performance monitoring
    m.tvGuide.observeField("watchChannel", "onChannelSelected")
    m.tvGuide.observeField("focusedChannel", "onChannelFocused")
  end if
  m.tvGuide.filter = m.filter
  m.tvGuide.searchTerm = m.voiceBox.text
  m.top.appendChild(m.tvGuide)
  m.scheduleGrid = m.top.findNode("scheduleGrid")
  m.tvGuide.lastFocus.setFocus(true)
end sub

sub onChannelSelected(msg)
  node = msg.getRoSGNode()
  m.top.lastFocus = lastFocusedChild(node)
  if node.watchChannel <> invalid
    ' Clone the node when it's reused/update in the TimeGrid it doesn't automatically start playing
    m.top.selectedItem = node.watchChannel.clone(false)
    ' Make sure to set watchChanel to invalid in case the user hits back and then selects
    ' the same channel on the guide (without moving away from the currently selected channel)
    m.tvGuide.watchChannel = invalid
  end if
end sub

sub onChannelFocused(msg)
  node = msg.getRoSGNode()
  m.channelFocused = node.focusedChannel
end sub

'Returns Focused Item
function getItemFocused()
  if m.itemGrid.isinFocusChain() and isValid(m.itemGrid.itemFocused)
    return m.itemGrid.content.getChild(m.itemGrid.itemFocused)
  else if m.genreList.isinFocusChain() and isValid(m.genreList.rowItemFocused)
    return m.genreList.content.getChild(m.genreList.rowItemFocused[0]).getChild(m.genreList.rowItemFocused[1])
  else if isValid(m.scheduleGrid) and m.scheduleGrid.isinFocusChain() and isValid(m.scheduleGrid.itemFocused)
    return m.scheduleGrid.content.getChild(m.scheduleGrid.itemFocused)
  end if
  return invalid
end function

sub alphaActiveChanged()
  m.log.debug("start alphaActiveChanged()", m.top.alphaActive)

  if m.top.alphaActive
    ' fade into an empty backdrop
    m.swapAnimation.state = "stop"
    m.queuedBGUri = ""
    ' use a 1px image because we can't use the animation to fade into a blank uri string
    SetBackground("pkg:/images/1px-000000.png")
  end if

  m.log.debug("end alphaActiveChanged()")
end sub

function onKeyEvent(key as string, press as boolean) as boolean
  if not press then return false

  if m.itemGrid.opacity = 1
    topGrp = m.itemGrid
  else
    topGrp = m.genreList
  end if
  searchGrp = m.top.findNode("voiceBox")

  if key = "left" and searchGrp.isinFocusChain()
    topGrp.setFocus(true)
    searchGrp.setFocus(false)
  end if

  if key = "options"
    if m.options.visible = true
      m.options.visible = false
      m.top.removeChild(m.options)
      optionsClosed()
    else
      channelSelected = m.channelFocused
      itemSelected = m.selectedFavoriteItem
      if itemSelected <> invalid
        m.options.selectedFavoriteItem = itemSelected
      end if
      if channelSelected <> invalid
        if channelSelected.type = "TvChannel"
          m.options.selectedFavoriteItem = channelSelected
        end if
      end if
      m.options.visible = true
      m.top.appendChild(m.options)
      m.options.setFocus(true)
    end if
    return true
  else if key = "back"
    if m.options.visible = true
      m.options.visible = false
      optionsClosed()
      return true
    else
      m.global.sceneManager.callfunc("popScene")
      m.loadItemsTask.control = "stop"
      return true
    end if
  else if key = "OK"
    markupGrid = m.top.findNode("itemGrid")
    itemToPlay = getItemFocused()

    if itemToPlay <> invalid and itemToPlay.type = "Photo"
      ' Spawn photo player task
      photoPlayer = CreateObject("roSgNode", "PhotoDetails")
      photoPlayer.itemsNode = markupGrid
      photoPlayer.itemIndex = markupGrid.itemFocused
      m.global.sceneManager.callfunc("pushScene", photoPlayer)
      return true
    end if
  else if key = "play"
    itemToPlay = getItemFocused()

    if itemToPlay <> invalid
      m.top.quickPlayNode = itemToPlay
      return true
    end if
  else if key = "left" and topGrp.isinFocusChain() and m.alpha.visible
    m.log.debug("Now entering alpha menu")
    m.top.alphaActive = true
    topGrp.setFocus(false)
    m.alphaMenu.setFocus(true)

    return true
  else if key = "right" and m.alpha.isinFocusChain()
    m.log.debug("Now leaving alpha menu")
    m.top.alphaActive = false
    m.alphaMenu.setFocus(false)
    topGrp.setFocus(true)
    return true
  else if key = "replay" and topGrp.isinFocusChain()
    if m.resetGrid = true
      m.itemGrid.animateToItem = 0
    else
      m.itemGrid.jumpToItem = 0
    end if
  end if

  if key = "replay"
    m.loadItemsTask.searchTerm = ""
    m.loadItemsTask.nameStartsWith = ""
    m.voiceBox.text = ""
    m.top.alphaSelected = ""
    m.loadItemsTask.filter = "All"
    m.filter = "All"
    m.data = CreateObject("roSGNode", "ContentNode")
    m.itemGrid.content = m.data
    loadInitialItems()
    return true
  end if

  return false
end function

sub updateTitle()
  m.top.overhangTitle = m.top.parentItem.title

  if m.filter = "Favorites"
    m.top.overhangTitle = m.top.parentItem.title + " " + tr("(Favorites)")
  end if

  if m.voiceBox.text <> ""
    m.top.overhangTitle = m.top.parentItem.title + tr(" (Filtered by ") + m.loadItemsTask.searchTerm + ")"
  end if

  if m.loadItemsTask.nameStartsWith <> ""
    m.top.overhangTitle = m.top.parentItem.title + tr(" (Filtered by ") + m.loadItemsTask.nameStartsWith + ")"
  end if

  if m.view = "music-artist"
    m.top.overhangTitle = "%s (%s)".Format(m.top.parentItem.title, tr("Artists"))
  else if m.view = "music-album"
    m.top.overhangTitle = "%s (%s)".Format(m.top.parentItem.title, tr("Albums"))
  end if

  if m.options.view = "Networks" or m.view = "Networks"
    m.top.overhangTitle = "%s (%s)".Format(m.top.parentItem.title, tr("Networks"))
  end if

  if m.options.view = "Studios" or m.view = "Studios"
    m.top.overhangTitle = "%s (%s)".Format(m.top.parentItem.title, tr("Studios"))
  end if

  if m.options.view = "Genres" or m.view = "Genres"
    m.top.overhangTitle = "%s (%s)".Format(m.top.parentItem.title, tr("Genres"))
  end if

  actInt = m.itemGrid.itemFocused + 1

  if m.showItemCount and m.loadItemsTask.totalRecordCount > 0 and m.options.view <> "Genres" and m.view <> "Genres"
    m.top.overhangTitle += " (" + tr("%1 of %2").Replace("%1", actInt.toStr()).Replace("%2", m.loadItemsTask.totalRecordCount.toStr()) + ")"
  end if

end sub