echopoint.tucana
Class DownloadButton

java.lang.Object
  nextapp.echo.app.Component
      nextapp.echo.app.button.AbstractButton
          nextapp.echo.app.Button
              echopoint.tucana.DownloadButton

All Implemented Interfaces:

Serializable, RenderIdSupport

public class DownloadButton
extends Button

A convenience component to display a DownloadCommand as a button with a pre-configured ActionListener.

The following shows sample use of this component:

   import echopoint.Strut;
   import echopoint.tucana.DownloadButton;
   import nextapp.echo.app.Row;
   import java.io.File;

     ...
     final File file = new File( "/path/tofile" );
     final Row row = new Row();
     final DownloadButton button = new DownloadButton( file );
     button.setText( "Download File" );
     row.add( new Strut() );
     row.add( button );
     row.add( new Strut() );
 

Version:

$Id: DownloadButton.java 248 2009-10-19 14:20:53Z sptrakesh $

Author:

Rakesh 2008-11-11

See Also:

Serialized Form

Field Summary

Fields inherited from class nextapp.echo.app.button.AbstractButton

ACTION_LISTENERS_CHANGED_PROPERTY, INPUT_ACTION, PROPERTY_ALIGNMENT, PROPERTY_BACKGROUND_IMAGE, PROPERTY_BORDER, PROPERTY_DISABLED_BACKGROUND, PROPERTY_DISABLED_BACKGROUND_IMAGE, PROPERTY_DISABLED_BORDER, PROPERTY_DISABLED_FONT, PROPERTY_DISABLED_FOREGROUND, PROPERTY_DISABLED_ICON, PROPERTY_FOCUSED_BACKGROUND, PROPERTY_FOCUSED_BACKGROUND_IMAGE, PROPERTY_FOCUSED_BORDER, PROPERTY_FOCUSED_ENABLED, PROPERTY_FOCUSED_FONT, PROPERTY_FOCUSED_FOREGROUND, PROPERTY_FOCUSED_ICON, PROPERTY_HEIGHT, PROPERTY_ICON, PROPERTY_ICON_TEXT_MARGIN, PROPERTY_INSETS, PROPERTY_LINE_WRAP, PROPERTY_MODEL, PROPERTY_PRESSED_BACKGROUND, PROPERTY_PRESSED_BACKGROUND_IMAGE, PROPERTY_PRESSED_BORDER, PROPERTY_PRESSED_ENABLED, PROPERTY_PRESSED_FONT, PROPERTY_PRESSED_FOREGROUND, PROPERTY_PRESSED_ICON, PROPERTY_ROLLOVER_BACKGROUND, PROPERTY_ROLLOVER_BACKGROUND_IMAGE, PROPERTY_ROLLOVER_BORDER, PROPERTY_ROLLOVER_ENABLED, PROPERTY_ROLLOVER_FONT, PROPERTY_ROLLOVER_FOREGROUND, PROPERTY_ROLLOVER_ICON, PROPERTY_TEXT, PROPERTY_TEXT_ALIGNMENT, PROPERTY_TEXT_POSITION, PROPERTY_TOOL_TIP_TEXT, PROPERTY_WIDTH

Fields inherited from class nextapp.echo.app.Component

CHILD_VISIBLE_CHANGED_PROPERTY, CHILDREN_CHANGED_PROPERTY, ENABLED_CHANGED_PROPERTY, FOCUS_NEXT_ID_CHANGED_PROPERTY, FOCUS_PREVIOUS_ID_CHANGED_PROPERTY, LAYOUT_DIRECTION_CHANGED_PROPERTY, LOCALE_CHANGED_PROPERTY, PROPERTY_BACKGROUND, PROPERTY_FONT, PROPERTY_FOREGROUND, PROPERTY_LAYOUT_DATA, STYLE_CHANGED_PROPERTY, STYLE_NAME_CHANGED_PROPERTY, VISIBLE_CHANGED_PROPERTY

Constructor Summary

DownloadButton(DownloadProvider provider)
Create a new instance for the specified download provider.

DownloadButton(File file)
Create a new instance for the specified file (using a FileDownloadProvider.

DownloadButton(InputStream stream)
Create a new instance using the input stream to feed a InputStreamDownloadProvider.

Method Summary

void	addActionListener(ActionListener listener) Over-ridden to not allow any other listeners than the default.
DownloadCallback	getDownloadCallback() Accessor for property 'callback'.
DownloadProvider	getProvider() Accessor for property 'provider'.
void	setDownloadCallback(DownloadCallback callback) Mutator for property 'callback'.
void	setProvider(DownloadProvider provider) Mutator for property 'provider'.
void	setProvider(File file) Mutator for property 'provider'.

Methods inherited from class nextapp.echo.app.button.AbstractButton

doAction, fireActionPerformed, getActionCommand, getAlignment, getBackgroundImage, getBorder, getDisabledBackground, getDisabledBackgroundImage, getDisabledBorder, getDisabledFont, getDisabledForeground, getDisabledIcon, getFocusedBackground, getFocusedBackgroundImage, getFocusedBorder, getFocusedFont, getFocusedForeground, getFocusedIcon, getHeight, getIcon, getIconTextMargin, getInsets, getModel, getPressedBackground, getPressedBackgroundImage, getPressedBorder, getPressedFont, getPressedForeground, getPressedIcon, getRolloverBackground, getRolloverBackgroundImage, getRolloverBorder, getRolloverFont, getRolloverForeground, getRolloverIcon, getText, getTextAlignment, getTextPosition, getToolTipText, getWidth, hasActionListeners, isFocusedEnabled, isLineWrap, isPressedEnabled, isRolloverEnabled, isValidChild, processInput, removeActionListener, setActionCommand, setAlignment, setBackgroundImage, setBorder, setDisabledBackground, setDisabledBackgroundImage, setDisabledBorder, setDisabledFont, setDisabledForeground, setDisabledIcon, setFocusedBackground, setFocusedBackgroundImage, setFocusedBorder, setFocusedEnabled, setFocusedFont, setFocusedForeground, setFocusedIcon, setHeight, setIcon, setIconTextMargin, setInsets, setLineWrap, setModel, setPressedBackground, setPressedBackgroundImage, setPressedBorder, setPressedEnabled, setPressedFont, setPressedForeground, setPressedIcon, setRolloverBackground, setRolloverBackgroundImage, setRolloverBorder, setRolloverEnabled, setRolloverFont, setRolloverForeground, setRolloverIcon, setText, setTextAlignment, setTextPosition, setToolTipText, setWidth

Methods inherited from class nextapp.echo.app.Component

add, add, addPropertyChangeListener, addPropertyChangeListener, dispose, firePropertyChange, get, getApplicationInstance, getBackground, getComponent, getComponent, getComponentCount, getComponents, getEventListenerList, getFocusNextId, getFocusPreviousId, getFont, getForeground, getId, getIndex, getLayoutData, getLayoutDirection, getLocale, getLocalStyle, getParent, getRenderId, getRenderIndexedProperty, getRenderIndexedProperty, getRenderLocale, getRenderProperty, getRenderProperty, getStyle, getStyleName, getVisibleComponent, getVisibleComponentCount, getVisibleComponents, hasEventListenerList, indexOf, init, isAncestorOf, isEnabled, isFocusTraversalParticipant, isRegistered, isRenderEnabled, isRenderVisible, isValidParent, isVisible, remove, remove, removeAll, removePropertyChangeListener, removePropertyChangeListener, set, setBackground, setComponents, setEnabled, setFocusNextId, setFocusPreviousId, setFocusTraversalParticipant, setFont, setForeground, setId, setIndex, setLayoutData, setLayoutDirection, setLocale, setRenderId, setStyle, setStyleName, setVisible, validate, verifyInput, visibleIndexOf

Methods inherited from class java.lang.Object

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

Constructor Detail

DownloadButton

public DownloadButton(DownloadProvider provider)

Create a new instance for the specified download provider. This is the designated constructor.

Parameters:

provider - The download provider to use with the DownloadCommand

DownloadButton

public DownloadButton(File file)

Create a new instance for the specified file (using a FileDownloadProvider.

Parameters:

file - The file to be enqueued for download.

DownloadButton

public DownloadButton(InputStream stream)

Create a new instance using the input stream to feed a InputStreamDownloadProvider.

Parameters:

stream - The input stream to use as the data source.

Method Detail

getProvider

public DownloadProvider getProvider()

Accessor for property 'provider'.

Returns:

Value for property 'provider'.

addActionListener

public void addActionListener(ActionListener listener)

Over-ridden to not allow any other listeners than the default. Does not throw any exception, just ignores the call.

Overrides:

addActionListener in class AbstractButton

Parameters:

listener - The listener to add.

setProvider

public void setProvider(DownloadProvider provider)

Mutator for property 'provider'.

Parameters:

provider - Value to set for property 'provider'.

setProvider

public void setProvider(File file)

Mutator for property 'provider'.

Parameters:

file - The file to be enqueued for download.

getDownloadCallback

public DownloadCallback getDownloadCallback()

Accessor for property 'callback'.

Returns:

Value for property 'callback'.

setDownloadCallback

public void setDownloadCallback(DownloadCallback callback)

Mutator for property 'callback'.

Parameters:

callback - Value to set for property 'callback'.