org.cafesip.gwtcomp.client.ui
Class ServerFileBrowser

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.google.gwt.user.client.ui.Panel
              com.google.gwt.user.client.ui.SimplePanel
                  com.google.gwt.user.client.ui.PopupPanel
                      com.google.gwt.user.client.ui.DecoratedPopupPanel
                          com.google.gwt.user.client.ui.DialogBox
                              org.cafesip.gwtcomp.client.ui.ServerFileBrowser

All Implemented Interfaces:

com.google.gwt.user.client.EventListener, com.google.gwt.user.client.EventPreview, com.google.gwt.user.client.ui.HasAnimation, com.google.gwt.user.client.ui.HasHTML, com.google.gwt.user.client.ui.HasText, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.MouseListener, com.google.gwt.user.client.ui.SourcesPopupEvents, java.lang.Iterable<com.google.gwt.user.client.ui.Widget>

public class ServerFileBrowser
extends com.google.gwt.user.client.ui.DialogBox

Lets GWT applications browse and selects files that are present in the web server hosting the GWT application. For system administration purposes, very often, users have to specify a file or a directory in the server. This widget lets the user browser the files in the server using a file selector user interface.

Note that this component requires a GWT servlet to be running on the server. You will need to include the gwtcomp-servlet.jar in the WEB-INF/web.xml file and in the web.xml file, add the following segment:

   <servlet>
        <servlet-name>DirListingService</servlet-name>
        <servlet-class>
            org.cafesip.gwtcomp.server.DirListingServiceImpl
        </servlet-class>
    </servlet>
    ...
    <servlet-mapping>
        <servlet-name>DirListingService</servlet-name>
        <url-pattern>/gwtcomp/directoryService</url-pattern>
    </servlet-mapping>
 

Examples:

• ServerFileBrowserSample.java

CSS Style Rules:

• .gwtcomp-ServerFileBrowser { } - style for the file browser diaglog box
• .gwtcomp-ServerFileBrowserList { } - style for the file list
• .gwtcomp-ServerFileBrowserServerWait { } - style to be applied while the file browser is waiting to hear back from the server
*

Screen-Shots:

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.PopupPanel

com.google.gwt.user.client.ui.PopupPanel.PositionCallback

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

ServerFileBrowser()
A constructor for this class.

ServerFileBrowser(java.lang.String filter)
A constructor for this class.

Method Summary

void	addServerFileListener(ServerFileBrowserListener listener) Adds a listener for events.
java.lang.String	getFilter() Returns the filter string.
void	removeServerFileListener(ServerFileBrowserListener listener) Removes an event listener.
void	setFilter(java.lang.String filter) Sets a filter string.

Methods inherited from class com.google.gwt.user.client.ui.DialogBox

doAttachChildren, doDetachChildren, getHTML, getText, onEnsureDebugId, onEventPreview, onMouseDown, onMouseEnter, onMouseLeave, onMouseMove, onMouseUp, setHTML, setText

Methods inherited from class com.google.gwt.user.client.ui.DecoratedPopupPanel

clear, getCellElement, getWidget, iterator, remove, setWidget

Methods inherited from class com.google.gwt.user.client.ui.PopupPanel

addPopupListener, center, getContainerElement, getOffsetHeight, getOffsetWidth, getPopupLeft, getPopupTop, getTitle, hide, hide, isAnimationEnabled, onDetach, onKeyDownPreview, onKeyPressPreview, onKeyUpPreview, removePopupListener, setAnimationEnabled, setHeight, setPopupPosition, setPopupPositionAndShow, setTitle, setVisible, setWidth, show

Methods inherited from class com.google.gwt.user.client.ui.SimplePanel

add

Methods inherited from class com.google.gwt.user.client.ui.Panel

adopt, adopt, disown, onLoad, onUnload, orphan

Methods inherited from class com.google.gwt.user.client.ui.Widget

getParent, isAttached, onAttach, onBrowserEvent, removeFromParent

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, isVisible, removeStyleDependentName, removeStyleName, setElement, setElement, setPixelSize, setSize, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkEvents, toString, unsinkEvents

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ServerFileBrowser

public ServerFileBrowser(java.lang.String filter)

A constructor for this class.

Parameters:

filter - a regular expression filter String. Only files/directories matching the pattern will be displayed.

ServerFileBrowser

public ServerFileBrowser()

A constructor for this class. Creates a file browser with no filtering.

Method Detail

addServerFileListener

public void addServerFileListener(ServerFileBrowserListener listener)

Adds a listener for events.

Parameters:

listener -

removeServerFileListener

public void removeServerFileListener(ServerFileBrowserListener listener)

Removes an event listener.

Parameters:

listener -

getFilter

public java.lang.String getFilter()

Returns the filter string.

Returns:

Returns the filter.

setFilter

public void setFilter(java.lang.String filter)

Sets a filter string.

Parameters:

filter - The filter to set.