echopoint
Class ExitButton

java.lang.Object
  nextapp.echo.Component
      nextapp.echo.AbstractButton
          nextapp.echo.Button
              echopoint.PushButton
                  echopoint.ExitButton

All Implemented Interfaces:

nextapp.echo.event.ActionListener, Borderable, java.util.EventListener, MouseCursorable, ReflectionSetter, java.io.Serializable, ToolTipPopUpSupport, nextapp.echo.ToolTipSupport, ValidationSubmitter

public class ExitButton

extends PushButton

implements nextapp.echo.event.ActionListener

The ExitButton class is an implementation of the basic echo Button component that allows linking to other web URI,leaving the echo web application is a consistent state.

Echo application instances must be exited or suspended if another URL link is to be followed. This component allows you to do just that.

Author:

Brad Baker

See Also:

Serialized Form

Nested Class Summary

static class

ExitButton.NestedStyleInfo Nested public static StyleInfo class.

Field Summary

static java.lang.String	MODE_CHANGED_PROPERTY
static java.lang.String	STYLE_EXIT_MODE A style constant for the ExitMode property.
static java.lang.String	STYLE_URI A style constant for the URI property.
static java.lang.String	URI_CHANGED_PROPERTY

Fields inherited from class echopoint.PushButton

RENDERING_CHANGED_PROPERTY

Fields inherited from class nextapp.echo.AbstractButton

ACTION_COMMAND_CHANGED_PROPERTY, HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY, HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY, ICON_CHANGED_PROPERTY, ICON_TEXT_MARGIN_CHANGED_PROPERTY, MODEL_CHANGED_PROPERTY, ROLLOVER_BACKGROUND_CHANGED_PROPERTY, ROLLOVER_ENABLED_CHANGED_PROPERTY, ROLLOVER_FONT_CHANGED_PROPERTY, ROLLOVER_FOREGROUND_CHANGED_PROPERTY, ROLLOVER_ICON_CHANGED_PROPERTY, ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY, SELECTED_CHANGED_PROPERTY, SELECTED_ICON_CHANGED_PROPERTY, STYLE_HORIZONTAL_ALIGNMENT, STYLE_HORIZONTAL_TEXT_POSITION, STYLE_ICON_TEXT_MARGIN, STYLE_ROLLOVER_BACKGROUND, STYLE_ROLLOVER_ENABLED, STYLE_ROLLOVER_FONT, STYLE_ROLLOVER_FOREGROUND, STYLE_VERTICAL_ALIGNMENT, STYLE_VERTICAL_TEXT_POSITION, TEXT_CHANGED_PROPERTY, VERTICAL_ALIGNMENT_CHANGED_PROPERTY, VERTICAL_TEXT_POSITION_CHANGED_PROPERTY

Fields inherited from class nextapp.echo.Component

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

Fields inherited from interface nextapp.echo.ToolTipSupport

TOOL_TIP_TEXT_CHANGED_PROPERTY

Fields inherited from interface echopoint.positionable.Borderable

BORDER_DASHED, BORDER_DOTTED, BORDER_DOUBLE, BORDER_GROOVE, BORDER_INSET, BORDER_NONE, BORDER_OUTSET, BORDER_RIDGE, BORDER_SOLID, borderStyleSymbolics, STYLE_BORDER_COLOR, STYLE_BORDER_SIZE, STYLE_BORDER_STYLE, STYLE_BOTTOM_BORDER_COLOR, STYLE_BOTTOM_BORDER_SIZE, STYLE_BOTTOM_BORDER_STYLE, STYLE_LEFT_BORDER_COLOR, STYLE_LEFT_BORDER_SIZE, STYLE_LEFT_BORDER_STYLE, STYLE_RIGHT_BORDER_COLOR, STYLE_RIGHT_BORDER_SIZE, STYLE_RIGHT_BORDER_STYLE, STYLE_TOP_BORDER_COLOR, STYLE_TOP_BORDER_SIZE, STYLE_TOP_BORDER_STYLE

Fields inherited from interface echopoint.positionable.MouseCursorable

borderStyleSymbolics, CURSOR_AUTO, CURSOR_CROSSHAIR, CURSOR_CUSTOM_URI, CURSOR_DEFAULT, CURSOR_E_RESIZE, CURSOR_HELP, CURSOR_MOVE, CURSOR_N_RESIZE, CURSOR_NE_RESIZE, CURSOR_NW_RESIZE, CURSOR_POINTER, CURSOR_S_RESIZE, CURSOR_SE_RESIZE, CURSOR_SW_RESIZE, CURSOR_TEXT, CURSOR_W_RESIZE, CURSOR_WAIT, STYLE_MOUSE_CURSOR, STYLE_MOUSE_CURSOR_URI

Fields inherited from interface echopoint.validation.ValidationSubmitter

RULESETS_RUN_ALL, RULESETS_RUN_DEFAULT

Constructor Summary

ExitButton()
Creates an ExitButton with no text or icon.

ExitButton(java.lang.String text)
Creates an ExitButton with text.

ExitButton(java.lang.String uri, nextapp.echo.ImageReference icon)
Creates an ExitButton with an icon.

ExitButton(java.lang.String uri, java.lang.String text)
Creates an ExitButton with text.

ExitButton(java.lang.String uri, java.lang.String text, nextapp.echo.ImageReference icon)
Creates an ExitButton with text and an icon.

Method Summary

void	actionPerformed(nextapp.echo.event.ActionEvent e) The button is an action listener on itself and if its pressed then the application will be suspended or exited, depending on exit mode.
void	applyStyle(nextapp.echo.Style style) Applies the provided style to the component.
java.lang.String	getURI() Returns the URI that will be shown if the button is pressed
boolean	isExitMode() Returns true if the button is in exit mode.
java.lang.Object	set(java.lang.reflect.Field field, java.lang.Object newValue) Called to save the old value of a field, set in a new value and return the old value of a field.
void	setExitMode(boolean newMode) Sets wheteher the echo application will be exited or suspended when this button is pressed.
void	setURI(java.lang.String newURI) Sets the web URI that will invoked if this button is pressed.

Methods inherited from class echopoint.PushButton

getBorderColor, getBorderSize, getBorderStyle, getBottomBorderColor, getBottomBorderSize, getBottomBorderStyle, getLeftBorderColor, getLeftBorderSize, getLeftBorderStyle, getMouseCursor, getMouseCursorURI, getRightBorderColor, getRightBorderSize, getRightBorderStyle, getRunOptions, getToolTipPopUp, getToolTipText, getTopBorderColor, getTopBorderSize, getTopBorderStyle, isComplexRendering, isValidationEnabled, setBorderColor, setBorderSize, setBorderStyle, setBottomBorderColor, setBottomBorderSize, setBottomBorderStyle, setComplexRendering, setLeftBorderColor, setLeftBorderSize, setLeftBorderStyle, setMouseCursor, setMouseCursorURI, setRightBorderColor, setRightBorderSize, setRightBorderStyle, setRunOptions, setToolTipText, setTopBorderColor, setTopBorderSize, setTopBorderStyle, setValidationEnabled, validate

Methods inherited from class nextapp.echo.AbstractButton

addActionListener, addChangeListener, addItemListener, doAction, fireActionPerformed, fireItemStateChanged, fireStateChanged, getActionCommand, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextMargin, getModel, getRolloverBackground, getRolloverFont, getRolloverForeground, getRolloverIcon, getRolloverSelectedIcon, getSelectedIcon, getText, getVerticalAlignment, getVerticalTextPosition, hasActionListeners, isRolloverEnabled, isSelected, removeActionListener, removeChangeListener, removeItemListener, setActionCommand, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextMargin, setModel, setRolloverBackground, setRolloverEnabled, setRolloverFont, setRolloverForeground, setRolloverIcon, setRolloverSelectedIcon, setSelected, setSelectedIcon, setText, setVerticalAlignment, setVerticalTextPosition

Methods inherited from class nextapp.echo.Component

add, add, addHierarchyListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getComponent, getComponentCount, getComponents, getEchoInstance, getFont, getForeground, getIdentifier, getLocale, getParent, indexOf, init, isAncestorOf, isEnabled, isRegistered, isShowing, isVisible, remove, remove, removeAll, removeHierarchyListener, removePropertyChangeListener, setBackground, setEnabled, setFont, setForeground, setIdentifier, setLocale, setVisible, update

Methods inherited from class java.lang.Object

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

Field Detail

MODE_CHANGED_PROPERTY

public static final java.lang.String MODE_CHANGED_PROPERTY

See Also:

Constant Field Values

URI_CHANGED_PROPERTY

public static final java.lang.String URI_CHANGED_PROPERTY

See Also:

Constant Field Values

STYLE_EXIT_MODE

public static final java.lang.String STYLE_EXIT_MODE

A style constant for the ExitMode property. Values of this key must be of type boolean

See Also:

Constant Field Values

STYLE_URI

public static final java.lang.String STYLE_URI

A style constant for the URI property. Values of this key must be of type String

See Also:

Constant Field Values

Constructor Detail

ExitButton

public ExitButton()

Creates an ExitButton with no text or icon.

ExitButton

public ExitButton(java.lang.String text)

Creates an ExitButton with text.

ExitButton

public ExitButton(java.lang.String uri,
                  nextapp.echo.ImageReference icon)

Creates an ExitButton with an icon.

ExitButton

public ExitButton(java.lang.String uri,
                  java.lang.String text)

Creates an ExitButton with text.

ExitButton

public ExitButton(java.lang.String uri,
                  java.lang.String text,
                  nextapp.echo.ImageReference icon)

Creates an ExitButton with text and an icon.

Method Detail

actionPerformed

public void actionPerformed(nextapp.echo.event.ActionEvent e)

The button is an action listener on itself and if its pressed then the application will be suspended or exited, depending on exit mode.

Specified by:

actionPerformed in interface nextapp.echo.event.ActionListener

applyStyle

public void applyStyle(nextapp.echo.Style style)

Applies the provided style to the component. The base nextapp.echo.Component style names can be used as well.

Specified by:

applyStyle in interface Borderable

Overrides:

applyStyle in class PushButton

See Also:

Borderable.applyStyle(nextapp.echo.Style)

getURI

public java.lang.String getURI()

Returns the URI that will be shown if the button is pressed

isExitMode

public boolean isExitMode()

Returns true if the button is in exit mode. That is the application will exit (and not suspend) if pressed.

setExitMode

public void setExitMode(boolean newMode)

Sets wheteher the echo application will be exited or suspended when this button is pressed.

setURI

public void setURI(java.lang.String newURI)

Sets the web URI that will invoked if this button is pressed.

set

public java.lang.Object set(java.lang.reflect.Field field,
                            java.lang.Object newValue)
                     throws java.lang.Exception

Description copied from interface: ReflectionSetter

Called to save the old value of a field, set in a new value and return the old value of a field. This interface allows a field set operation to be "delegated" back into the class that has permission to perform the field set.

 public Object set(Field f, Object newValue) throws Exception {
      Object oldValue = f.get(this);
      f.set(this,newValue);
      return oldValue;
 }
 

Specified by:

set in interface ReflectionSetter

Overrides:

set in class PushButton

Throws:

java.lang.Exception

See Also:

ReflectionSetter.set(Field, Object)