wjhk.jupload2.context

Class DefaultJUploadContext

java.lang.Object

wjhk.jupload2.context.DefaultJUploadContext

All Implemented Interfaces:

JUploadContext

Direct Known Subclasses:

JUploadContextApplet, JUploadContextExecutable

public class DefaultJUploadContext
extends Object
implements JUploadContext

The Jupload Context. One such context is created at run time. It can be the Applet, or the 'main' class, depending on the launch type.
It contains the call to the creation of the JUploadPanel, which contains the real code, and some technical stuff that depend on the technical context (mainly applet or stand alone application).
The functional control of JUpload is done by using UploadPolicy. This class should not be changed, in order to remain compatible with next JUpload releases.

Technical note: This class should be abstract. But it is used by the build.xml file, to load the version. So all methods of the JUploadContext interface are implemented. Those who actually can't be coded here, just generate a UnsupportedOperationException exception.

Version:

$Revision: 750 $

Author:

etienne_sf

Constructor Summary

Constructors

Constructor and Description
DefaultJUploadContext()

Method Summary

Modifier and Type	Method and Description
void	displayDebug(String debug, int minDebugLevel) Call to UploadPolicy.displayDebug(String, int)
void	displayErr(String err) Call to UploadPolicy.displayErr(Exception)
void	displayInfo(String info) Call to UploadPolicy.displayInfo(String)
void	displayURL(String url, boolean success) Just throws a UnsupportedOperationException exception.
void	displayWarn(String warn) Call to UploadPolicy.displayWarn(String)
JApplet	getApplet() Just throws a UnsupportedOperationException exception.
String	getBuildDate()
int	getBuildNumber()
Cursor	getCursor() Just throws a UnsupportedOperationException exception.
String	getDetailedVersionMessage()
Frame	getFrame() Returns the current frame.
String	getLastModified()
JUploadTextArea	getLogWindow() Retrieves the current log window of this applet.
String	getMimeType(String fileExtension) Returns the mime type associated with the given file extension.
boolean	getParameter(String key, boolean def) Just throws a UnsupportedOperationException exception.
FilePanel.FileListViewMode	getParameter(String key, FilePanel.FileListViewMode def) Just throws a UnsupportedOperationException exception.
float	getParameter(String key, float def) Just throws a UnsupportedOperationException exception.
int	getParameter(String key, int def) Just throws a UnsupportedOperationException exception.
long	getParameter(String key, long def) Just throws a UnsupportedOperationException exception.
String	getParameter(String key, String def) Just throws a UnsupportedOperationException exception.
static Properties	getSvnProperties() Helper function, to get the Revision number, if available.
String	getSvnRevision()
JUploadPanel	getUploadPanel() Retrieves the current upload panel.
UploadPolicy	getUploadPolicy() Retrieves the current upload policy.
String	getVersion()
void	init(Frame frame, RootPaneContainer rootPaneContainer) Reaction on the start of the applet: creation of each specific item of the GUI, and the upload policy.
String	normalizeURL(String url) Just throws a UnsupportedOperationException exception.
boolean	parseBoolean(String value, boolean def) This function try to parse value as a boolean.
FilePanel.FileListViewMode	parseFileListViewMode(String value, FilePanel.FileListViewMode def) This function try to parse value as a FilePanel.FileListViewMode.
float	parseFloat(String value, float def) This function try to parse value as a float number.
int	parseInt(String value, int def) This function try to parse value as an integer.
long	parseLong(String value, long def) This function try to parse value as a Long.
void	readCookieFromNavigator(Vector<String> headers) Just throws a UnsupportedOperationException exception.
void	readUserAgentFromNavigator(Vector<String> headers) Just throws a UnsupportedOperationException exception.
void	registerUnload(Object object, String method) Register a callback to be executed during applet termination.
void	runUnload() Runs all callback that must be called when releasing the applet.
Cursor	setCursor(Cursor cursor) Just throws a UnsupportedOperationException exception.
void	setProperty(String prop, String value) This allow runtime modifications of properties, from javascript.
Cursor	setWaitCursor() Sets the wait cursor on the current application (applet, executable...).
void	showStatus(String status) Just throws a UnsupportedOperationException exception.
String	startUpload() Public method that can be called by Javascript to start upload
void	unload() This method is called when the applet is unloaded (actually, when it is stopped). it is registered as a callback in the init(Frame, RootPaneContainer), here above.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultJUploadContext

public DefaultJUploadContext()

Method Detail

init

public void init(Frame frame,
                 RootPaneContainer rootPaneContainer)

Reaction on the start of the applet: creation of each specific item of the GUI, and the upload policy.
This method needs that the initialization of the called is finished. For instance, JUploadContextApplet needs to have set theApplet, to be able to properly execute some method calls that are in the init() method. So we can not do this initialization in the constructor of DefaultJUploadContext.

Parameters:

frame - The frame that contains the application. Mainly used to attached modal dialog.

rootPaneContainer - The mother window (JApplet, JFrame...), which contains the rootPaneContainer. Used to set the JUploadPanel in it.

unload

public void unload()

This method is called when the applet is unloaded (actually, when it is stopped). it is registered as a callback in the init(Frame, RootPaneContainer), here above.

getDetailedVersionMessage

public String getDetailedVersionMessage()

Specified by:

getDetailedVersionMessage in interface JUploadContext

Returns:

The 'official' version (applet version and SVN revision)

getVersion

public String getVersion()

Specified by:

getVersion in interface JUploadContext

Returns:

The applet version

getSvnRevision

public String getSvnRevision()

Specified by:

getSvnRevision in interface JUploadContext

Returns:

The applet SVN revision, from which it was compiled

getLastModified

public String getLastModified()

Specified by:

getLastModified in interface JUploadContext

Returns:

Last modification date (date of last commit)

getBuildDate

public String getBuildDate()

Specified by:

getBuildDate in interface JUploadContext

Returns:

Last modification date (date of last commit)

getBuildNumber

public int getBuildNumber()

Specified by:

getBuildNumber in interface JUploadContext

Returns:

Last modification date (date of last commit)

getLogWindow

public JUploadTextArea getLogWindow()

Retrieves the current log window of this applet. This log window may visible or not depending on various applet parameter.

Specified by:

getLogWindow in interface JUploadContext

Returns:

the current log window of this instance.

See Also:

JUploadPanel.showOrHideLogWindow()

getMimeType

public String getMimeType(String fileExtension)

Returns the mime type associated with the given file extension. As the applet may run on windows, the fileExtension is always changed to minor case, before looking for the corresponding mime type.

Specified by:

getMimeType in interface JUploadContext

Parameters:

fileExtension - The file extension, in any case.

Returns:

Returns the current mime type, for this extension.

getUploadPanel

public JUploadPanel getUploadPanel()

Retrieves the current upload panel.

Specified by:

getUploadPanel in interface JUploadContext

Returns:

the current upload panel of this instance.

getUploadPolicy

public UploadPolicy getUploadPolicy()
                             throws JUploadException

Retrieves the current upload policy. The JUploadContext is responsible for storing the UploadPolicy associated with the current instance.

Specified by:

getUploadPolicy in interface JUploadContext

Returns:

the current upload policy of this instance.

Throws:

JUploadException

setProperty

public void setProperty(String prop,
                        String value)

This allow runtime modifications of properties, from javascript. Currently, this can only be used after full initialization. This method only calls the UploadPolicy.setProperty method.
Ex: document.jupload.setProperty(prop, value);

Specified by:

setProperty in interface JUploadContext

Parameters:

prop - The property name that must be set.

value - The value of this property.

startUpload

public String startUpload()

Public method that can be called by Javascript to start upload

Specified by:

startUpload in interface JUploadContext

Returns:

Returns the upload result. See the constants defined in the JavascriptHandler javadoc.

displayErr

public void displayErr(String err)

Call to UploadPolicy.displayErr(Exception)

Parameters:

err - The error text to be displayed.

displayInfo

public void displayInfo(String info)

Call to UploadPolicy.displayInfo(String)

Parameters:

info - The info text to display

displayWarn

public void displayWarn(String warn)

Call to UploadPolicy.displayWarn(String)

Parameters:

warn - The error text to be displayed.

displayDebug

public void displayDebug(String debug,
                         int minDebugLevel)

Call to UploadPolicy.displayDebug(String, int)

Parameters:

debug - The debug message.

minDebugLevel - The minimum level that debug level should have, to display this message. Values can go from 0 to 100.

getSvnProperties

public static Properties getSvnProperties()

Helper function, to get the Revision number, if available. The applet must be built from the build.xml ant file.

Returns:

The svn properties

registerUnload

public void registerUnload(Object object,
                           String method)

Register a callback to be executed during applet termination.

Specified by:

registerUnload in interface JUploadContext

Parameters:

object - The Object instance to be registered

method - The Method of that object to be registered. The method must be of type void and must not take any parameters and must be public.

runUnload

public void runUnload()

Runs all callback that must be called when releasing the applet.

Specified by:

runUnload in interface JUploadContext

parseInt

public int parseInt(String value,
                    int def)

This function try to parse value as an integer. If value is not a correct integer, def is returned.

Specified by:

parseInt in interface JUploadContext

Parameters:

value - The string value, that must be parsed

def - The default value

Returns:

The integer value of value, or def if value is not valid.

parseFloat

public float parseFloat(String value,
                        float def)

This function try to parse value as a float number. If value is not a correct float, def is returned.

Specified by:

parseFloat in interface JUploadContext

Parameters:

value - The string value, that must be parsed

def - The default value

Returns:

The float value of value, or def if value is not valid.

parseLong

public long parseLong(String value,
                      long def)

This function try to parse value as a Long. If value is not a correct long, def is returned.

Specified by:

parseLong in interface JUploadContext

Parameters:

value - The string value, that must be parsed

def - The default value

Returns:

The integer value of value, or def if value is not valid.

parseBoolean

public boolean parseBoolean(String value,
                            boolean def)

This function try to parse value as a boolean. If value is not a correct boolean, def is returned.

Specified by:

parseBoolean in interface JUploadContext

Parameters:

value - The new value for this property. If invalid, the default value is used.

def - The default value: used if value is invalid.

Returns:

The boolean value of value, or def if value is not a valid boolean.

parseFileListViewMode

public FilePanel.FileListViewMode parseFileListViewMode(String value,
                                                        FilePanel.FileListViewMode def)

This function try to parse value as a FilePanel.FileListViewMode. If value is not a correct FilePanel.FileListViewMode, a warning is logged, and def is returned.

Specified by:

parseFileListViewMode in interface JUploadContext

Parameters:

value - The new value for this property. If invalid, the default value is used.

def - The default value: used if value is invalid.

Returns:

The FilePanel.FileListViewMode value of value, or def if value is not a valid FilePanel.FileListViewMode.

setWaitCursor

public Cursor setWaitCursor()

Description copied from interface: JUploadContext

Sets the wait cursor on the current application (applet, executable...).

Specified by:

setWaitCursor in interface JUploadContext

Returns:

The cursor that was active before the call to this method

See Also:

JUploadContext.setCursor(Cursor)

displayURL

public void displayURL(String url,
                       boolean success)

Just throws a UnsupportedOperationException exception.

Specified by:

displayURL in interface JUploadContext

Parameters:

url -

success -

getApplet

public JApplet getApplet()

Just throws a UnsupportedOperationException exception.

Specified by:

getApplet in interface JUploadContext

Returns:

Not used

getFrame

public Frame getFrame()

Description copied from interface: JUploadContext

Returns the current frame. Can be used to attach Dialog, for instance.

Specified by:

getFrame in interface JUploadContext

Returns:

The current frame

See Also:

JUploadContext.getFrame()

getCursor

public Cursor getCursor()

Just throws a UnsupportedOperationException exception.

Specified by:

getCursor in interface JUploadContext

Returns:

Not used.

See Also:

UploadPolicy.setCursor(Cursor)

getParameter

public String getParameter(String key,
                           String def)

Just throws a UnsupportedOperationException exception.

Specified by:

getParameter in interface JUploadContext

Parameters:

key -

def -

Returns:

Not used

getParameter

public int getParameter(String key,
                        int def)

Just throws a UnsupportedOperationException exception.

Specified by:

getParameter in interface JUploadContext

Parameters:

key -

def -

Returns:

Not used

getParameter

public float getParameter(String key,
                          float def)

Just throws a UnsupportedOperationException exception.

Specified by:

getParameter in interface JUploadContext

Parameters:

key -

def -

Returns:

Not used

getParameter

public long getParameter(String key,
                         long def)

Just throws a UnsupportedOperationException exception.

Specified by:

getParameter in interface JUploadContext

Parameters:

key -

def -

Returns:

Not used

getParameter

public boolean getParameter(String key,
                            boolean def)

Just throws a UnsupportedOperationException exception.

Specified by:

getParameter in interface JUploadContext

Parameters:

key -

def -

Returns:

Not used

getParameter

public FilePanel.FileListViewMode getParameter(String key,
                                               FilePanel.FileListViewMode def)

Just throws a UnsupportedOperationException exception.

Specified by:

getParameter in interface JUploadContext

Parameters:

key -

def -

Returns:

Not used

normalizeURL

public String normalizeURL(String url)
                    throws JUploadException

Just throws a UnsupportedOperationException exception.

Specified by:

normalizeURL in interface JUploadContext

Parameters:

url -

Returns:

Not used

Throws:

JUploadException

readCookieFromNavigator

public void readCookieFromNavigator(Vector<String> headers)

Just throws a UnsupportedOperationException exception.

Specified by:

readCookieFromNavigator in interface JUploadContext

Parameters:

headers -

readUserAgentFromNavigator

public void readUserAgentFromNavigator(Vector<String> headers)

Just throws a UnsupportedOperationException exception.

Specified by:

readUserAgentFromNavigator in interface JUploadContext

Parameters:

headers -

setCursor

public Cursor setCursor(Cursor cursor)

Just throws a UnsupportedOperationException exception.

Specified by:

setCursor in interface JUploadContext

Parameters:

cursor -

Returns:

Not used

See Also:

UploadPolicy.setCursor(Cursor)

showStatus

public void showStatus(String status)

Just throws a UnsupportedOperationException exception.

Specified by:

showStatus in interface JUploadContext

Parameters:

status -