EchoPoint
1.0

echopoint
Class PushButton

java.lang.Object
  extended bynextapp.echo.Component
      extended bynextapp.echo.AbstractButton
          extended bynextapp.echo.Button
              extended byechopoint.PushButton
All Implemented Interfaces:
Borderable, MouseCursorable, ReflectionSetter, java.io.Serializable, ToolTipPopUpSupport, nextapp.echo.ToolTipSupport, ValidationSubmitter
Direct Known Subclasses:
ConfirmButton, ExitButton, JavaScriptButton, SubmitButton

public class PushButton
extends nextapp.echo.Button
implements ToolTipPopUpSupport, Borderable, MouseCursorable, ValidationSubmitter, ReflectionSetter

The PushButton class is another implementation of the basic echo Button class.
This class use a more functional control on the client (if available) to represent button behavior.
If these controls are not available on the client, then the behavior of the base Button class is used.

Author:
Brad Baker
See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class echopoint.positionable.Borderable
Borderable.NestedStyleInfo
 
Nested classes inherited from class echopoint.positionable.MouseCursorable
MouseCursorable.NestedStyleInfo
 
Field Summary
static java.lang.String 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
PushButton()
          Creates a PushButton with no text or icon.
PushButton(nextapp.echo.ImageReference icon)
          Creates a PushButton with an icon.
PushButton(java.lang.String text)
          Creates a PushButton with text.
PushButton(java.lang.String text, nextapp.echo.ImageReference icon)
          Creates a PushButton with text and an icon.
 
Method Summary
 void applyStyle(nextapp.echo.Style style)
          This will apply the borderColor, borderWidth and borderStyle properties first followed by the left, top, right and bottom borer properties.
 nextapp.echo.Color getBorderColor()
           
 int getBorderSize()
           
 int getBorderStyle()
          Returns the border style of the Borderable.
 nextapp.echo.Color getBottomBorderColor()
           
 int getBottomBorderSize()
           
 int getBottomBorderStyle()
           
 nextapp.echo.Color getLeftBorderColor()
           
 int getLeftBorderSize()
           
 int getLeftBorderStyle()
           
 int getMouseCursor()
          Returns the current mouse cursor in use.
 java.lang.String getMouseCursorURI()
           
 nextapp.echo.Color getRightBorderColor()
           
 int getRightBorderSize()
           
 int getRightBorderStyle()
           
 int getRunOptions()
          Returns the server submit validation run options.
 ToolTipPopUp getToolTipPopUp()
          Returns the ToolTipPopUp component used to configure the rich tool tip support.
 java.lang.String getToolTipText()
           
 nextapp.echo.Color getTopBorderColor()
           
 int getTopBorderSize()
           
 int getTopBorderStyle()
           
 boolean isComplexRendering()
          Controls whether the PushButton will be rendered for more complex client browsers or whether it will gracefully fall back to standard Button rendering behaviour.
 boolean isValidationEnabled()
          Retruns whether server submit validation will occur.
 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 setBorderColor(nextapp.echo.Color newBorderColor)
          Sets the Color of the Borderable's border.
 void setBorderSize(int newBorderSize)
          Sets the size of the Borderables's border.
 void setBorderStyle(int borderStyle)
          Sets the border style of the Borderable.
 void setBottomBorderColor(nextapp.echo.Color borderColor)
          Sets the Color of the Borderable's bottom border.
 void setBottomBorderSize(int borderSize)
          Sets the size of the Borderables's bottom border.
 void setBottomBorderStyle(int borderStyle)
          Sets the border style of the Borderables's bottom border.
 void setComplexRendering(boolean newRendering)
          Controls whether the PushButton will be rendered for more complex client browsers or whether it will gracefully fall back to standard Button rendering behaviour.
 void setLeftBorderColor(nextapp.echo.Color borderColor)
          Sets the Color of the Borderable's left border.
 void setLeftBorderSize(int borderSize)
          Sets the size of the Borderables's left border.
 void setLeftBorderStyle(int borderStyle)
          Sets the border style of the Borderables's left border.
 void setMouseCursor(int mouseCursor)
          Sets the mouse cursor to use.
 void setMouseCursorURI(java.lang.String mouseCursorURI)
          Sets the URI to a custom platform mouse cursor.
 void setRightBorderColor(nextapp.echo.Color borderColor)
          Sets the Color of the Borderable's right border.
 void setRightBorderSize(int borderSize)
          Sets the size of the Borderables's right border.
 void setRightBorderStyle(int borderStyle)
          Sets the border style of the Borderables's right border.
 void setRunOptions(int runOptions)
          Sets the server submit validation run options.
 void setToolTipText(java.lang.String newValue)
           
 void setTopBorderColor(nextapp.echo.Color borderColor)
          Sets the Color of the Borderable's top border.
 void setTopBorderSize(int borderSize)
          Sets the size of the Borderables's top border.
 void setTopBorderStyle(int borderStyle)
          Sets the border style of the Borderables's top border.
 void setValidationEnabled(boolean validationEnabled)
          Controls whether server submit validation will occur.
 void 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

RENDERING_CHANGED_PROPERTY

public static final java.lang.String RENDERING_CHANGED_PROPERTY
See Also:
Constant Field Values
Constructor Detail

PushButton

public PushButton()
Creates a PushButton with no text or icon.


PushButton

public PushButton(java.lang.String text)
Creates a PushButton with text.

Parameters:
text - A text label to display in the button.

PushButton

public PushButton(java.lang.String text,
                  nextapp.echo.ImageReference icon)
Creates a PushButton with text and an icon.

Parameters:
text - A text label to display in the button.
icon - An icon to display in the button.

PushButton

public PushButton(nextapp.echo.ImageReference icon)
Creates a PushButton with an icon.

Parameters:
icon - An icon to display in the button.
Method Detail

isComplexRendering

public boolean isComplexRendering()
Controls whether the PushButton will be rendered for more complex client browsers or whether it will gracefully fall back to standard Button rendering behaviour.

Returns:
true or false

setComplexRendering

public void setComplexRendering(boolean newRendering)
Controls whether the PushButton will be rendered for more complex client browsers or whether it will gracefully fall back to standard Button rendering behaviour.


getBorderColor

public nextapp.echo.Color getBorderColor()
Specified by:
getBorderColor in interface Borderable
Returns:
The Color of the Borderable's border.
See Also:
Borderable.getBorderColor()

getBorderSize

public int getBorderSize()
Specified by:
getBorderSize in interface Borderable
Returns:
The size of the Borderables's border.
See Also:
Borderable.getBorderSize()

getBorderStyle

public int getBorderStyle()
Description copied from interface: Borderable
Returns the border style of the Borderable. This will be one of the following values :

Specified by:
getBorderStyle in interface Borderable
Returns:
int the current border style
See Also:
Borderable.getBorderStyle()

setBorderColor

public void setBorderColor(nextapp.echo.Color newBorderColor)
Description copied from interface: Borderable
Sets the Color of the Borderable's border. This will also set the left, top, right and bottom border color.

Specified by:
setBorderColor in interface Borderable
See Also:
Borderable.setBorderColor(nextapp.echo.Color)

setBorderSize

public void setBorderSize(int newBorderSize)
Description copied from interface: Borderable
Sets the size of the Borderables's border. This will also set the left, top, right and bottom border size.

Specified by:
setBorderSize in interface Borderable
See Also:
Borderable.setBorderSize(int)

setBorderStyle

public void setBorderStyle(int borderStyle)
Description copied from interface: Borderable
Sets the border style of the Borderable. This must be one of the following values : This will also set the left, top, right and bottom border style.

Specified by:
setBorderStyle in interface Borderable
See Also:
Borderable.setBorderStyle(int)

getLeftBorderColor

public nextapp.echo.Color getLeftBorderColor()
Specified by:
getLeftBorderColor in interface Borderable
Returns:
The Color of the Borderable's left border.
See Also:
Borderable.getLeftBorderColor()

getLeftBorderSize

public int getLeftBorderSize()
Specified by:
getLeftBorderSize in interface Borderable
Returns:
The size of the Borderables's left border.
See Also:
Borderable.getLeftBorderSize()

getLeftBorderStyle

public int getLeftBorderStyle()
Specified by:
getLeftBorderStyle in interface Borderable
Returns:
The style of the Borderables's left border.
See Also:
Borderable.getLeftBorderStyle()

setLeftBorderColor

public void setLeftBorderColor(nextapp.echo.Color borderColor)
Description copied from interface: Borderable
Sets the Color of the Borderable's left border.

Specified by:
setLeftBorderColor in interface Borderable
See Also:
Borderable.setLeftBorderColor(nextapp.echo.Color)

setLeftBorderSize

public void setLeftBorderSize(int borderSize)
Description copied from interface: Borderable
Sets the size of the Borderables's left border.

Specified by:
setLeftBorderSize in interface Borderable
See Also:
Borderable.setLeftBorderSize(int)

setLeftBorderStyle

public void setLeftBorderStyle(int borderStyle)
Description copied from interface: Borderable
Sets the border style of the Borderables's left border.

Specified by:
setLeftBorderStyle in interface Borderable
See Also:
Borderable.setLeftBorderStyle(int)

getTopBorderColor

public nextapp.echo.Color getTopBorderColor()
Specified by:
getTopBorderColor in interface Borderable
Returns:
The Color of the Borderable's top border.
See Also:
Borderable.getTopBorderColor()

getTopBorderSize

public int getTopBorderSize()
Specified by:
getTopBorderSize in interface Borderable
Returns:
The size of the Borderables's top border.
See Also:
Borderable.getTopBorderSize()

getTopBorderStyle

public int getTopBorderStyle()
Specified by:
getTopBorderStyle in interface Borderable
Returns:
The style of the Borderables's top border.
See Also:
Borderable.getTopBorderStyle()

setTopBorderColor

public void setTopBorderColor(nextapp.echo.Color borderColor)
Description copied from interface: Borderable
Sets the Color of the Borderable's top border.

Specified by:
setTopBorderColor in interface Borderable
See Also:
Borderable.setTopBorderColor(nextapp.echo.Color)

setTopBorderSize

public void setTopBorderSize(int borderSize)
Description copied from interface: Borderable
Sets the size of the Borderables's top border.

Specified by:
setTopBorderSize in interface Borderable
See Also:
Borderable.setTopBorderSize(int)

setTopBorderStyle

public void setTopBorderStyle(int borderStyle)
Description copied from interface: Borderable
Sets the border style of the Borderables's top border.

Specified by:
setTopBorderStyle in interface Borderable
See Also:
Borderable.setTopBorderStyle(int)

getRightBorderColor

public nextapp.echo.Color getRightBorderColor()
Specified by:
getRightBorderColor in interface Borderable
Returns:
The Color of the Borderable's right border.
See Also:
Borderable.getRightBorderColor()

getRightBorderSize

public int getRightBorderSize()
Specified by:
getRightBorderSize in interface Borderable
Returns:
The size of the Borderables's right border.
See Also:
Borderable.getRightBorderSize()

getRightBorderStyle

public int getRightBorderStyle()
Specified by:
getRightBorderStyle in interface Borderable
Returns:
The style of the Borderables's right border.
See Also:
Borderable.getRightBorderStyle()

setRightBorderColor

public void setRightBorderColor(nextapp.echo.Color borderColor)
Description copied from interface: Borderable
Sets the Color of the Borderable's right border.

Specified by:
setRightBorderColor in interface Borderable
See Also:
Borderable.setRightBorderColor(nextapp.echo.Color)

setRightBorderSize

public void setRightBorderSize(int borderSize)
Description copied from interface: Borderable
Sets the size of the Borderables's right border.

Specified by:
setRightBorderSize in interface Borderable
See Also:
Borderable.setRightBorderSize(int)

setRightBorderStyle

public void setRightBorderStyle(int borderStyle)
Description copied from interface: Borderable
Sets the border style of the Borderables's right border.

Specified by:
setRightBorderStyle in interface Borderable
See Also:
Borderable.setRightBorderStyle(int)

getBottomBorderColor

public nextapp.echo.Color getBottomBorderColor()
Specified by:
getBottomBorderColor in interface Borderable
Returns:
The Color of the Borderable's bottom border.
See Also:
Borderable.getBottomBorderColor()

getBottomBorderSize

public int getBottomBorderSize()
Specified by:
getBottomBorderSize in interface Borderable
Returns:
The size of the Borderables's bottom border.
See Also:
Borderable.getBottomBorderSize()

getBottomBorderStyle

public int getBottomBorderStyle()
Specified by:
getBottomBorderStyle in interface Borderable
Returns:
The style of the Borderables's bottom border.
See Also:
Borderable.getBottomBorderStyle()

setBottomBorderColor

public void setBottomBorderColor(nextapp.echo.Color borderColor)
Description copied from interface: Borderable
Sets the Color of the Borderable's bottom border.

Specified by:
setBottomBorderColor in interface Borderable
See Also:
Borderable.setBottomBorderColor(nextapp.echo.Color)

setBottomBorderSize

public void setBottomBorderSize(int borderSize)
Description copied from interface: Borderable
Sets the size of the Borderables's bottom border.

Specified by:
setBottomBorderSize in interface Borderable
See Also:
Borderable.setBottomBorderSize(int)

setBottomBorderStyle

public void setBottomBorderStyle(int borderStyle)
Description copied from interface: Borderable
Sets the border style of the Borderables's bottom border.

Specified by:
setBottomBorderStyle in interface Borderable
See Also:
Borderable.setBottomBorderStyle(int)

getToolTipPopUp

public ToolTipPopUp getToolTipPopUp()
Description copied from interface: ToolTipPopUpSupport
Returns the ToolTipPopUp component used to configure the rich tool tip support.

Specified by:
getToolTipPopUp in interface ToolTipPopUpSupport
Returns:
a ToolTipPopUp component
See Also:
ToolTipPopUpSupport.getToolTipPopUp()

getToolTipText

public java.lang.String getToolTipText()
Specified by:
getToolTipText in interface nextapp.echo.ToolTipSupport
See Also:
ToolTipSupport.getToolTipText()

setToolTipText

public void setToolTipText(java.lang.String newValue)
Specified by:
setToolTipText in interface nextapp.echo.ToolTipSupport
See Also:
ToolTipSupport.setToolTipText(java.lang.String)

isValidationEnabled

public boolean isValidationEnabled()
Retruns whether server submit validation will occur.

Specified by:
isValidationEnabled in interface ValidationSubmitter
Returns:
whether server submit validation will occur.
See Also:
ValidationSubmitter.isValidationEnabled()

setValidationEnabled

public void setValidationEnabled(boolean validationEnabled)
Controls whether server submit validation will occur.

Parameters:
validationEnabled - - true if validation should occur

getRunOptions

public int getRunOptions()
Returns the server submit validation run options.

Specified by:
getRunOptions in interface ValidationSubmitter
Returns:
the run options in place
See Also:
ValidationSubmitter.getRunOptions()

setRunOptions

public void setRunOptions(int runOptions)
Sets the server submit validation run options.

Parameters:
runOptions - - the server submit validation run options.
See Also:
ValidationSubmitter.getRunOptions()

getMouseCursor

public int getMouseCursor()
Description copied from interface: MouseCursorable
Returns the current mouse cursor in use. This will be one of the following values.

Specified by:
getMouseCursor in interface MouseCursorable
Returns:
The current mouse cursor in use.
See Also:
MouseCursorable.getMouseCursor()

getMouseCursorURI

public java.lang.String getMouseCursorURI()
Specified by:
getMouseCursorURI in interface MouseCursorable
Returns:
The custom URI for the mouse cursor or null
See Also:
MouseCursorable.getMouseCursorURI()

setMouseCursor

public void setMouseCursor(int mouseCursor)
Description copied from interface: MouseCursorable
Sets the mouse cursor to use. This will be one of the following values.

Specified by:
setMouseCursor in interface MouseCursorable
Parameters:
mouseCursor - - the mouse cursor to use
See Also:
MouseCursorable.setMouseCursor(int)

setMouseCursorURI

public void setMouseCursorURI(java.lang.String mouseCursorURI)
Description copied from interface: MouseCursorable
Sets the URI to a custom platform mouse cursor. This will only be used if the mosue cusor is set to CURSOR_CUSTOM.

Specified by:
setMouseCursorURI in interface MouseCursorable
Parameters:
mouseCursorURI - the URI to a custom platform mouse cursor.
See Also:
MouseCursorable.setMouseCursorURI(java.lang.String)

validate

public void validate()
See Also:
Component.validate()

applyStyle

public void applyStyle(nextapp.echo.Style style)
Description copied from interface: Borderable
This will apply the borderColor, borderWidth and borderStyle properties first followed by the left, top, right and bottom borer properties.

Specified by:
applyStyle in interface Borderable
See Also:
Borderable.applyStyle(nextapp.echo.Style)

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
Parameters:
field - - the field to be set
newValue - - the new value to be set
Returns:
the oldValue of the field
Throws:
java.lang.Exception
See Also:
ReflectionSetter.set(Field, Object)

EchoPoint
1.0