| java.lang.Object
 com.salmonllc.html.HtmlComponent
com.salmonllc.html.HtmlImage
All known Subclasses: com.salmonllc.jsp.JspBrandingImage,
| Constructor Summary | |
| public | HtmlImage(String source, HtmlPage p)
| | public | HtmlImage(String name, String text, int width, int height, HtmlPage p)
Constructs a new Image. | | public | HtmlImage(String name, String text, int width, int height, String theme, HtmlPage p)
Constructs a new Image. | | public | HtmlImage(String name, String text, int height, HtmlPage p)
Constructs a new Image. | | public | HtmlImage(String name, String text, int height, String theme, HtmlPage p)
Constructs a new Image. | | public | HtmlImage(String name, String source, HtmlPage p)
|
| Method Summary | |
| public void | addAreaMap(HtmlImageMapArea map)
Use this method to add an image area map to the image. | | public void | clearSubmit()
| | public boolean | executeEvent(int eventType)
| | public void | generateHTML(java.io.PrintWriter p, int rowNo)
| | public void | generateImage(String img, OutputStream out)
| | public void | generateInitialHTML(PrintWriter p)
| | public String | getAlign()
Returns the alignment property for the image. | | public String | getAlt()
| | public DataStoreEvaluator | getAltExpression()
This method gets the DataStoreEvaluator being used for alt expressions. | | public String | getAltLocaleKey()
| | public Color | getBackgroundColor()
| | public int | getBorder()
This method returns the border width of the image in pixels. | | 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()
This method returns the height of the image. | | public int | getHeightSizeOption()
This method returns SIZE_PIXELS or SIZE_PERCENT. | | public int | getHorizontalSpace()
This method returns the horizontal space around the the image. | | public String | getSource()
This method gets the source url for the image. | | public String | getSourceLocaleKey()
| | 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 boolean | getUseCache()
If the image is dynamically generated, this method will indicate whether or not the Objectstore should cache it. | | public String | getUseMap()
| | public int | getVerticalSpace()
This method returns the vertical space around the the image. | | public int | getWidth()
This method returns the width of the image. | | public int | getWidthSizeOption()
This method returns SIZE_PIXELS or SIZE_PERCENT. | | public boolean | processParms(Hashtable parms, int rowNo)
| | public void | setAlign(String align)
Sets the alignment property for the image. | | public void | setAlt(String alt)
| | public void | setAltExpression(DataStoreBuffer ds, String expression)
| | public void | setAltExpression(DataStoreBuffer ds, DataStoreExpression expression)
| | public void | setAltLocaleKey(String altLocaleKey)
| | public void | setBackgroundColor(Color c)
| | public void | setBorder(int border)
This method sets the border border of the image in pixels. | | public void | setBottomRightColor(Color c)
| | public void | setCacheKey(long key)
| | public void | setDisplayStyle(String style)
This method gets 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 | setHeight(int height)
This method sets the height of the image. | | public void | setHeightSizeOption(int option)
Valid values for this method are SIZE_PIXELS or SIZE_PERCENT. | | public void | setHorizontalSpace(int width)
This method sets the Horizontal space around the image in pixels. | | public void | setOnLoad(String onload)
Sets the alignment property for the image. | | public void | setSource(String source)
This method sets the source url for the image. | | public void | setSourceLocaleKey(String sourceLocaleKey)
| | public void | setText(String text)
This method sets the text for the for the dynamically generated image. | | public void | setTextColor(Color c)
| | 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 | setTransparentColor(Color c)
| | public void | setUseMap(String useMap)
| | public void | setVerticalSpace(int width)
This method sets the Vertical space around the image in pixels. | | public void | setWidth(int width)
This method sets the width of the image. | | public void | setWidthSizeOption(int option)
Valid values for this method are SIZE_PIXELS or SIZE_PERCENT. | | public void | updateLocale()
|
| ALIGN_ABSBOTTOM | | final public static String ALIGN_ABSBOTTOM(Code) | | |
| ALIGN_ABSMIDDLE | | final public static String ALIGN_ABSMIDDLE(Code) | | |
| SIZE_PERCENT | | final public static int SIZE_PERCENT(Code) | | |
| SIZE_PIXELS | | final public static int SIZE_PIXELS(Code) | | |
| STYLE_RECTANGLE | | final public static String STYLE_RECTANGLE(Code) | | |
| VALIGN_BASELINE | | final public static String VALIGN_BASELINE(Code) | | |
| VALIGN_TEXTTOP | | final public static String VALIGN_TEXTTOP(Code) | | |
| HtmlImage | | public HtmlImage(String source, HtmlPage p)(Code) | | Constructs an new Image
Parameters:
source - - image that is being used.
Parameters:
p - The page the image will be placed in |
| HtmlImage | | public HtmlImage(String name, String text, int width, int height, HtmlPage p)(Code) | | Constructs a new Image.
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 image will be placed in |
| HtmlImage | | public HtmlImage(String name, String text, int width, int height, String theme, HtmlPage p)(Code) | | Constructs a new Image.
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 image will be placed in |
| HtmlImage | | public HtmlImage(String name, String text, int height, HtmlPage p)(Code) | | Constructs a new Image. The width of the Image 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:
p - The page the button will be placed in |
| HtmlImage | | public HtmlImage(String name, String text, int height, String theme, HtmlPage p)(Code) | | Constructs a new Image. The width of the Image 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 |
| addAreaMap | | public void addAreaMap(HtmlImageMapArea map)(Code) | | Use this method to add an image area map to the image. When the user clicks on a region of the image a link will be followed or a submit will be performed.
|
| clearSubmit | | public void clearSubmit()(Code) | | |
| executeEvent | | public boolean executeEvent(int eventType) throws Exception(Code) | | |
| getAlign | | public String getAlign()(Code) | | Returns the alignment property for the image.
|
| getAlt | | public String getAlt()(Code) | | Returns the tool tip for the image
|
| getAltLocaleKey | | public String getAltLocaleKey()(Code) | | Returns the Locale key used for the alt texy
|
| getBackgroundColor | | public Color getBackgroundColor()(Code) | | This method returns the background color if the image is generated
|
| getBorder | | public int getBorder()(Code) | | This method returns the border width of the image in pixels.
|
| getBottomRightColor | | public Color getBottomRightColor()(Code) | | This method returns the bottom right border color if the image is generated
|
| 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
|
| getEnabled | | public boolean getEnabled()(Code) | | This method returns whether or not clicking on the image will do a submit.
|
| getFont | | public Font getFont()(Code) | | This method returns the font used for dynamically generated images.
|
| getHeight | | public int getHeight()(Code) | | This method returns the height of the image.
|
| getHeightSizeOption | | public int getHeightSizeOption()(Code) | | This method returns SIZE_PIXELS or SIZE_PERCENT.
|
| getHorizontalSpace | | public int getHorizontalSpace()(Code) | | This method returns the horizontal space around the the image.
|
| getSource | | public String getSource()(Code) | | This method gets the source url for the image.
|
| getSourceLocaleKey | | public String getSourceLocaleKey()(Code) | | Returns the Locale key used for the source url
|
| 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
|
| getTextLocaleKey | | public String getTextLocaleKey()(Code) | | Returns the Locale key used for the text of this component
|
| getTheme | | public String getTheme()(Code) | | This method returns the property theme for the component.
|
| getTopLeftColor | | public Color getTopLeftColor()(Code) | | This method returns the top and left border color if the image is generated
|
| getTransparentColor | | public Color getTransparentColor()(Code) | | This method returns the color that will be represent transparent if the image is generated
|
| getUseCache | | public boolean getUseCache()(Code) | | If the image is dynamically generated, this method will indicate whether or not the Objectstore should cache it.
|
| getUseMap | | public String getUseMap()(Code) | | This method returns a specific use map for the image that is defined elsewhere in the JSP
|
| getVerticalSpace | | public int getVerticalSpace()(Code) | | This method returns the vertical space around the the image.
|
| getWidth | | public int getWidth()(Code) | | This method returns the width of the image.
|
| getWidthSizeOption | | public int getWidthSizeOption()(Code) | | This method returns SIZE_PIXELS or SIZE_PERCENT.
|
| setAlign | | public void setAlign(String align)(Code) | | Sets the alignment property for the image.
|
| setAlt | | public void setAlt(String alt)(Code) | | This method sets the tool tip for the image
|
| 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.
See Also: DataStoreEvaluator |
| setAltLocaleKey | | public void setAltLocaleKey(String altLocaleKey)(Code) | | Sets the Locale key used for the Alt text
|
| setBackgroundColor | | public void setBackgroundColor(Color c)(Code) | | This method sets the background color for the generated image
|
| setBorder | | public void setBorder(int border)(Code) | | This method sets the border border of the image in pixels.
|
| setBottomRightColor | | public void setBottomRightColor(Color c)(Code) | | This method sets the bottom and right border color for the generated image
|
| setCacheKey | | public void setCacheKey(long key)(Code) | | |
| setDisplayStyle | | public void setDisplayStyle(String style)(Code) | | This method gets the Display Style for a generated image button. Valid Values are STYLE_RECTANGLE and STYLE_OVAL
|
| setEnabled | | public void setEnabled(boolean enabled)(Code) | | This method will set whether or not clicking on the image will do a submit.
|
| 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.
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
See Also: com.salmonllc.sql.DataStore.setFormat
See Also: DataStoreEvaluator |
| setFont | | public void setFont(Font f)(Code) | | This method sets the font used for dynamically generated images.
|
| setHeight | | public void setHeight(int height)(Code) | | This method sets the height of the image.
|
| setHeightSizeOption | | public void setHeightSizeOption(int option)(Code) | | Valid values for this method are SIZE_PIXELS or SIZE_PERCENT.
|
| setHorizontalSpace | | public void setHorizontalSpace(int width)(Code) | | This method sets the Horizontal space around the image in pixels.
|
| setOnLoad | | public void setOnLoad(String onload)(Code) | | Sets the alignment property for the image.
|
| setSource | | public void setSource(String source)(Code) | | This method sets the source url for the image.
|
| setSourceLocaleKey | | public void setSourceLocaleKey(String sourceLocaleKey)(Code) | | Sets the Locale key used for the image URL
|
| setText | | public void setText(String text)(Code) | | This method sets the text for the for the dynamically generated image.
|
| setTextColor | | public void setTextColor(Color c)(Code) | | This method sets the text color for the generated image
|
| setTextLocaleKey | | public void setTextLocaleKey(String textLocaleKey)(Code) | | Returns the Locale key used for text
|
| 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
|
| setTransparentColor | | public void setTransparentColor(Color c)(Code) | | This method sets the color that represents tranparent for the generated image
|
| setUseMap | | public void setUseMap(String useMap)(Code) | | If you want to specify a specific use map for the image that is defined elsewhere in the JSP, you can use this method
|
| setVerticalSpace | | public void setVerticalSpace(int width)(Code) | | This method sets the Vertical space around the image in pixels.
|
| setWidth | | public void setWidth(int width)(Code) | | This method sets the width of the image.
|
| setWidthSizeOption | | public void setWidthSizeOption(int option)(Code) | | Valid values for this method are SIZE_PIXELS or SIZE_PERCENT.
|
| updateLocale | | public void updateLocale()(Code) | | Updates the text and format for the current local
|
|
|