|
| |
|
| java.lang.Object
 com.salmonllc.html.HtmlComponent
com.salmonllc.html.HtmlSubmitImage
| HtmlSubmitImage | | public class HtmlSubmitImage extends HtmlComponent implements ImageGenerator(Code) | | This class generate an image in the html page that will submit the page when
clicked.
|
| Constructor Summary | |
| public | HtmlSubmitImage(String name, String text, int width, int height, HtmlPage p)
Constructs a new Submit Image. | | public | HtmlSubmitImage(String name, String text, int width, int height, String theme, HtmlPage p)
Constructs a new Submit Image. | | public | HtmlSubmitImage(String name, String text, int height, HtmlPage p)
Constructs a new Submit Image. | | public | HtmlSubmitImage(String name, String text, int height, String theme, HtmlPage p)
Constructs a new Submit Image. | | public | HtmlSubmitImage(String name, String url, HtmlPage p)
Constructs a new Submit Image. |
| Method Summary | |
| public void | addSubmitListener(SubmitListener l)
This method adds a listener the will be notified when this image causes
the page to be submitted. | | public boolean | executeEvent(int type)
| | public void | generateHTML(java.io.PrintWriter p, int rowNo)
| | public void | generateImage(String img, OutputStream out)
| | public String | getAccessKey()
| | public int | getAlign()
| | public String | getAlt()
| | public DataStoreEvaluator | getAltExpression()
This method gets the DataStoreEvaluator being used for alt expressions. | | public Color | getBackgroundColor()
| | public int | getBorder()
| | public Color | getBottomRightColor()
| | public long | getCacheKey()
| | public String | getDisplayStyle()
This method gets the Display Style for a generated image button. | | public boolean | getEnabled()
This method returns whether or not clicking on the image will do a
submit. | | public DataStoreEvaluator | getExpression()
This method gets the DataStoreEvaluator being used for expressions. | | public Font | getFont()
This method returns the font used for dynamically generated images. | | public int | getHeight()
| | public int | getHorizontalSpace()
| | public String | getOnClick()
This method gets the javascript that will be executed when the button is
clicked. | | public String | getStyle()
| | public int | getTabIndex()
| | public String | getText()
| | public Color | getTextColor()
| | public String | getTextLocaleKey()
| | public String | getTheme()
This method returns the property theme for the component. | | public String | getTitle()
| | public Color | getTopLeftColor()
| | public Color | getTransparentColor()
| | public String | getURL()
This method returns the url for the image that will be displayed on the
button in the browser. | | public String | getURLLocaleKey()
| | public boolean | getUseCache()
If the image is dynamically generated, this method will indicate whether
or not the Objectstore should cache it. | | public int | getVerticalSpace()
| | public int | getWidth()
| | public void | insertSubmitListener(SubmitListener l)
This method inserts a listener at the beginning of the the listener list. | | public boolean | processParms(Hashtable parms, int rowNo)
| | public void | removeSubmitListener(SubmitListener l)
This method removes a listener from the list that will be notified if
this button causes the page to be submitted. | | public void | setAccessKey(String string)
| | public void | setAlign(int align)
| | public void | setAlign(String align)
| | public void | setAlt(String alt)
| | public void | setAltExpression(DataStoreBuffer ds, String expression)
| | public void | setBackgroundColor(Color c)
| | public void | setBackgroundColor(String s)
| | public void | setBorder(int border)
| | public void | setBottomRightColor(Color c)
| | public void | setBottomRightColor(String s)
| | public void | setCacheKey(long key)
| | public void | setDisplayStyle(String style)
This method sets the Display Style for a generated image button. | | public void | setEnabled(boolean enabled)
This method will set whether or not clicking on the image will do a
submit. | | public void | setExpression(DataStoreBuffer ds, DataStoreExpression expression)
| | public void | setExpression(DataStoreBuffer ds, DataStoreExpression expression, String format)
Use this method to bind this component to an expression in a
DataStoreBuffer. | | public void | setExpression(DataStoreBuffer ds, String expression)
| | public void | setExpression(DataStoreBuffer ds, String expression, String format)
Use this method to bind this component to an expression in a
DataStoreBuffer. | | public void | setFont(Font f)
This method sets the font used for dynamically generated images. | | public void | setFont(String name, int style, int size)
This method sets the font used for dynamically generated images. | | public void | setHeight(int height)
| | public void | setHorizontalSpace(int hSpace)
set the hspace. | | public void | setIFrameSubmit(HtmlInlineFrame iFrame)
| | public void | setOnClick(String onClick)
This method sets the javascript that will be executed when the button is
clicked. | | public void | setOnMouseOut(String string)
| | public void | setOnMouseOver(String string)
| | public void | setStyle(String style)
| | public void | setTabIndex(int val)
DOCUMENT ME!
Parameters:
val - the tab index html attribute. | | public void | setText(String text)
This method sets the text for the for the dynamically generated image. | | public void | setTextColor(Color c)
| | public void | setTextColor(String s)
| | public void | setTextLocaleKey(String textLocaleKey)
| | public void | setTheme(String theme)
This method sets the property theme for the component. | | public void | setTitle(String string)
| | public void | setTopLeftColor(Color c)
| | public void | setTopLeftColor(String s)
| | public void | setTransparentColor(Color c)
| | public void | setTransparentColor(String s)
| | public void | setURL(String name)
This method sets the url for the image that will be displayed on the
button in the browser. | | public void | setURLLocaleKey(String urlLocaleKey)
| | public void | setUseCache(boolean useCache)
| | public void | setVerticalSpace(int vSpace)
set the vspace. | | public void | setWidth(int width)
| | public void | updateLocale()
|
| ALIGN_ABSBOTTOM | | final public static int ALIGN_ABSBOTTOM(Code) | | |
| ALIGN_ABSMIDDLE | | final public static int ALIGN_ABSMIDDLE(Code) | | |
| ALIGN_BASELINE | | final public static int ALIGN_BASELINE(Code) | | |
| ALIGN_BOTTOM | | final public static int ALIGN_BOTTOM(Code) | | |
| ALIGN_LEFT | | final public static int ALIGN_LEFT(Code) | | |
| ALIGN_MIDDLE | | final public static int ALIGN_MIDDLE(Code) | | |
| ALIGN_NONE | | final public static int ALIGN_NONE(Code) | | |
| ALIGN_RIGHT | | final public static int ALIGN_RIGHT(Code) | | |
| ALIGN_TEXTTOP | | final public static int ALIGN_TEXTTOP(Code) | | |
| ALIGN_TOP | | final public static int ALIGN_TOP(Code) | | |
| STYLE_RECTANGLE | | final public static String STYLE_RECTANGLE(Code) | | |
| HtmlSubmitImage | | public HtmlSubmitImage(String name, String text, int width, int height, HtmlPage p)(Code) | | Constructs a new Submit Image. The image will be generated.
Parameters:
name - Each component on a page must have a unique name.
Parameters:
text - The Text to put on the button.
Parameters:
width - The width of the button in pixels
Parameters:
height - The height of the button in pixels
Parameters:
p - The page the button will be placed in |
| HtmlSubmitImage | | public HtmlSubmitImage(String name, String text, int width, int height, String theme, HtmlPage p)(Code) | | Constructs a new Submit Image. The image will be generated.
Parameters:
name - Each component on a page must have a unique name.
Parameters:
text - The Text to put on the button.
Parameters:
width - The width of the button in pixels
Parameters:
height - The height of the button in pixels
Parameters:
theme - The theme to use for the button image
Parameters:
p - The page the button will be placed in |
| HtmlSubmitImage | | public HtmlSubmitImage(String name, String text, int height, HtmlPage p)(Code) | | Constructs a new Submit Image. The width of the button is determined by
the width of the text.
Parameters:
name - Each component on a page must have a unique name.
Parameters:
text - The Text to put on the button.
Parameters:
height - The height of the button in pixels
Parameters:
p - The page the button will be placed in |
| HtmlSubmitImage | | public HtmlSubmitImage(String name, String text, int height, String theme, HtmlPage p)(Code) | | Constructs a new Submit Image. The width of the button is determined by
the size of the text.
Parameters:
name - Each component on a page must have a unique name.
Parameters:
text - The Text to put on the button.
Parameters:
height - The height of the button in pixels
Parameters:
theme - The theme to use for the button image
Parameters:
p - The page the button will be placed in |
| HtmlSubmitImage | | public HtmlSubmitImage(String name, String url, HtmlPage p)(Code) | | Constructs a new Submit Image.
Parameters:
name - Each component on a page must have a unique name.
Parameters:
url - The url of the image to appear on the button.
Parameters:
p - The page the button will be placed in |
| addSubmitListener | | public void addSubmitListener(SubmitListener l)(Code) | | This method adds a listener the will be notified when this image causes
the page to be submitted.
Parameters:
l - The listener to add. |
| getAccessKey | | public String getAccessKey()(Code) | | DOCUMENT ME!
the access key html attribute |
| getAlign | | public int getAlign()(Code) | | This method gets the align property for the component
DOCUMENT ME! |
| getAlt | | public String getAlt()(Code) | | Returns the tool tip for the image
DOCUMENT ME! |
| getBackgroundColor | | public Color getBackgroundColor()(Code) | | This method returns the background color if the image is generated
DOCUMENT ME! |
| getBorder | | public int getBorder()(Code) | | This method gets the border property for the component
DOCUMENT ME! |
| getBottomRightColor | | public Color getBottomRightColor()(Code) | | This method returns the bottom right border color if the image is
generated
DOCUMENT ME! |
| getCacheKey | | public long getCacheKey()(Code) | | |
| getDisplayStyle | | public String getDisplayStyle()(Code) | | This method gets the Display Style for a generated image button. Valid
Values are STYLE_RECTANGLE and STYLE_OVAL
DOCUMENT ME! |
| getEnabled | | public boolean getEnabled()(Code) | | This method returns whether or not clicking on the image will do a
submit.
DOCUMENT ME! |
| getFont | | public Font getFont()(Code) | | This method returns the font used for dynamically generated images.
DOCUMENT ME! |
| getHeight | | public int getHeight()(Code) | | This method gets the height in pixels for the generated image
DOCUMENT ME! |
| getHorizontalSpace | | public int getHorizontalSpace()(Code) | | get the Horizontal Space
DOCUMENT ME! |
| getOnClick | | public String getOnClick()(Code) | | This method gets the javascript that will be executed when the button is
clicked.
DOCUMENT ME! |
| getStyle | | public String getStyle()(Code) | | Get the html style attribute
|
| getTabIndex | | public int getTabIndex()(Code) | | DOCUMENT ME!
the tab index html attribute |
| getText | | public String getText()(Code) | | This method returns the text for the button
java.lang.String |
| getTextColor | | public Color getTextColor()(Code) | | This method returns the text color if the image is generated
DOCUMENT ME! |
| getTextLocaleKey | | public String getTextLocaleKey()(Code) | | Returns the Locale key used for the text of this component
DOCUMENT ME! |
| getTheme | | public String getTheme()(Code) | | This method returns the property theme for the component.
DOCUMENT ME! |
| getTopLeftColor | | public Color getTopLeftColor()(Code) | | This method returns the top and left border color if the image is
generated
DOCUMENT ME! |
| getTransparentColor | | public Color getTransparentColor()(Code) | | This method returns the color that will be represent transparent if the
image is generated
DOCUMENT ME! |
| getURL | | public String getURL()(Code) | | This method returns the url for the image that will be displayed on the
button in the browser.
java.lang.String |
| getURLLocaleKey | | public String getURLLocaleKey()(Code) | | Returns the Locale key used for the source url
DOCUMENT ME! |
| getUseCache | | public boolean getUseCache()(Code) | | If the image is dynamically generated, this method will indicate whether
or not the Objectstore should cache it.
DOCUMENT ME! |
| getVerticalSpace | | public int getVerticalSpace()(Code) | | get the Vertical Space
DOCUMENT ME! |
| getWidth | | public int getWidth()(Code) | | This method gets the width in pixels for the generated image
DOCUMENT ME! |
| insertSubmitListener | | public void insertSubmitListener(SubmitListener l)(Code) | | This method inserts a listener at the beginning of the the listener list.
It will be notified first when this button causes the page to be
submitted.
Parameters:
l - The listener to add. |
| removeSubmitListener | | public void removeSubmitListener(SubmitListener l)(Code) | | This method removes a listener from the list that will be notified if
this button causes the page to be submitted.
Parameters:
l - The listener to remove. |
| setAccessKey | | public void setAccessKey(String string)(Code) | | DOCUMENT ME!
Parameters:
string - the access key html attribute |
| setAlign | | public void setAlign(int align)(Code) | | This method sets the align property for the component
Parameters:
align - DOCUMENT ME! |
| setAlign | | public void setAlign(String align)(Code) | | This method sets the align property for the component using the HTML
attribute values
Parameters:
align - DOCUMENT ME! |
| setAlt | | public void setAlt(String alt)(Code) | | This method sets the tool tip for the image
Parameters:
alt - DOCUMENT ME! |
| setAltExpression | | public void setAltExpression(DataStoreBuffer ds, String expression) throws Exception(Code) | | Use this method to bind the alt property to an expression in a DataStore
Parameters:
ds - The DataStore to bind to.
Parameters:
expression - The expression to bind to.
throws:
Exception - DOCUMENT ME!
See Also: DataStoreEvaluator |
| setBackgroundColor | | public void setBackgroundColor(Color c)(Code) | | This method sets the background color for the generated image
Parameters:
c - DOCUMENT ME! |
| setBackgroundColor | | public void setBackgroundColor(String s)(Code) | | This method sets the background color for the generated image
Parameters:
s - DOCUMENT ME! |
| setBorder | | public void setBorder(int border)(Code) | | This method sets the border property for the component
Parameters:
border - DOCUMENT ME! |
| setBottomRightColor | | public void setBottomRightColor(Color c)(Code) | | This method sets the bottom and right border color for the generated
image
Parameters:
c - DOCUMENT ME! |
| setBottomRightColor | | public void setBottomRightColor(String s)(Code) | | This method sets the bottom and right border color for the generated
image
Parameters:
s - DOCUMENT ME! |
| setCacheKey | | public void setCacheKey(long key)(Code) | | |
| setDisplayStyle | | public void setDisplayStyle(String style)(Code) | | This method sets the Display Style for a generated image button. Valid
Values are STYLE_RECTANGLE and STYLE_OVAL
Parameters:
style - DOCUMENT ME! |
| setEnabled | | public void setEnabled(boolean enabled)(Code) | | This method will set whether or not clicking on the image will do a
submit.
Parameters:
enabled - DOCUMENT ME! |
| setExpression | | public void setExpression(DataStoreBuffer ds, DataStoreExpression expression, String format) throws Exception(Code) | | Use this method to bind this component to an expression in a
DataStoreBuffer. The resulting expression wil be formatted according to
the pattern specified.
Parameters:
ds - The DataStore to bind to.
Parameters:
expression - The expression to bind to.
Parameters:
format - The patter to use to format the result
throws:
Exception - DOCUMENT ME!
See Also: DataStore.setFormat
See Also: DataStoreEvaluator |
| setExpression | | public void setExpression(DataStoreBuffer ds, String expression) throws Exception(Code) | | Use this method to bind this component to an expression in a DataStore
Parameters:
ds - The DataStore to bind to.
Parameters:
expression - The expression to bind to.
throws:
Exception - DOCUMENT ME!
See Also: DataStoreEvaluator |
| setExpression | | public void setExpression(DataStoreBuffer ds, String expression, String format) throws Exception(Code) | | Use this method to bind this component to an expression in a
DataStoreBuffer. The resulting expression wil be formatted according to
the pattern specified.
Parameters:
ds - The DataStore to bind to.
Parameters:
expression - The expression to bind to.
Parameters:
format - The patter to use to format the result
throws:
Exception - DOCUMENT ME!
See Also: DataStore.setFormat
See Also: DataStoreEvaluator |
| setFont | | public void setFont(Font f)(Code) | | This method sets the font used for dynamically generated images.
Parameters:
f - DOCUMENT ME! |
| setFont | | public void setFont(String name, int style, int size)(Code) | | This method sets the font used for dynamically generated images.
Parameters:
name - DOCUMENT ME!
Parameters:
style - DOCUMENT ME!
Parameters:
size - DOCUMENT ME! |
| setHeight | | public void setHeight(int height)(Code) | | This method sets the width in pixels for the generated image
Parameters:
height - DOCUMENT ME! |
| setHorizontalSpace | | public void setHorizontalSpace(int hSpace)(Code) | | set the hspace.
Parameters:
hSpace - DOCUMENT ME! |
| setIFrameSubmit | | public void setIFrameSubmit(HtmlInlineFrame iFrame)(Code) | | Use this method if you want the button to submit only a layer of the page
and not the whole page
Parameters:
iFrame - The IFrame component that should be loaded |
| setOnClick | | public void setOnClick(String onClick)(Code) | | This method sets the javascript that will be executed when the button is
clicked.
Parameters:
onClick - DOCUMENT ME! |
| setOnMouseOut | | public void setOnMouseOut(String string)(Code) | | DOCUMENT ME!
Parameters:
string - Updates the onmouseout event string |
| setOnMouseOver | | public void setOnMouseOver(String string)(Code) | | DOCUMENT ME!
Parameters:
string - Updates the onmouseover event string |
| setStyle | | public void setStyle(String style)(Code) | | Set the html style attribute
Parameters:
style - |
| setTabIndex | | public void setTabIndex(int val)(Code) | | DOCUMENT ME!
Parameters:
val - the tab index html attribute. You can also passTAB_INDEX_DEFAULT to use the default tab index for thecomponent or TAB_INDEX_NONE to keep this component from beingtabbed to |
| setText | | public void setText(String text)(Code) | | This method sets the text for the for the dynamically generated image.
Parameters:
text - DOCUMENT ME! |
| setTextColor | | public void setTextColor(Color c)(Code) | | This method sets the text color for the generated image
Parameters:
c - DOCUMENT ME! |
| setTextColor | | public void setTextColor(String s)(Code) | | This method sets the text color for the generated image
Parameters:
s - DOCUMENT ME! |
| setTextLocaleKey | | public void setTextLocaleKey(String textLocaleKey)(Code) | | Returns the Locale key used for text
Parameters:
textLocaleKey - DOCUMENT ME! |
| setTheme | | public void setTheme(String theme)(Code) | | This method sets the property theme for the component.
Parameters:
theme - The theme to use. |
| setTitle | | public void setTitle(String string)(Code) | |
Parameters:
string - The _title to set. |
| setTopLeftColor | | public void setTopLeftColor(Color c)(Code) | | This method sets the top and left border color for the generated image
Parameters:
c - DOCUMENT ME! |
| setTopLeftColor | | public void setTopLeftColor(String s)(Code) | | This method sets the top and left border color for the generated image
Parameters:
s - DOCUMENT ME! |
| setTransparentColor | | public void setTransparentColor(Color c)(Code) | | This method sets the color that represents tranparent for the generated
image
Parameters:
c - DOCUMENT ME! |
| setTransparentColor | | public void setTransparentColor(String s)(Code) | | This method sets the color that represents tranparent for the generated
image
Parameters:
s - DOCUMENT ME! |
| setURL | | public void setURL(String name)(Code) | | This method sets the url for the image that will be displayed on the
button in the browser.
Parameters:
name - DOCUMENT ME! |
| setURLLocaleKey | | public void setURLLocaleKey(String urlLocaleKey)(Code) | | Sets the Locale key used for the image URL
Parameters:
urlLocaleKey - DOCUMENT ME! |
| setUseCache | | public void setUseCache(boolean useCache)(Code) | | |
| setVerticalSpace | | public void setVerticalSpace(int vSpace)(Code) | | set the vspace.
Parameters:
vSpace - DOCUMENT ME! |
| setWidth | | public void setWidth(int width)(Code) | | This method sets the width in pixels for the generated image
Parameters:
width - DOCUMENT ME! |
| updateLocale | | public void updateLocale()(Code) | | Updates the text and format for the current local
|
|
|
|