|
Server : Apache/2.2.2 (Fedora) System : Linux App1.pathumtani.go.th 2.6.20-1.2320.fc5smp #1 SMP Tue Jun 12 19:40:16 EDT 2007 i686 User : apache ( 48) PHP Version : 5.2.9 Disable Function : NONE Directory : /proc/self/root/usr/share/doc/libgnome-java-2.12.4/api/org/gnu/gnome/ |
Upload File : |
<?xml version="1.0" encoding="US-ASCII"?>
<!DOCTYPE html PUBLIC "-//gnu.org///DTD XHTML 1.1 plus Target 1.0//EN" "../../../resources/xhtml11-target10.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><title>AppBar (Java-Gnome 2.12.4 API Reference)</title><script src="../../../resources/gjdoc.js" type="text/javascript"><!-- this comment required for konqueror 3.2.2 --></script><meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"/><meta name="generator" content="GNU Gjdoc Standard Doclet"/><meta name="keywords" content="org.gnu.gnome.AppBar class"/><meta name="keywords" content="getAppBar()"/><meta name="keywords" content="clearPrompt()"/><meta name="keywords" content="clearStack()"/><meta name="keywords" content="getProgressBar()"/><meta name="keywords" content="getResponse()"/><meta name="keywords" content="popStack()"/><meta name="keywords" content="pushStack()"/><meta name="keywords" content="refresh()"/><meta name="keywords" content="setProgressPercentage()"/><meta name="keywords" content="setPrompt()"/><meta name="keywords" content="setStatusDefault()"/><meta name="keywords" content="setStatusText()"/><meta name="keywords" content="getStatusBar()"/><meta name="keywords" content="getType()"/><meta name="keywords" content="addListener()"/><meta name="keywords" content="removeListener()"/><meta name="keywords" content="getEventListenerClass()"/><meta name="keywords" content="getEventType()"/><link rel="stylesheet" type="text/css" href="../../../resources/gjdochtml-clean-layout.css" title="GNU Clean"/><link rel="stylesheet" type="text/css" href="../../../resources/gjdochtml-clean-color1.css" title="GNU Clean"/></head><body class="content class" onload="if(parent.contentPageLoaded)parent.contentPageLoaded(document.title)"><table class="navbar div top"><tr><td class="navbar div top"><div class="navbar div top"><span class="navbar item enabled"><a href="../../../overview-summary.html">Overview</a></span> <span class="navbar item enabled"><a href="package-summary.html">Package</a></span> <span class="navbar item enabled"><a href="tree.html">Tree</a></span> <span class="navbar item enabled"><a href="../../../alphaindex.html">Index</a></span> <span class="navbar item enabled"><a href="../../../deprecated.html">Deprecated</a></span> <span class="navbar item enabled"><a href="../../../about.html">About</a></span></div></td></tr><tr><td class="navi"><a href="../../../org/gnu/gnome/App.html">Prev Class</a> | <a href="../../../org/gnu/gnome/Canvas.html">Next Class</a></td><td class="navi"><a href="../../../index.html" title="Show in a frameset" target="_top">Frames</a> | <a href="AppBar.html" title="Show without frames" target="_top">No Frames</a> </td></tr><tr><td class="navi">Summary: Nested | Field | <a href="#summary-methods">Method</a> | <a href="#summary-constructors">Constr</a></td><td class="navi">Detail: Nested | Field | <a href="#detail-methods">Method</a> | <a href="#detail-constructors">Constr</a></td></tr></table><div class="class title outer"><h3 class="class title-package">org.gnu.gnome</h3><h1 class="class title-class">Class AppBar</h1></div><div class="class inheritance-tree"><ul class="inheritance 0"><li class="inheritance 0"><code>HBox</code></li><li><ul class="inheritance 1"><li class="inheritance 1"><code>org.gnu.gnome.AppBar</code></li><li></li></ul></li></ul></div><hr/><div class="class synopsis outer"><div class="class synopsis declaration"><code>public class <b class="class synopsis name">AppBar</b></code></div><div class="class synopsis superclass"><code>extends HBox</code></div></div><hr/><div class="class description"> The AppBar widget is a progress bar with a textual annotation.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><a name="summary-constructors" id="summary-constructors"/><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table header"><td colspan="2"><h2 class="table header">Constructor Summary</h2></td></tr><tr><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#AppBar(Handle)">AppBar</a>(Handle handle)</code></dt><dd class="description"> Construct an AppBar using a handle to a native resource.</dd></dl></td></tr><tr><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#AppBar(boolean,boolean,org.gnu.gnome.PreferencesType)">AppBar</a>(boolean hasProgress, boolean hasStatus, <a href="../../../org/gnu/gnome/PreferencesType.html" title="Class in org.gnu.gnome">PreferencesType</a> type)</code></dt><dd class="description"> Creates new instance of AppBar.</dd></dl></td></tr></table></dd></dl><a name="summary-methods" id="summary-methods"/><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table header"><td colspan="2"><h2 class="table header">Method Summary</h2></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#addListener(org.gnu.gnome.event.AppBarListener)">addListener</a>(<a href="../../../org/gnu/gnome/event/AppBarListener.html" title="Interface in org.gnu.gnome.event">AppBarListener</a> listener)</code></dt><dd class="description"> Register an object to handle AppBar events.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#clearPrompt()">clearPrompt</a>()</code></dt><dd class="description"> Clears any prompt.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#clearStack()">clearStack</a>()</code></dt><dd class="description"> Clears the stack.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">static <a href="../../../org/gnu/gnome/AppBar.html" title="Class in org.gnu.gnome">AppBar</a></code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getAppBar(Handle)">getAppBar</a>(Handle handle)</code></dt><dd class="description"> Internal static factory method to be used by Java-Gnome only.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> Class</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getEventListenerClass(String)">getEventListenerClass</a>(String signal)</code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> EventType</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getEventType(String)">getEventType</a>(String signal)</code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> ProgressBar</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getProgressBar()">getProgressBar</a>()</code></dt><dd class="description"> Returns the progress bar used by AppBar.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> String</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getResponse()">getResponse</a>()</code></dt><dd class="description"> Gets the response to setPrompt
</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> StatusBar</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getStatusBar()">getStatusBar</a>()</code></dt><dd class="description"> Return the StatusBar widget contained in this AppBar.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">static Type</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getType()">getType</a>()</code></dt><dd class="description"> Retrieve the runtime type used by the GLib library.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#popStack()">popStack</a>()</code></dt><dd class="description"> Pops the top status off the stack.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#pushStack(String)">pushStack</a>(String status)</code></dt><dd class="description"> Pushes the status onto the stack.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#refresh()">refresh</a>()</code></dt><dd class="description"> Refreshes to the current state of stack/default.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#removeListener(org.gnu.gnome.event.AppBarListener)">removeListener</a>(<a href="../../../org/gnu/gnome/event/AppBarListener.html" title="Interface in org.gnu.gnome.event">AppBarListener</a> listener)</code></dt><dd class="description"> Removes a listener.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#setProgressPercentage(double)">setProgressPercentage</a>(double percentage)</code></dt><dd class="description"> Sets the percetage to show for progress.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#setPrompt(String,boolean)">setPrompt</a>(String prompt, boolean modal)</code></dt><dd class="description"> Sets a prompt in the appbar and waits for a response.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#setStatusDefault(String)">setStatusDefault</a>(String status)</code></dt><dd class="description"> What to show when showing nothing else.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#setStatusText(String)">setStatusText</a>(String status)</code></dt><dd class="description"> Sets the status text without changing the widget state.</dd></dl></td></tr></table></dd></dl><a name="detail-constructors" id="detail-constructors"/><h2 class="section header">Constructor Details</h2><div class="section"><a name="AppBar(Handle)" id="AppBar(Handle)"/><div class="member detail outer"><h3 class="member detail name">AppBar</h3><pre class="member detail synopsis">public AppBar(Handle handle)</pre><blockquote class="member detail name"><div class="member detail description"> Construct an AppBar using a handle to a native resource.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="AppBar(boolean,boolean,org.gnu.gnome.PreferencesType)" id="AppBar(boolean,boolean,org.gnu.gnome.PreferencesType)"/><div class="member detail outer"><h3 class="member detail name">AppBar</h3><pre class="member detail synopsis">public AppBar(boolean hasProgress,
boolean hasStatus,
<a href="../../../org/gnu/gnome/PreferencesType.html" title="Class in org.gnu.gnome">PreferencesType</a> type)</pre><blockquote class="member detail name"><div class="member detail description"> Creates new instance of AppBar.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div></div><a name="detail-methods" id="detail-methods"/><h2 class="section header">Method Details</h2><div class="section"><a name="addListener(org.gnu.gnome.event.AppBarListener)" id="addListener(org.gnu.gnome.event.AppBarListener)"/><div class="member detail outer"><h3 class="member detail name">addListener</h3><pre class="member detail synopsis">public void addListener(<a href="../../../org/gnu/gnome/event/AppBarListener.html" title="Interface in org.gnu.gnome.event">AppBarListener</a> listener)</pre><blockquote class="member detail name"><div class="member detail description"> Register an object to handle AppBar events.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"><dl class="tag list"><dt class="tag section header"><b>See Also:</b></dt><dd><a href="../../../org/gnu/gnome/event/AppBarListener.html"><code>AppBarListener</code></a></dd></dl></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="clearPrompt()" id="clearPrompt()"/><div class="member detail outer"><h3 class="member detail name">clearPrompt</h3><pre class="member detail synopsis">public void clearPrompt()</pre><blockquote class="member detail name"><div class="member detail description"> Clears any prompt.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"><dl class="tag list"><dt class="tag section header"><b>See Also:</b></dt><dd><a href="../../../org/gnu/gnome/AppBar.html#setPrompt(String,boolean)"><code>setPrompt(String,boolean)</code></a></dd></dl></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="clearStack()" id="clearStack()"/><div class="member detail outer"><h3 class="member detail name">clearStack</h3><pre class="member detail synopsis">public void clearStack()</pre><blockquote class="member detail name"><div class="member detail description"> Clears the stack.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getAppBar(Handle)" id="getAppBar(Handle)"/><div class="member detail outer"><h3 class="member detail name">getAppBar</h3><pre class="member detail synopsis">public static <a href="../../../org/gnu/gnome/AppBar.html" title="Class in org.gnu.gnome">AppBar</a> getAppBar(Handle handle)</pre><blockquote class="member detail name"><div class="member detail description"> Internal static factory method to be used by Java-Gnome only.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getEventListenerClass(String)" id="getEventListenerClass(String)"/><div class="member detail outer"><h3 class="member detail name">getEventListenerClass</h3><pre class="member detail synopsis">public Class getEventListenerClass(String signal)</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getEventType(String)" id="getEventType(String)"/><div class="member detail outer"><h3 class="member detail name">getEventType</h3><pre class="member detail synopsis">public EventType getEventType(String signal)</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getProgressBar()" id="getProgressBar()"/><div class="member detail outer"><h3 class="member detail name">getProgressBar</h3><pre class="member detail synopsis">public ProgressBar getProgressBar()</pre><blockquote class="member detail name"><div class="member detail description"> Returns the progress bar used by AppBar.
</div><div class="member detail return list"><dl><dt class="member detail return header"><b>Returns:</b></dt><dd class="member detail return item">The progress bar.</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getResponse()" id="getResponse()"/><div class="member detail outer"><h3 class="member detail name">getResponse</h3><pre class="member detail synopsis">public String getResponse()</pre><blockquote class="member detail name"><div class="member detail description"> Gets the response to setPrompt
</div><div class="member detail return list"><dl><dt class="member detail return header"><b>Returns:</b></dt><dd class="member detail return item">The user's response.</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"><dl class="tag list"><dt class="tag section header"><b>See Also:</b></dt><dd><a href="../../../org/gnu/gnome/AppBar.html#setPrompt(String,boolean)"><code>setPrompt(String,boolean)</code></a></dd></dl></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getStatusBar()" id="getStatusBar()"/><div class="member detail outer"><h3 class="member detail name">getStatusBar</h3><pre class="member detail synopsis">public StatusBar getStatusBar()</pre><blockquote class="member detail name"><div class="member detail description"> Return the StatusBar widget contained in this AppBar.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getType()" id="getType()"/><div class="member detail outer"><h3 class="member detail name">getType</h3><pre class="member detail synopsis">public static Type getType()</pre><blockquote class="member detail name"><div class="member detail description"> Retrieve the runtime type used by the GLib library.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="popStack()" id="popStack()"/><div class="member detail outer"><h3 class="member detail name">popStack</h3><pre class="member detail synopsis">public void popStack()</pre><blockquote class="member detail name"><div class="member detail description"> Pops the top status off the stack. Calling this on an empty stack causes
no problems.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="pushStack(String)" id="pushStack(String)"/><div class="member detail outer"><h3 class="member detail name">pushStack</h3><pre class="member detail synopsis">public void pushStack(String status)</pre><blockquote class="member detail name"><div class="member detail description"> Pushes the status onto the stack.
</div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">status</code><span class="separator"> - </span><span class="description">The status text. Not null.</span></dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="refresh()" id="refresh()"/><div class="member detail outer"><h3 class="member detail name">refresh</h3><pre class="member detail synopsis">public void refresh()</pre><blockquote class="member detail name"><div class="member detail description"> Refreshes to the current state of stack/default. Useful for forcing the
text set by a call to setStatusText to disappear.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="removeListener(org.gnu.gnome.event.AppBarListener)" id="removeListener(org.gnu.gnome.event.AppBarListener)"/><div class="member detail outer"><h3 class="member detail name">removeListener</h3><pre class="member detail synopsis">public void removeListener(<a href="../../../org/gnu/gnome/event/AppBarListener.html" title="Interface in org.gnu.gnome.event">AppBarListener</a> listener)</pre><blockquote class="member detail name"><div class="member detail description"> Removes a listener.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"><dl class="tag list"><dt class="tag section header"><b>See Also:</b></dt><dd><a href="../../../org/gnu/gnome/AppBar.html#addListener(org.gnu.gnome.event.AppBarListener)"><code>addListener(AppBarListener)</code></a></dd></dl></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="setProgressPercentage(double)" id="setProgressPercentage(double)"/><div class="member detail outer"><h3 class="member detail name">setProgressPercentage</h3><pre class="member detail synopsis">public void setProgressPercentage(double percentage)</pre><blockquote class="member detail name"><div class="member detail description"> Sets the percetage to show for progress.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="setPrompt(String,boolean)" id="setPrompt(String,boolean)"/><div class="member detail outer"><h3 class="member detail name">setPrompt</h3><pre class="member detail synopsis">public void setPrompt(String prompt,
boolean modal)</pre><blockquote class="member detail name"><div class="member detail description"> Sets a prompt in the appbar and waits for a response. When the user
responds or cancels, a user_response signal is emitted.
</div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">prompt</code><span class="separator"> - </span><span class="description">The message used to prompt the user.</span></dd><dd class="item"><code class="name">modal</code><span class="separator"> - </span><span class="description">True if all user input to the application should be blocked
until the user responds to the prompt or cancels.</span></dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="setStatusDefault(String)" id="setStatusDefault(String)"/><div class="member detail outer"><h3 class="member detail name">setStatusDefault</h3><pre class="member detail synopsis">public void setStatusDefault(String status)</pre><blockquote class="member detail name"><div class="member detail description"> What to show when showing nothing else. Defaults to nothing.
</div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">status</code><span class="separator"> - </span><span class="description">The text to use as default. Not null.</span></dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="setStatusText(String)" id="setStatusText(String)"/><div class="member detail outer"><h3 class="member detail name">setStatusText</h3><pre class="member detail synopsis">public void setStatusText(String status)</pre><blockquote class="member detail name"><div class="member detail description"> Sets the status text without changing the widget state. The next set or
push will destroy this permanently.
</div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">status</code><span class="separator"> - </span><span class="description">The text to set. Not null.</span></dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div></div><p class="navbar bottom spacer"> </p><table class="navbar div bottom"><tr><td><div class="navbar div top"><span class="navbar item enabled"><a href="../../../overview-summary.html">Overview</a></span> <span class="navbar item enabled"><a href="package-summary.html">Package</a></span> <span class="navbar item enabled"><a href="tree.html">Tree</a></span> <span class="navbar item enabled"><a href="../../../alphaindex.html">Index</a></span> <span class="navbar item enabled"><a href="../../../deprecated.html">Deprecated</a></span> <span class="navbar item enabled"><a href="../../../about.html">About</a></span></div></td><td></td></tr></table></body></html>