org.jdesktop.wonderland.client.content.spi
Interface ContentBrowserSPI


public interface ContentBrowserSPI

Interface to a specific implementation of a graphical content browswer.

Author:
Jordan Slott

Nested Class Summary
static class ContentBrowserSPI.BrowserAction
          Enumeration of actions that can be taken upon the content browser
static interface ContentBrowserSPI.ContentBrowserListener
          The listener interface to report the result of the action taken on the content browser.
 
Method Summary
 void addContentBrowserListener(ContentBrowserSPI.ContentBrowserListener listener)
          Adds a listener to the content browser to indicate the user's action.
 void removeContentBrowserListener(ContentBrowserSPI.ContentBrowserListener listener)
          Removes a listener from the content browser.
 void setActionName(ContentBrowserSPI.BrowserAction action, java.lang.String name)
          Sets the name of the button that represents the given action
 void setModal(boolean modal)
          Sets whether the browser should be "modal" or not.
 void setVisible(boolean visible)
          Sets whether the content browser is visible (true) or not (false).
 

Method Detail

setActionName

void setActionName(ContentBrowserSPI.BrowserAction action,
                   java.lang.String name)
Sets the name of the button that represents the given action


addContentBrowserListener

void addContentBrowserListener(ContentBrowserSPI.ContentBrowserListener listener)
Adds a listener to the content browser to indicate the user's action. If the listener has already been added, this method does nothing. The listener is valid for one event only; it is removed after it is invoked.

Parameters:
listener - The listener to add

removeContentBrowserListener

void removeContentBrowserListener(ContentBrowserSPI.ContentBrowserListener listener)
Removes a listener from the content browser. If this listener is not present, this method does nothing.

Parameters:
listener - The listener to remove

setVisible

void setVisible(boolean visible)
Sets whether the content browser is visible (true) or not (false).

Parameters:
visible - True to make the browser visible, false for not

setModal

void setModal(boolean modal)
Sets whether the browser should be "modal" or not.

Parameters:
modal - True to make the browser model, false for not


Open Wonderland - http://openwonderland.org