HTMLButton (stSoftware API)

java.lang.Object
- com.aspc.remote.html.HTMLComponent
- - com.aspc.remote.html.HTMLButton

All Implemented Interfaces:

HandlesSingleClick
```
public class HTMLButton
extends HTMLComponent
implements HandlesSingleClick
```
A HTMLComponent which generates the HTML code for the specified text. An image file is produced based on the current font and color settings specified in the current theme. THREAD MODE: SINGLE-THREADED html generator component

Since:

November 1, 1999, 7:16 PM

Author:

Nigel Leck

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`disabledFg`
`protected boolean`	`showNavigateAwayWarning` check weather it is showNavigateAwayWarning on or not
`static Version`	`VERSION`

Fields inherited from class com.aspc.remote.html.HTMLComponent
alignment, alt, bgColor, cancelBubble, events, gMutableTheme, hasInitFocus, id, intStyleSheet, items, name, parent, styleId, styleProperty, tabIndex, toolTip, VALID_NAME_REGEX, VALID_STYLE_REGEX

Constructor Summary

Constructors
Constructor and Description
`HTMLButton(java.lang.String displayName)` A constructor with one string parameter.
`HTMLButton(java.lang.String name, int fldCount, java.util.ArrayList pathList)`
`HTMLButton(java.lang.String displayName, java.lang.String name)` constructor with two parameter

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMouseEvent(HTMLMouseEvent me)` add a mouse event to this component
`void`	`addOnClickEvent(java.lang.String call, java.lang.String script)`
`void`	`cancelClickBubble()` Prevent the click of the mouse from propagation up the dom and kicking off other things.
`protected void`	`compile(ClientBrowser browser)` This is the spot to put all your generation of the HTML components.
`boolean`	`getButtGWTFg()` set is GWT button
`java.awt.Color`	`getButtonColor()` return button color
`java.lang.Boolean`	`getButtonFontBold()` return button font bold style is true or not
`java.awt.Color`	`getButtonFontColor()` return button font color
`java.lang.String`	`getButtonFontName()` return button font name
`java.lang.Integer`	`getButtonFontSize()` return button font size
`int`	`getButtonHeight()` return button Height
`int`	`getButtonWidth()` return button width
`java.lang.String`	`getCall()`
`java.lang.String`	`getImage()`
`java.lang.String`	`getName()`
`boolean`	`getNotReplasceWindow()`
`java.lang.StringBuilder`	`getOnclickScript(ClientBrowser browser)`
`int`	`getSpawnWinHeight()`
`int`	`getSpawnWinWidth()`
`java.lang.String`	`getToolTip()`
`java.lang.String`	`getValue()` return string value.
`protected void`	`iGenerate(ClientBrowser browser, java.lang.StringBuilder buffer)` generate the raw HTML for this component.
`void`	`setButtGWTFg(boolean flag, boolean autoSave)` Is GWT button
`void`	`setButtonColor(java.awt.Color color)` Sets button background color
`void`	`setButtonFontBold(java.lang.Boolean fontBold)` Sets button font bold style
`void`	`setButtonFontColor(java.awt.Color color)` Sets button font color.
`void`	`setButtonFontName(java.lang.String fontName)` Sets button font name.
`void`	`setButtonFontSize(java.lang.Integer fontSize)` Sets button font size
`void`	`setButtonHeight(int height)` Sets button height
`void`	`setButtonWidth(int width)` Sets button width
`void`	`setCall(java.lang.String href)` if the href starts with javascript:, it will be put in a javascript function, and put in the <script> tag.
`void`	`setDisabled(boolean flag)` Disables this input.
`void`	`setImage(java.lang.String href)`
`void`	`setName(java.lang.String name)`
`void`	`setNotReplaceWindow(boolean notReplaceWindow)`
`void`	`setNoValidate(boolean flag)` no validate
`void`	`setPlaceHolderOnly(boolean flag)`
`void`	`setRedirectCall(java.lang.String href)`
`void`	`setRedirectTarget(java.lang.String target)`
`void`	`setShowNavigateAwayWarning(boolean flag)`
`void`	`setSpawnCall(java.lang.String href)`
`void`	`setSpawnWinHeight(int spawnWinHeight)`
`void`	`setSpawnWinWidth(int spawnWinWidth)`
`void`	`setSqlCommand(java.lang.String sql)`
`void`	`setTarget(java.lang.String target)`
`void`	`setToolTip(java.lang.String toolTip)`
`void`	`setValue(java.lang.String value)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - VERSION
```
public static final Version VERSION
```
  - disabledFg
```
protected boolean disabledFg
```
  - showNavigateAwayWarning
```
protected boolean showNavigateAwayWarning
```
    check weather it is showNavigateAwayWarning on or not
- Constructor Detail
  - HTMLButton
```
public HTMLButton(java.lang.String displayName)
```
    A constructor with one string parameter.
    
    Parameters:
    
    displayName -
  - HTMLButton
```
public HTMLButton(java.lang.String displayName,
                  java.lang.String name)
```
    constructor with two parameter
    
    Parameters:
    
    displayName -
    
    name -
  - HTMLButton
```
public HTMLButton(java.lang.String name,
                  int fldCount,
                  java.util.ArrayList pathList)
```
- Method Detail
  - setTarget
```
public void setTarget(java.lang.String target)
```
  - setNoValidate
```
public void setNoValidate(boolean flag)
```
    no validate
    
    Parameters:
    
    flag - true if not to validate.
  - setButtGWTFg
```
public void setButtGWTFg(boolean flag,
                         boolean autoSave)
```
    Is GWT button
    
    Parameters:
    
    flag -
    
    autoSave -
  - getButtGWTFg
```
public boolean getButtGWTFg()
```
    set is GWT button
    
    Returns:
    
    the value
  - getValue
```
public java.lang.String getValue()
```
    return string value.
    
    Returns:
    
    the value
  - setValue
```
public void setValue(java.lang.String value)
```
    Parameters:
    
    value - string type
  - getName
```
public java.lang.String getName()
```
    Returns:
    
    the value
  - setName
```
public final void setName(java.lang.String name)
```
    Parameters:
    
    name - the name
  - setButtonWidth
```
public void setButtonWidth(int width)
```
    Sets button width
    
    Parameters:
    
    width - int type
  - getButtonWidth
```
public int getButtonWidth()
```
    return button width
    
    Returns:
    
    int type
  - setButtonHeight
```
public void setButtonHeight(int height)
```
    Sets button height
    
    Parameters:
    
    height - int type
  - getButtonHeight
```
public int getButtonHeight()
```
    return button Height
    
    Returns:
    
    int type
  - setButtonColor
```
public void setButtonColor(java.awt.Color color)
```
    Sets button background color
    
    Parameters:
    
    color - Color type
  - getButtonColor
```
public java.awt.Color getButtonColor()
```
    return button color
    
    Returns:
    
    type color
  - setButtonFontName
```
public void setButtonFontName(java.lang.String fontName)
```
    Sets button font name.
    
    Parameters:
    
    fontName - string type
  - getButtonFontName
```
public java.lang.String getButtonFontName()
```
    return button font name
    
    Returns:
    
    type string
  - setButtonFontBold
```
public void setButtonFontBold(java.lang.Boolean fontBold)
```
    Sets button font bold style
    
    Parameters:
    
    fontBold - Boolean type
  - getButtonFontBold
```
public java.lang.Boolean getButtonFontBold()
```
    return button font bold style is true or not
    
    Returns:
    
    Boolean type
  - setButtonFontSize
```
public void setButtonFontSize(java.lang.Integer fontSize)
```
    Sets button font size
    
    Parameters:
    
    fontSize - Integer type
  - getButtonFontSize
```
public java.lang.Integer getButtonFontSize()
```
    return button font size
    
    Returns:
    
    Integer type
  - setButtonFontColor
```
public void setButtonFontColor(java.awt.Color color)
```
    Sets button font color.
    
    Parameters:
    
    color -
  - getButtonFontColor
```
public java.awt.Color getButtonFontColor()
```
    return button font color
    
    Returns:
    
    the value
  - cancelClickBubble
```
public void cancelClickBubble()
```
    Prevent the click of the mouse from propagation up the dom and kicking off other things.
    
    Specified by:
    
    cancelClickBubble in interface HandlesSingleClick
  - addOnClickEvent
```
public void addOnClickEvent(java.lang.String call,
                            java.lang.String script)
```
    Parameters:
    
    call -
    
    script -
  - addMouseEvent
```
public void addMouseEvent(HTMLMouseEvent me)
```
    add a mouse event to this component
    
    Parameters:
    
    me - The mouse event
  - setDisabled
```
public void setDisabled(boolean flag)
```
    Disables this input.
    
    Parameters:
    
    flag -
  - setPlaceHolderOnly
```
public void setPlaceHolderOnly(boolean flag)
```
    Parameters:
    
    flag -
  - setImage
```
public void setImage(java.lang.String href)
```
    Parameters:
    
    href -
  - getImage
```
public java.lang.String getImage()
```
  - setCall
```
public void setCall(java.lang.String href)
```
    if the href starts with javascript:, it will be put in a javascript function, and put in the <script> tag. This means the href should NOT be html escaped. eg: & should be &, not &. ' should NOT be ' you may use javascript escape to escape ' or " etc to \' and \"
    
    Parameters:
    
    href -
  - setSpawnWinHeight
```
public void setSpawnWinHeight(int spawnWinHeight)
```
    Parameters:
    
    spawnWinHeight -
  - setSpawnWinWidth
```
public void setSpawnWinWidth(int spawnWinWidth)
```
    Parameters:
    
    spawnWinWidth -
  - getSpawnWinHeight
```
public int getSpawnWinHeight()
```
    Returns:
    
    the value
  - getSpawnWinWidth
```
public int getSpawnWinWidth()
```
    Returns:
    
    the value
  - getNotReplasceWindow
```
public boolean getNotReplasceWindow()
```
    Returns:
    
    the value
  - setNotReplaceWindow
```
public void setNotReplaceWindow(boolean notReplaceWindow)
```
    Parameters:
    
    notReplaceWindow -
  - getCall
```
public java.lang.String getCall()
```
    Returns:
    
    the value
  - setSqlCommand
```
public void setSqlCommand(java.lang.String sql)
```
    Parameters:
    
    sql -
  - setRedirectCall
```
public void setRedirectCall(java.lang.String href)
```
    Parameters:
    
    href -
  - setToolTip
```
public void setToolTip(java.lang.String toolTip)
```
    Parameters:
    
    toolTip -
  - getToolTip
```
public java.lang.String getToolTip()
```
  - setRedirectTarget
```
public void setRedirectTarget(java.lang.String target)
```
    Parameters:
    
    target -
  - setSpawnCall
```
public void setSpawnCall(java.lang.String href)
```
    Parameters:
    
    href -
  - setShowNavigateAwayWarning
```
public void setShowNavigateAwayWarning(boolean flag)
```
    Parameters:
    
    flag -
  - compile
```
protected void compile(ClientBrowser browser)
```
    Description copied from class: HTMLComponent
    
    This is the spot to put all your generation of the HTML components. Do not put it in iGenerate()
    
    Overrides:
    
    compile in class HTMLComponent
    
    Parameters:
    
    browser -
  - getOnclickScript
```
public java.lang.StringBuilder getOnclickScript(ClientBrowser browser)
```
  - iGenerate
```
protected void iGenerate(ClientBrowser browser,
                         java.lang.StringBuilder buffer)
```
    generate the raw HTML for this component. http://allinthehead.com/retro/330/coping-with-internet-explorers-mishandling-of-buttons http://hardlikesoftware.com/weblog/2007/02/27/html-button-is-not-useful/
    
    Overrides:
    
    iGenerate in class HTMLComponent
    
    Parameters:
    
    browser - The target browser
    
    buffer - The generate HTML

Class HTMLButton

Field Summary

Fields inherited from class com.aspc.remote.html.HTMLComponent

Constructor Summary

Method Summary

Methods inherited from class com.aspc.remote.html.HTMLComponent

Methods inherited from class java.lang.Object

Field Detail

VERSION

disabledFg

showNavigateAwayWarning

Constructor Detail

HTMLButton

HTMLButton

HTMLButton

Method Detail

setTarget

setNoValidate

setButtGWTFg

getButtGWTFg

getValue

setValue

getName

setName

setButtonWidth

getButtonWidth

setButtonHeight

getButtonHeight

setButtonColor

getButtonColor

setButtonFontName

getButtonFontName

setButtonFontBold

getButtonFontBold

setButtonFontSize

getButtonFontSize

setButtonFontColor

getButtonFontColor

cancelClickBubble

addOnClickEvent

addMouseEvent

setDisabled

setPlaceHolderOnly

setImage

getImage

setCall

setSpawnWinHeight

setSpawnWinWidth

getSpawnWinHeight

getSpawnWinWidth

getNotReplasceWindow

setNotReplaceWindow

getCall

setSqlCommand

setRedirectCall

setToolTip

getToolTip

setRedirectTarget

setSpawnCall

setShowNavigateAwayWarning

compile

getOnclickScript

iGenerate