nextapp.echo.filetransfer
Class Download

java.lang.Object
  nextapp.echo.AbstractComponent
      nextapp.echo.filetransfer.Download

All Implemented Interfaces:

java.io.Serializable, Component

public class Download
extends AbstractComponent

A component that causes the client to download a file. Emebedding this component within a displayed ContentPane will direct the client browser to download file. This component does not have any visual appearance.

See Also:

Serialized Form

Field Summary

Fields inherited from interface nextapp.echo.Component

BACKGROUND_CHANGED_PROPERTY, CHILDREN_CHANGED_PROPERTY, ENABLED_CHANGED_PROPERTY, FONT_CHANGED_PROPERTY, FOREGROUND_CHANGED_PROPERTY, IDENTIFIER_CHANGED_PROPERTY, LOCALE_CHANGED_PROPERTY, MODEL_CHANGED_PROPERTY, SELECTABLE_CHANGED_PROPERTY, STYLE_BACKGROUND, STYLE_FONT, STYLE_FOREGROUND, UPDATE_PROPERTY, VISIBLE_CHANGED_PROPERTY

Constructor Summary

Download()
Creates a new inactive Download component with no download provider.

Download(DownloadProvider provider, boolean active)
Creates a new Download component with the specified prodcuer and active state.

Method Summary

DownloadProvider	getProvider() Returns the DownloadProvider that will provide the file download.
boolean	isActive() Returns whether the download component is "active".
void	setActive(boolean newValue) Sets whether the download component is "active".
void	setProvider(DownloadProvider newValue) Sets the DownloadProvider that will provide the file download.

Methods inherited from class nextapp.echo.AbstractComponent

add, add, addHierarchyListener, addPropertyChangeListener, applyStyle, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getClientId, getComponent, getComponentCount, getComponents, getEchoInstance, getFont, getForeground, getIdentifier, getListenerList, getLocale, getParent, indexOf, init, isAncestorOf, isDifferent, isEnabled, isFocused, isRecursivelyVisible, isRegistered, isSelectableForScriptRecorder, isShowing, isVisible, processHierarchyEvent, remove, remove, removeAll, removeHierarchyListener, removePropertyChangeListener, setBackground, setClientId, setEnabled, setFocused, setFont, setForeground, setIdentifier, setLocale, setParent, setRegistered, setSelectableForScriptRecorder, setVisible, update, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

Download

public Download()

Creates a new inactive Download component with no download provider.

Download

public Download(DownloadProvider provider,
                boolean active)

Creates a new Download component with the specified prodcuer and active state.

Parameters:

provider - The DownloadProvider that will provide the file download.

active - True if the file should be immediately downloaded by the client.

Method Detail

getProvider

public DownloadProvider getProvider()

Returns the DownloadProvider that will provide the file download.

Returns:

The DownloadProvider that will provide the file download.

isActive

public boolean isActive()

Returns whether the download component is "active". If the component is active, it will cause the client to download the file.

Returns:

True if the file should be immediately downloaded by the client.

setActive

public void setActive(boolean newValue)

Sets whether the download component is "active". If the component is active, it will cause the client to download the file.

Parameters:

newValue - True if the file should be immediately downloaded by the client.

setProvider

public void setProvider(DownloadProvider newValue)

Sets the DownloadProvider that will provide the file download.

Parameters:

newValue - A DownloadProvider that will provide the file download.