|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface GuiServicesProvider
Interface that provides common GUI Services, such as reporting status messages, error messages, and showing the progress bar
Field Summary | |
---|---|
static int |
SEARCH_AMAZON
Amazon search option |
static int |
SEARCH_GOOGLE
Google search option |
static int |
SEARCH_LOCAL
Local Page search option |
static int |
SEARCH_YAHOO
Yahoo search option |
static String |
SOUND_AOL_BUDDY_OFFLINE
AIM Buddy Offline sound. |
static String |
SOUND_AOL_BUDDY_ONLINE
AIM Buddy Online sound. |
static String |
SOUND_AOL_NEW_MESSAGE
AIM NewMessage sound. |
static String |
SOUND_LOCAL_BUDDY_OFFLINE
Local IM Buddy Offline sound. |
static String |
SOUND_LOCAL_BUDDY_ONLINE
Local IM Buddy Online sound. |
static String |
SOUND_LOCAL_NEW_MESSAGE
Local IM NewMessage sound. |
static String |
SOUND_SHARING_REQUEST
Sharing Request sound. |
Method Summary | |
---|---|
void |
animate(boolean start)
Start/Stop the Keeper's busy animation |
void |
animate(boolean start,
boolean showWaitMsg)
Start/Stop the Keeper's busy animation and optionally show the wait message splash screen |
void |
blinkFlag(String packageId)
Blink the application flag with the specified packageId in the flag panel of the Keeper |
JFrame |
getMainFrame()
Get the main Keeper Frame |
boolean |
getPowerSaveOff()
Get the current state of the power save setting |
boolean |
getPowerSleepOff()
Get the current state of the power sleep setting |
JTextField |
getSearchField()
Get the search field in the Binder |
SystemTray |
getSystemTray()
Get the system tray object |
JComboBox |
getURLField()
Get the url UI Component in the Keeper |
AbstractPepperProgram |
getVisibleProgram()
Get the currently visible AbsgtractPepperProgram in the Keeper |
void |
hideProgressBar()
Clears the progress bar value and clears status message |
void |
playSound(String soundName)
Play a sound in the Keeper |
void |
powerSaveOff(boolean state)
|
void |
powerSleepOff(boolean state)
|
void |
setCurrentProcess(int processId)
Makes the AbstractPepperProgram with the specified process id the visible program in the Keeper and selects it's flag in the flag panel. |
void |
setProgressBarIndeterminate(boolean state)
Change the state of a running progress bar |
void |
setProgressBarMax(int max)
Set the maximum value for a determinant progress bar |
void |
setProgressBarMin(int min)
Set the minimum value for a determinant progress bar |
void |
setProgressBarValue(int value)
Set the current value for a determinant progress bar |
void |
setSearchScope(int type)
Set the scope of the search |
modelobjects.framework.threads.CancellableThread |
showProgressBar(Runnable runnable,
String label,
boolean indeterminate)
Show the progress bar, launch the runnable in a thread, and hide the progress bar when the thread has completed |
modelobjects.framework.threads.CancellableThread |
showProgressBar(Runnable runnable,
String label,
boolean indeterminate,
boolean showProgressDialog)
Optionally show a progress dialog with a stop button to allow the passed in thread to be stopped. |
modelobjects.framework.threads.CancellableThread |
showProgressBar(Runnable runnable,
String label,
boolean indeterminate,
boolean showProgressDialog,
boolean cancellable)
Optionally show a progress dialog that can be defined as not cancellable. |
void |
showProgressBar(String label,
boolean indeterminate)
Show the progress bar, indicating work-in-progress. |
void |
showWebPage(AbstractPepperProgram program,
String urlString,
String sectionId)
Shows a web page in the specified program (if web pages supported by the program, or else will launch the browser package and display the page in it |
void |
showWebPage(AbstractPepperProgram program,
String urlString,
String sectionId,
int windowOption)
Shows a web page in the specified program (if web pages supported by the program, or else will launch the browser package and display the page in it. |
void |
showWebToolBar(boolean state)
Hide or show the web toolbar |
void |
toggleFlags()
hide/show the package flags |
void |
toggleFullScreen()
toggle between fullscreen mode |
void |
toggleMedia()
hied/show media controls |
void |
toggleNavbar()
hide/show nav bar (url field and search field) |
void |
toggleTabs()
hide/show the package tabs |
void |
toggleToolbar()
hide/show global toolbar |
void |
updateURL(String text)
Set the url field's text |
void |
writeStatus(String message)
Write a transient status message to the status bar. |
void |
writeStatus(String message,
boolean now,
boolean isTransient)
write a status message to the status bar and optionally make message transient |
Field Detail |
---|
static final int SEARCH_LOCAL
static final int SEARCH_GOOGLE
static final int SEARCH_AMAZON
static final int SEARCH_YAHOO
static final String SOUND_AOL_NEW_MESSAGE
static final String SOUND_LOCAL_NEW_MESSAGE
static final String SOUND_AOL_BUDDY_ONLINE
static final String SOUND_LOCAL_BUDDY_ONLINE
static final String SOUND_AOL_BUDDY_OFFLINE
static final String SOUND_LOCAL_BUDDY_OFFLINE
static final String SOUND_SHARING_REQUEST
Method Detail |
---|
void animate(boolean start)
start
- a boolean
valuevoid animate(boolean start, boolean showWaitMsg)
start
- a boolean
valueshowWaitMsg
- a boolean
valuevoid writeStatus(String message)
message
- the message is expected to have been properly
formatted for the current locale.void writeStatus(String message, boolean now, boolean isTransient)
message
- a String
valuenow
- currently not usedisTransient
- If true, the message will be cleared after 5 secs,
otherwise it will remain until another message is writtenvoid showProgressBar(String label, boolean indeterminate)
label
- Text to be displayed in the progress bar, or the empty
string to display nothing.indeterminate
- true
to display the progress bar
in indeterminate mode, false
to display it in determinate
mode.void setProgressBarIndeterminate(boolean state)
state
- true for indeterminate, false for determinantmodelobjects.framework.threads.CancellableThread showProgressBar(Runnable runnable, String label, boolean indeterminate)
runnable
- a Runnable
object to runlabel
- Label to display in the progress barindeterminate
- true
to show the progress bar in
indeterminate mode, false
to show it in determinate mode.
modelobjects.framework.threads.CancellableThread showProgressBar(Runnable runnable, String label, boolean indeterminate, boolean showProgressDialog)
runnable
- a Runnable
object to runlabel
- Label to display in the progress bar or title of dialogindeterminate
- true
to show the progress bar in
indeterminate mode, false
to show it in determinate mode.showProgressDialog
- if true a dialog will be displayed that
shows the progress and allows the thread to be cancelled
modelobjects.framework.threads.CancellableThread showProgressBar(Runnable runnable, String label, boolean indeterminate, boolean showProgressDialog, boolean cancellable)
cancellable
flag is false, the dialog will not be cancellable,
and the stop button in the dialog will be disabled.
runnable
- a Runnable
object to runlabel
- Label to display in the progress bar or title of dialogindeterminate
- true
to show the progress bar in
indeterminate mode, false
to show it in determinate mode.showProgressDialog
- if true a dialog will be displayed that
shows the progress and allows the thread to be cancelledcancellable
- if true the dialog will be cancellable, if false the
stop button will be disabled in the dialog
void hideProgressBar()
void setProgressBarMin(int min)
min
- an int
valuevoid setProgressBarMax(int max)
max
- an int
valuevoid setProgressBarValue(int value)
void setCurrentProcess(int processId)
processId
- The process id of the AbstractPepperProgramAbstractPepperProgram.getPID()
AbstractPepperProgram getVisibleProgram()
AbstractPepperProgram
valueSystemTray getSystemTray()
SystemTray
valueJFrame getMainFrame()
JFrame
valueJComboBox getURLField()
JComboxBox
valuevoid updateURL(String text)
text
- The string to updateJTextField getSearchField()
JTextField
valuevoid setSearchScope(int type)
type
- see SEARCH_XXX constants in this classvoid blinkFlag(String packageId)
packageId
- a String
valuevoid showWebPage(AbstractPepperProgram program, String urlString, String sectionId)
program
- The destination programurlString
- the url to displaysectionId
- - The section id of the web tab to display it in. Pass in
null to use the default web section for the programvoid showWebPage(AbstractPepperProgram program, String urlString, String sectionId, int windowOption)
program
- an AbstractPepperProgram
valueurlString
- a String
valuesectionId
- a String
valuewindowOption
- one of WebBrowserView.WINDOW_CURRENT, WebBrowserView.WINDOW_NEW,
or WebBrowserView.WINDOW_NEW_TAB. If WINDOW_NEW or WINDOW_NEW_TAB are set,
any value specified for sectionId will be ignored.void toggleFullScreen()
void toggleTabs()
void toggleFlags()
void toggleToolbar()
void toggleNavbar()
void toggleMedia()
void powerSaveOff(boolean state)
boolean getPowerSaveOff()
void powerSleepOff(boolean state)
boolean getPowerSleepOff()
void playSound(String soundName)
soundName
- a String
containing the
name of the sound to play. Sound names are
defined as SOUND_ public constants in this class.void showWebToolBar(boolean state)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |