How to...Customize the Escape TV reference UI

 

Go Back...


The Escape TV reference UI allows for a great deal of customization without the need to modify any source code.

Escape ships with two implementations of its TV UI. The first provides the standard UI implemented in Java. If you utilize this Java-based UI then only the following elements are customizable:

  • text appearing within the UI
  • colors used through the UI
  • visibility of buttons
  • images used in the UI
  • customization of the portal content and progress meter
  • hot key mappings

All UI resources are contained in the tvrefuiresources.jar to allow for easy modification. The table below outlines where these customization elements are defined:


Customization File(s) Description
Text EscapeTVRefUI.properties, EscapeJavaUI.properties Text can be customized by editing the strings in these files, or by providing alternative files named according to the deployment locale.
Colors tvtheme.properties In this file, the colors used throughout the UI can be specified in a general manner using RGB values.
Button Visibility tvtheme.properties The visibility of various buttons in the UI can be specified in this file.
Images EscapeTVRefUI.properties, EscapeJavaUI.properties, tvrefuiresources.jar All images used through the UI are contained in the tvrefuiresources.jar. The names of the images are defined in the properties file.
Portal EscapeTVRefUI.properties, tvrefuiresources.jar The location of portal content can be specified in the properties file. The image used by the portal progress meter is contained in the tvrefuiresources.jar. The portal progress meter can also be disabled or customized in the properties file.
Hot Keys EscapeTVRefUI.properties Hot key mappings for toggling the toolbar, entering portal mode, cancelling a page load, back history, forward history, and reload are defined in this file.

Additonally, you can perform advanced UI customization if you use the HTML-based TV UI. Read about the HTML-based TV UI here.


Top of the page

Go Back...