org.symbian.wrttools.doc.WRTKit/html/WRTKit_UIManager_Class-GUID-937146c8-3889-40f5-b9f7-0f774ac9f5fe.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/org.symbian.wrttools.doc.WRTKit/html/WRTKit_UIManager_Class-GUID-937146c8-3889-40f5-b9f7-0f774ac9f5fe.html Thu Mar 04 15:42:37 2010 -0800
@@ -0,0 +1,451 @@
+<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html lang="en" xml:lang="en">
+<head>
+<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
+<meta name="copyright" content="(C) Copyright 2005" />
+<meta name="DC.rights.owner" content="(C) Copyright 2005" />
+<meta content="concept" name="DC.Type" />
+<meta name="DC.Title" content="WRTKit UIManager Class" />
+<meta scheme="URI" name="DC.Relation" content="WRTKit_API_Reference-GUID-00e47c27-0a1a-443f-ae85-cf3381635170.html" />
+<meta content="XHTML" name="DC.Format" />
+<meta content="GUID-937146C8-3889-40F5-B9F7-0F774AC9F5FE" name="DC.Identifier" />
+<meta content="en" name="DC.Language" />
+<link href="commonltr.css" type="text/css" rel="stylesheet" />
+<title>
+WRTKit UIManager Class</title>
+</head>
+<body id="GUID-937146C8-3889-40F5-B9F7-0F774AC9F5FE"><a name="GUID-937146C8-3889-40F5-B9F7-0F774AC9F5FE"><!-- --></a>
+
+
+
+ <h1 class="topictitle1">
+WRTKit UIManager Class</h1>
+
+ <div>
+
+ <div class="section"><h2 class="sectiontitle">
+Description</h2>
+
+
+ <p>
+
+ The UIManager class manages a set of views and related user interface elements
+ such as the scrollbar that indicates the scroll position for the current view,
+ as well as notification popup dialogs.
+ </p>
+
+ <p>
+
+ A typical WRTKit user interface consists of one or more views that are commanded
+ to be displayed using the UIManager. When a view is commanded to be shown, the
+ UIManager will remove the currently displayed view (if any) and attach the
+ requested view. The UIManager creates and maintains the state of a scrollbar so
+ that it matches the scrolling position and viewport extent at any given
+ time, regardless of what goes on in the view (e.g. added or removed content),
+ screen rotations and resizes, etc.
+ </p>
+
+ </div>
+
+ </div>
+
+ <div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="WRTKit_API_Reference-GUID-00e47c27-0a1a-443f-ae85-cf3381635170.html">WRTKit API Reference</a></div>
+</div>
+</div>
+<div class="nested1" id="GUID-1F6C6376-EC85-4F79-AFAE-89F4C6078C7A"><a name="GUID-1F6C6376-EC85-4F79-AFAE-89F4C6078C7A"><!-- --></a>
+
+ <h2 class="topictitle2">
+Constructor</h2>
+
+ <div>
+
+ <div class="section"><h3 class="sectiontitle">
+Syntax</h3>
+
+
+ <pre>
+[UIManager] new UIManager(HTMLElement viewParentElement, HTMLElement scrollbarParentElement)</pre>
+
+ </div>
+
+ <div class="section"><h3 class="sectiontitle">
+Description</h3>
+
+
+ <p>
+
+ Creates a new instance of the ContentPanel class.
+ </p>
+
+ </div>
+
+ <div class="section"><h3 class="sectiontitle">
+Arguments</h3>
+
+
+ <br /><ul>
+
+ <li>
+
+ <p>
+viewParentElement</p>
+
+
+
+ <p>
+
+ The HTML element to attachs views to. Normally this argument would be
+ omitted, which causes the UIManager to create its own view parent alement
+ that attaches to the document body element. You only need to supply an
+ HTML element to this argument in rare cases when it's not desirable to
+ have views take up the entire document area.
+ </p>
+
+
+ </li>
+
+ <li>
+
+ <p>
+scrollbarParentElement</p>
+
+
+
+ <p>
+
+ The HTML element to attachs the scrollbar to. Normally this argument would be
+ omitted, which causes the UIManager to create its own scrollbar parent alement
+ that attaches to the document body element. You only need to supply an
+ HTML element to this argument in rare cases when it's not desirable to
+ have the scrollbar in its default location.
+ </p>
+
+
+ </li>
+
+ </ul>
+
+ </div>
+
+ <div class="section"><h3 class="sectiontitle">
+Return value</h3>
+
+
+ <p>
+
+ A new instance of the UIManager class.
+ </p>
+
+ </div>
+
+ </div>
+
+ </div>
+
+ <div class="nested1" id="GUID-C31ACB4A-D7B2-4CA5-B0B5-025E289293E5"><a name="GUID-C31ACB4A-D7B2-4CA5-B0B5-025E289293E5"><!-- --></a>
+
+ <h2 class="topictitle2">
+getView()</h2>
+
+ <div>
+
+ <div class="section"><h3 class="sectiontitle">
+Syntax</h3>
+
+
+ <pre>
+[String] UIManager.getView(void)</pre>
+
+ </div>
+
+ <div class="section"><h3 class="sectiontitle">
+Description</h3>
+
+
+ <p>
+
+ Retrieves the current view.
+ </p>
+
+ </div>
+
+ <div class="section"><h3 class="sectiontitle">
+Arguments</h3>
+
+
+ <p>
+
+ This method does not take any arguments.
+ </p>
+
+ </div>
+
+ <div class="section"><h3 class="sectiontitle">
+Return value</h3>
+
+
+ <p>
+
+ The current view or null if none.
+ </p>
+
+ </div>
+
+ </div>
+
+ </div>
+
+ <div class="nested1" id="GUID-34ECA4D5-EFA3-41C0-A391-B4F0A97D39BB"><a name="GUID-34ECA4D5-EFA3-41C0-A391-B4F0A97D39BB"><!-- --></a>
+
+ <h2 class="topictitle2">
+setView()</h2>
+
+ <div>
+
+ <div class="section"><h3 class="sectiontitle">
+Syntax</h3>
+
+
+ <pre>
+[void] UIManager.setView(View view)</pre>
+
+ </div>
+
+ <div class="section"><h3 class="sectiontitle">
+Description</h3>
+
+
+ <p>
+
+ Sets the view to display. Calling this method removes the current view and
+ displays the specified one instead. If null is passed as the argument to this
+ method then the current view is removed but no new view is displayed instead.
+ </p>
+
+ </div>
+
+ <div class="section"><h3 class="sectiontitle">
+Arguments</h3>
+
+
+ <br /><ul>
+
+ <li>
+
+ <p>
+view</p>
+
+
+
+ <p>
+
+ The new view to display or null to simply remove the current view.
+ </p>
+
+
+ </li>
+
+ </ul>
+
+ </div>
+
+ <div class="section"><h3 class="sectiontitle">
+Return value</h3>
+
+
+ <p>
+
+ This method does not return a value.
+ </p>
+
+ </div>
+
+ </div>
+
+ </div>
+
+ <div class="nested1" id="GUID-9416DD56-09E0-4231-8B45-446C14C6E56E"><a name="GUID-9416DD56-09E0-4231-8B45-446C14C6E56E"><!-- --></a>
+
+ <h2 class="topictitle2">
+showNotification()</h2>
+
+ <div>
+
+ <div class="section"><h3 class="sectiontitle">
+Syntax</h3>
+
+
+ <pre>
+[void] UIManager.showNotification(Integer displayTime, String type, String text, Float progress)</pre>
+
+ </div>
+
+ <div class="section"><h3 class="sectiontitle">
+Description</h3>
+
+
+ <p>
+
+ Displays a notification popup dialog. If a dialog is already showing then calling this
+ method again will change the content of the already displayed notification popup.
+ </p>
+
+ </div>
+
+ <div class="section"><h3 class="sectiontitle">
+Arguments</h3>
+
+
+ <br /><ul>
+
+ <li>
+
+ <p>
+displayTime</p>
+
+
+
+ <p>
+
+ The duration that the dialog should be displayed before automatically hiding.
+ Specified in milliseconds (i.e. 1000ms = 1s). If the notification dialog should
+ not automatically hide then a negative value can be specified.
+ </p>
+
+
+ </li>
+
+ <li>
+
+ <p>
+type</p>
+
+
+
+ <p>
+
+ Type of notification to display. This argument affects the look of the dialog
+ and should have a value of either "info", "warning" or "wait". "Info" should be
+ used for informational popups, "warning" for errors and other warning messages
+ and "wait" for progress dialogs. If the argument is null then no type icon
+ will be shown in the dialog.
+ </p>
+
+
+ </li>
+
+ <li>
+
+ <p>
+text</p>
+
+
+
+ <p>
+
+ The text to display in the popup dialog. If the argument is null then no text
+ will be shown, however this is not recommended as it would be unclear to the
+ user.
+ </p>
+
+
+ </li>
+
+ <li>
+
+ <p>
+progress</p>
+
+
+
+ <p>
+
+ This argument should be omitted except when a progress dialog is desired, i.e.
+ when used with the "wait" type. The value of progress should be a floating
+ point number between 0.0 and 1.0, where 0.0 means "0% progress" and 1.0 means
+ "100% progress". A negative number means "unknown progress" and results in a
+ different progress bar style than for known progress.
+ </p>
+
+
+ </li>
+
+ </ul>
+
+ </div>
+
+ <div class="section"><h3 class="sectiontitle">
+Return value</h3>
+
+
+ <p>
+
+ This method does not return a value.
+ </p>
+
+ </div>
+
+ </div>
+
+ </div>
+
+ <div class="nested1" id="GUID-E37D4CC9-0EA4-4850-9F68-BA5C65B1A223"><a name="GUID-E37D4CC9-0EA4-4850-9F68-BA5C65B1A223"><!-- --></a>
+
+ <h2 class="topictitle2">
+hideNotification()</h2>
+
+ <div>
+
+ <div class="section"><h3 class="sectiontitle">
+Syntax</h3>
+
+
+ <pre>
+[void] UIManager.hideNotification()</pre>
+
+ </div>
+
+ <div class="section"><h3 class="sectiontitle">
+Description</h3>
+
+
+ <p>
+
+ Hides the currently displayed notification popup dialog, if any. If this method
+ is called when no notification dialog is displayed then the method call is simply
+ ignored but no harm is done.
+ </p>
+
+ </div>
+
+ <div class="section"><h3 class="sectiontitle">
+Arguments</h3>
+
+
+ <p>
+
+ This method does not take any arguments.
+ </p>
+
+ </div>
+
+ <div class="section"><h3 class="sectiontitle">
+Return value</h3>
+
+
+ <p>
+
+ This method does not return a value.
+ </p>
+
+ </div>
+
+ </div>
+
+ </div>
+
+
+</body>
+</html>
\ No newline at end of file