com.pepper.guiutils.browser
Interface WebBrowserContainer

All Known Implementing Classes:
MozillaContainer

public interface WebBrowserContainer

This interface represents a container/manager of WebBrowserView objects, that are capable of displaying and navigating web content.


Field Summary
static int TYPE_MOZILLA
           
 
Method Summary
 void clearInternalCaches()
          Clear any internal file caches, to allow files to be replaced/reloaded.
 WebBrowserView createView(Section section)
          Create a view for the specified Section
 WebBrowserView createView(Section section, int windowOptions)
          Create a view for the specified WebSection with the specified window options
 WebBrowserView createView(Section section, int windowOptions, String uri)
          Create a view for the specified WebSection with the specified window options and default uri to load
 void destroy()
          Called when the package is quit
 WebBrowserView getActiveView()
          Returns the browser view that is currently displayed
 List getAllViews()
          Get a list of all open browser views
 int getType()
          Get the type of Container
 WebBrowserView getView(String viewId)
          Returns the browser view with the specified id
 void init()
          Initialize the WebBrowserContainer
 boolean isDestroyed()
          Returns true if container views have been destroyed
 boolean isInitialized()
          Returns whether or not the container is initialized
 void removeView(String viewId)
          Remove the browser view with the specified id
 void setActiveView(WebBrowserView view)
          Make the previously created view active and visible
 void shutdown()
          Shutdown the browser and free all of it's resources
 void viewChange(String selectedViewId)
          This method will handle selection changes between views
 

Field Detail

TYPE_MOZILLA

static final int TYPE_MOZILLA
See Also:
Constant Field Values
Method Detail

getView

WebBrowserView getView(String viewId)
Returns the browser view with the specified id

Parameters:
viewId - a String value
Returns:
a WebBrowserView value

getActiveView

WebBrowserView getActiveView()
Returns the browser view that is currently displayed

Returns:
a WebBrowserView value

setActiveView

void setActiveView(WebBrowserView view)
Make the previously created view active and visible

Parameters:
view - a WebBrowserView value

getAllViews

List getAllViews()
Get a list of all open browser views

Returns:
a List of WebBrowserView objects

removeView

void removeView(String viewId)
Remove the browser view with the specified id

Parameters:
viewId - a String value

createView

WebBrowserView createView(Section section)
Create a view for the specified Section

Parameters:
section - a WebSection value
Returns:
a WebBrowserView value

createView

WebBrowserView createView(Section section,
                          int windowOptions)
Create a view for the specified WebSection with the specified window options

Parameters:
section - a WebSection value
windowOptions - see WebBrowserView.WINDOW_CURRENT, WebBrowserView.WINDOW_NEW, WebBrowserView.WINDOW_NEW_TAB
Returns:
a WebBrowserView value

createView

WebBrowserView createView(Section section,
                          int windowOptions,
                          String uri)
Create a view for the specified WebSection with the specified window options and default uri to load

Parameters:
section - a WebSection value
windowOptions - see WebBrowserView.WINDOW_CURRENT, WebBrowserView.WINDOW_NEW, WebBrowserView.WINDOW_NEW_TAB
uri - the initial uri to load in the page
Returns:
a WebBrowserView value
Since:
3.2

viewChange

void viewChange(String selectedViewId)
This method will handle selection changes between views

Parameters:
selectedViewId - The id of the view that has been selected

getType

int getType()
Get the type of Container

Returns:
an int value

init

void init()
Initialize the WebBrowserContainer


isDestroyed

boolean isDestroyed()
Returns true if container views have been destroyed

Returns:
a boolean value
Since:
3.2

isInitialized

boolean isInitialized()
Returns whether or not the container is initialized

Returns:
a boolean value

shutdown

void shutdown()
Shutdown the browser and free all of it's resources


destroy

void destroy()
Called when the package is quit


clearInternalCaches

void clearInternalCaches()
Clear any internal file caches, to allow files to be replaced/reloaded. Doesn't clear the browser's page cache.



Copyright © 2006-2007 Pepper Computer, Inc. All Rights Reserved.