|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnextapp.echo.AbstractComponent
nextapp.echo.AbstractButton
nextapp.echo.Button
echopoint.PushButton
public class PushButton
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.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface echopoint.positionable.Borderable |
---|
Borderable.NestedStyleInfo |
Nested classes/interfaces inherited from interface echopoint.positionable.MouseCursorable |
---|
MouseCursorable.NestedStyleInfo |
Field Summary | |
---|---|
static java.lang.String |
HEIGHT_CHANGED_PROPERTY
|
static java.lang.String |
RENDERING_CHANGED_PROPERTY
|
static java.lang.String |
STYLE_BUTTON_HEIGHT
A style constant for the Button height property. |
static java.lang.String |
STYLE_BUTTON_WIDTH
A style constant for the Button width property. |
static java.lang.String |
WIDTH_CHANGED_PROPERTY
|
Fields inherited from interface nextapp.echo.ToolTipSupport |
---|
TOOL_TIP_TEXT_CHANGED_PROPERTY |
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(ImageReference icon)
Creates a PushButton with an icon. |
|
PushButton(java.lang.String text)
Creates a PushButton with text. |
|
PushButton(java.lang.String text,
ImageReference icon)
Creates a PushButton with text and an icon. |
Method Summary | |
---|---|
void |
applyStyle(Style style)
Sets stylistic properties of this component based on a Style
object. |
Color |
getBorderColor()
|
int |
getBorderSize()
|
int |
getBorderStyle()
Returns the border style of the Borderable. |
Color |
getBottomBorderColor()
|
int |
getBottomBorderSize()
|
int |
getBottomBorderStyle()
|
int |
getHeight()
|
Color |
getLeftBorderColor()
|
int |
getLeftBorderSize()
|
int |
getLeftBorderStyle()
|
int |
getMouseCursor()
Returns the current mouse cursor in use. |
java.lang.String |
getMouseCursorURI()
|
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()
Returns the default tool tip text. |
Color |
getTopBorderColor()
|
int |
getTopBorderSize()
|
int |
getTopBorderStyle()
|
int |
getWidth()
|
boolean |
isAsync()
|
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 |
setAsync(boolean async)
|
void |
setBorderColor(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(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 |
setHeight(int height)
|
void |
setLeftBorderColor(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(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)
Sets the default tool tip text. |
void |
setTopBorderColor(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 |
setWidth(int width)
|
void |
validate()
Validates this component. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String STYLE_BUTTON_WIDTH
public static final java.lang.String STYLE_BUTTON_HEIGHT
public static final java.lang.String WIDTH_CHANGED_PROPERTY
public static final java.lang.String HEIGHT_CHANGED_PROPERTY
public static final java.lang.String RENDERING_CHANGED_PROPERTY
Constructor Detail |
---|
public PushButton()
PushButton
with no text or icon.
public PushButton(java.lang.String text)
PushButton
with text.
text
- A text label to display in the button.public PushButton(java.lang.String text, ImageReference icon)
PushButton
with text and an icon.
text
- A text label to display in the button.icon
- An icon to display in the button.public PushButton(ImageReference icon)
PushButton
with an icon.
icon
- An icon to display in the button.Method Detail |
---|
public int getHeight()
public void setHeight(int height)
public int getWidth()
public void setWidth(int width)
public boolean isComplexRendering()
PushButton
will be rendered for more
complex client browsers or whether it will gracefully fall back to
standard Button rendering behaviour.
public void setComplexRendering(boolean newRendering)
PushButton
will be rendered for more
complex client browsers or whether it will gracefully fall back to
standard Button rendering behaviour.
public Color getBorderColor()
getBorderColor
in interface Borderable
Color
of the Borderable's
border.Borderable.getBorderColor()
public int getBorderSize()
getBorderSize
in interface Borderable
Borderables's
border.Borderable.getBorderSize()
public int getBorderStyle()
Borderable
getBorderStyle
in interface Borderable
Borderable.getBorderStyle()
public void setBorderColor(Color newBorderColor)
Borderable
Color
of the Borderable's
border.
This will also set the left, top, right and bottom border color.
setBorderColor
in interface Borderable
Borderable.setBorderColor(nextapp.echo.Color)
public void setBorderSize(int newBorderSize)
Borderable
Borderables's
border.
This will also set the left, top, right and bottom border size.
setBorderSize
in interface Borderable
Borderable.setBorderSize(int)
public void setBorderStyle(int borderStyle)
Borderable
setBorderStyle
in interface Borderable
Borderable.setBorderStyle(int)
public Color getLeftBorderColor()
getLeftBorderColor
in interface Borderable
Color
of the Borderable's
left border.Borderable.getLeftBorderColor()
public int getLeftBorderSize()
getLeftBorderSize
in interface Borderable
Borderables's
left border.Borderable.getLeftBorderSize()
public int getLeftBorderStyle()
getLeftBorderStyle
in interface Borderable
Borderables's
left border.Borderable.getLeftBorderStyle()
public void setLeftBorderColor(Color borderColor)
Borderable
Color
of the Borderable's
left border.
setLeftBorderColor
in interface Borderable
Borderable.setLeftBorderColor(nextapp.echo.Color)
public void setLeftBorderSize(int borderSize)
Borderable
Borderables's
left border.
setLeftBorderSize
in interface Borderable
Borderable.setLeftBorderSize(int)
public void setLeftBorderStyle(int borderStyle)
Borderable
Borderables's
left border.
setLeftBorderStyle
in interface Borderable
Borderable.setLeftBorderStyle(int)
public Color getTopBorderColor()
getTopBorderColor
in interface Borderable
Color
of the Borderable's
top border.Borderable.getTopBorderColor()
public int getTopBorderSize()
getTopBorderSize
in interface Borderable
Borderables's
top border.Borderable.getTopBorderSize()
public int getTopBorderStyle()
getTopBorderStyle
in interface Borderable
Borderables's
top border.Borderable.getTopBorderStyle()
public void setTopBorderColor(Color borderColor)
Borderable
Color
of the Borderable's
top border.
setTopBorderColor
in interface Borderable
Borderable.setTopBorderColor(nextapp.echo.Color)
public void setTopBorderSize(int borderSize)
Borderable
Borderables's
top border.
setTopBorderSize
in interface Borderable
Borderable.setTopBorderSize(int)
public void setTopBorderStyle(int borderStyle)
Borderable
Borderables's
top border.
setTopBorderStyle
in interface Borderable
Borderable.setTopBorderStyle(int)
public Color getRightBorderColor()
getRightBorderColor
in interface Borderable
Color
of the Borderable's
right border.Borderable.getRightBorderColor()
public int getRightBorderSize()
getRightBorderSize
in interface Borderable
Borderables's
right border.Borderable.getRightBorderSize()
public int getRightBorderStyle()
getRightBorderStyle
in interface Borderable
Borderables's
right border.Borderable.getRightBorderStyle()
public void setRightBorderColor(Color borderColor)
Borderable
Color
of the Borderable's
right border.
setRightBorderColor
in interface Borderable
Borderable.setRightBorderColor(nextapp.echo.Color)
public void setRightBorderSize(int borderSize)
Borderable
Borderables's
right border.
setRightBorderSize
in interface Borderable
Borderable.setRightBorderSize(int)
public void setRightBorderStyle(int borderStyle)
Borderable
Borderables's
right border.
setRightBorderStyle
in interface Borderable
Borderable.setRightBorderStyle(int)
public Color getBottomBorderColor()
getBottomBorderColor
in interface Borderable
Color
of the Borderable's
bottom border.Borderable.getBottomBorderColor()
public int getBottomBorderSize()
getBottomBorderSize
in interface Borderable
Borderables's
bottom border.Borderable.getBottomBorderSize()
public int getBottomBorderStyle()
getBottomBorderStyle
in interface Borderable
Borderables's
bottom border.Borderable.getBottomBorderStyle()
public void setBottomBorderColor(Color borderColor)
Borderable
Color
of the Borderable's
bottom border.
setBottomBorderColor
in interface Borderable
Borderable.setBottomBorderColor(nextapp.echo.Color)
public void setBottomBorderSize(int borderSize)
Borderable
Borderables's
bottom border.
setBottomBorderSize
in interface Borderable
Borderable.setBottomBorderSize(int)
public void setBottomBorderStyle(int borderStyle)
Borderable
Borderables's
bottom border.
setBottomBorderStyle
in interface Borderable
Borderable.setBottomBorderStyle(int)
public ToolTipPopUp getToolTipPopUp()
ToolTipPopUpSupport
ToolTipPopUp
component used to
configure the rich tool tip support.
getToolTipPopUp
in interface ToolTipPopUpSupport
ToolTipPopUpSupport.getToolTipPopUp()
public java.lang.String getToolTipText()
ToolTipSupport
getToolTipText
in interface ToolTipSupport
getToolTipText
in class AbstractButton
ToolTipSupport.getToolTipText()
public void setToolTipText(java.lang.String newValue)
ToolTipSupport
setToolTipText
in interface ToolTipSupport
setToolTipText
in class AbstractButton
newValue
- The new tool tip text.ToolTipSupport.setToolTipText(java.lang.String)
public boolean isValidationEnabled()
isValidationEnabled
in interface ValidationSubmitter
ValidationSubmitter.isValidationEnabled()
public void setValidationEnabled(boolean validationEnabled)
validationEnabled
- -
true if validation should occurpublic int getRunOptions()
getRunOptions
in interface ValidationSubmitter
ValidationSubmitter.getRunOptions()
public void setRunOptions(int runOptions)
runOptions
- -
the server submit validation run options.ValidationSubmitter.getRunOptions()
public int getMouseCursor()
MouseCursorable
getMouseCursor
in interface MouseCursorable
MouseCursorable.getMouseCursor()
public java.lang.String getMouseCursorURI()
getMouseCursorURI
in interface MouseCursorable
MouseCursorable.getMouseCursorURI()
public void setMouseCursor(int mouseCursor)
MouseCursorable
setMouseCursor
in interface MouseCursorable
mouseCursor
- - the mouse cursor to useMouseCursorable.setMouseCursor(int)
public void setMouseCursorURI(java.lang.String mouseCursorURI)
MouseCursorable
setMouseCursorURI
in interface MouseCursorable
mouseCursorURI
- the URI to a custom platform mouse cursor.MouseCursorable.setMouseCursorURI(java.lang.String)
public void validate()
Component
validate()
is not inadvisable.
validate
in interface Component
validate
in class AbstractComponent
Component.validate()
public void applyStyle(Style style)
Component
Style
object. The version of this method in Component
will set
foreground and background colors and the font from the style if they are
present. Components should override this method if they allow more
properties to be set from a style object, and should call
super.applyStyle() if necessary.
applyStyle
in interface Borderable
applyStyle
in interface MouseCursorable
applyStyle
in interface Component
applyStyle
in class AbstractButton
style
- The style object from which to retrieve properties for this
Component
.Borderable.applyStyle(nextapp.echo.Style)
public java.lang.Object set(java.lang.reflect.Field field, java.lang.Object newValue) throws java.lang.Exception
ReflectionSetter
public Object set(Field f, Object newValue) throws Exception { Object oldValue = f.get(this); f.set(this,newValue); return oldValue; }
set
in interface ReflectionSetter
field
- - the field to be setnewValue
- - the new value to be set
java.lang.IllegalAccessException
java.lang.IllegalArgumentException
java.lang.NullPointerException
java.lang.Exception
ReflectionSetter.set(Field,
Object)
public boolean isAsync()
isAsync
in class AbstractButton
public void setAsync(boolean async)
setAsync
in class AbstractButton
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |