kiurubeans
Class HtmlBean

java.lang.Object
  |
  +--kiurubeans.HtmlBean

public class HtmlBean

extends java.lang.Object

Facilitates HTML output and translations.

Field Summary

User	user used for translation. if user is not set, text is translated 'as is'.

Constructor Summary

HtmlBean()
Creates a new instance of HtmlBean.

Method Summary

static java.lang.String	begin_javascript() Retuns script tag and begin HTML comment.
static java.lang.String	begin_table() return begin table tag with parameters, standard formatting
static java.lang.String	bottomNavigator() Standard navigation text for bottom of pages concerning spaces, spacegroups & reports. probably obsolete.
static java.lang.String	createSearchForm(java.lang.String targetPage, java.lang.String editName, java.lang.String editContent) Creates simple search form.
static java.lang.String	createSearchForm(java.lang.String targetPage, java.lang.String editName, java.lang.String editContent, boolean closeForm) Creates simple search form.
static java.lang.String	end_javascript() Retuns end HTML comment and end script tag.
static java.lang.String	getCurrentPage(javax.servlet.http.HttpServletRequest r) Returns current page filename, no request parameters or path.
static java.lang.String	getCurrentTime() Returns current time in string. parameter "currentTime".
static java.lang.String	getCurrentTimeAsHidden() Returns current time as a hidden control to ensure cache-free functionality.
java.lang.String	getH(java.lang.String text) Returns page's main headline.
java.lang.String	getH(java.lang.String text, int level) Returns page's headline of given level.
static java.lang.String	getHidden(java.lang.String name, int value) Returns hidden component for html form
static java.lang.String	getHidden(java.lang.String name, java.lang.String value) Returns hidden component for html form
java.lang.String	getJsButton(java.lang.String name, java.lang.String value, java.lang.String onClick) Returns javascript code for printing a submit button. translated.
static java.lang.String	getLabel(java.lang.String text) Returns NON-TRANSLATED text with label style (used in html forms).
static java.lang.String	getLink(java.lang.String title, java.lang.String value) Returns HTML code for a link.
static java.lang.String	getLink(java.lang.String title, java.lang.String value, java.lang.String defaultTitle) Returns HTML code for a link.
static java.lang.String	getSubmit(java.lang.String name, java.lang.String value) Returns submit component for html form
User	getUser() Getter method for user
java.io.PrintWriter	getWriter() Getter for property writer.
java.lang.String	makeCheckBox(java.lang.String name, RS2 rs, java.lang.String valueField, java.lang.String textField, java.lang.String checked) Creates a group of Checkbox
static java.lang.String	makeRadioGroup(java.lang.String name, java.util.ArrayList rs, java.lang.String checked, boolean dobreak) Creates a group of HTML Radiobuttons based on ArrayList with StringPairs
java.lang.String	makeRadioGroup(java.lang.String name, RS2 rs, java.lang.String valueField, java.lang.String textField, java.lang.String checked) Creates a group of HTML Radiobuttons
java.lang.String	makeRadioGroup(java.lang.String name, RS2 rs, java.lang.String valueField, java.lang.String textField, java.lang.String checked, java.lang.String nullString) Creates a group of HTML Radiobuttons
static java.lang.String	makeSelectList(java.lang.String name, RS2 rs, java.lang.String valueField, java.lang.String textField, java.lang.String selected) Creates a new HTML Select list
static java.lang.String	makeSelectList(java.lang.String name, RS2 rs, java.lang.String valueField, java.lang.String textField, java.lang.String selected, int size, boolean multiple) Creates a new HTML Select list with size
static java.lang.String	makeSelectList(java.lang.String name, RS2 rs, java.lang.String valueField, java.lang.String textField, java.lang.String selected, java.lang.String nullString) Creates a new HTML Select list
void	printHtmlTable(HtmlTable h) Prints a HtmlTable component on current writer
void	printOptionValues(java.util.Hashtable translations, java.lang.String selected) Taken from portal/pageAddUser.
void	printSelectList(java.lang.String name, java.util.Hashtable values, java.lang.String selected, java.lang.String nullString) Creates a new HTML Select list based on hashtable. hashtable values are not translated!
void	printSubmit(java.lang.String name, java.lang.String value) Prints translated submit button to current writer
void	setUser(User user) Setter method for user
void	setWriter(java.io.Writer writer) Setter for property writer.
java.lang.String	translate(java.lang.String s) Translates given string

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

user

public User user

used for translation. if user is not set, text is translated 'as is'.

Constructor Detail

HtmlBean

public HtmlBean()

Creates a new instance of HtmlBean. Dummy empty constructor

Method Detail

getWriter

public java.io.PrintWriter getWriter()

Getter for property writer.

Returns:

Value of property writer.

setWriter

public void setWriter(java.io.Writer writer)

Setter for property writer.

Parameters:

writer - New value of property writer.

setUser

public void setUser(User user)

Setter method for user

Parameters:

user - current user

getUser

public User getUser()

Getter method for user

Returns:

current user

translate

public java.lang.String translate(java.lang.String s)

Translates given string

Parameters:

s - String that is being translated

Returns:

Translated String

makeSelectList

public static java.lang.String makeSelectList(java.lang.String name,
                                              RS2 rs,
                                              java.lang.String valueField,
                                              java.lang.String textField,
                                              java.lang.String selected)
                                       throws java.lang.Exception

Creates a new HTML Select list

Parameters:

name - The name of HTML Select list.

rs - ResultSet

valueField - The name of SQL field that contains the id values

textField - The name of SQL field that contains the text values.

selected - Id that is selected.

Returns:

Generated HTML code including a select list.

Throws:

java.lang.Exception - if problems with RS2

makeSelectList

public static java.lang.String makeSelectList(java.lang.String name,
                                              RS2 rs,
                                              java.lang.String valueField,
                                              java.lang.String textField,
                                              java.lang.String selected,
                                              java.lang.String nullString)
                                       throws java.lang.Exception

Creates a new HTML Select list

Parameters:

name - The name of HTML Select list.

rs - ResultSet

valueField - The name of SQL field that contains the id values

textField - The name of SQL field that contains the text values.

selected - Id that is selected.

nullString - nullstring is added in the beginning with value 0 (if nullString==null, nothing is added)

Returns:

Generated HTML code including a select list.

Throws:

java.lang.Exception - If problems with RS2

makeRadioGroup

public java.lang.String makeRadioGroup(java.lang.String name,
                                       RS2 rs,
                                       java.lang.String valueField,
                                       java.lang.String textField,
                                       java.lang.String checked)
                                throws java.lang.Exception

Creates a group of HTML Radiobuttons

Parameters:

name - The name of HTML radiobuttons.

rs - ResultSet

valueField - The name of SQL field that contains the id values

textField - The name of SQL field that contains the text values.

checked - Which radio button is selected by default.

Returns:

generated radiobutton group

Throws:

java.lang.Exception - if problems with rs

makeRadioGroup

public java.lang.String makeRadioGroup(java.lang.String name,
                                       RS2 rs,
                                       java.lang.String valueField,
                                       java.lang.String textField,
                                       java.lang.String checked,
                                       java.lang.String nullString)
                                throws java.lang.Exception

Creates a group of HTML Radiobuttons

Parameters:

name - The name of HTML radiobuttons.

rs - RS2 where data is retrieved

valueField - The name of SQL field that contains the id values

textField - The name of SQL field that contains the text values.

checked - Which radio button is selected by default.

nullString - nullstring is added in the beginning with value 0 (if nullString==null, nothing is added)

Returns:

generated radiobutton group

Throws:

java.lang.Exception - if problems with rs

makeRadioGroup

public static java.lang.String makeRadioGroup(java.lang.String name,
                                              java.util.ArrayList rs,
                                              java.lang.String checked,
                                              boolean dobreak)

Creates a group of HTML Radiobuttons based on ArrayList with StringPairs

Parameters:

name - The name of HTML radiobuttons.

rs - arraylist containing (key,value) StringPairs

checked - Which radio button is selected by default.

dobreak - if true, a br tag is appended to the end

Returns:

generated radiobutton group

See Also:

StringPair

makeCheckBox

public java.lang.String makeCheckBox(java.lang.String name,
                                     RS2 rs,
                                     java.lang.String valueField,
                                     java.lang.String textField,
                                     java.lang.String checked)
                              throws java.lang.Exception

Creates a group of Checkbox

Parameters:

name - The name of HTML checkboxes

rs - RS2 where data is retrieved

valueField - The name of SQL field that contains the id values

textField - The name of SQL field that contains the text values.

checked - id for checked box

Returns:

generated checkbox group

Throws:

java.lang.Exception - if problems with RS2

makeSelectList

public static java.lang.String makeSelectList(java.lang.String name,
                                              RS2 rs,
                                              java.lang.String valueField,
                                              java.lang.String textField,
                                              java.lang.String selected,
                                              int size,
                                              boolean multiple)
                                       throws java.lang.Exception

Creates a new HTML Select list with size

Parameters:

name - The name of HTML Select list.

rs - ResultSet

valueField - The name of SQL field that contains the id values

textField - The name of SQL field that contains the text values.

selected - Id that is selected.

size - Select list size

multiple - if true, multiple values can be selected

Returns:

Generated HTML code including a select list.

Throws:

java.lang.Exception - If problems with RS2

createSearchForm

public static java.lang.String createSearchForm(java.lang.String targetPage,
                                                java.lang.String editName,
                                                java.lang.String editContent)

Creates simple search form. Used for searching spaces & persons

Parameters:

targetPage - action page

editName - name for edit box

editContent - default text for edit box

Returns:

search form as string

createSearchForm

public static java.lang.String createSearchForm(java.lang.String targetPage,
                                                java.lang.String editName,
                                                java.lang.String editContent,
                                                boolean closeForm)

Creates simple search form. Used for searching spaces & persons

Parameters:

targetPage - action page

editName - name for edit box

editContent - default text for edit box

closeForm - if true, form is closed

Returns:

search form as string

bottomNavigator

public static java.lang.String bottomNavigator()

Standard navigation text for bottom of pages concerning spaces, spacegroups & reports. probably obsolete.

Returns:

html string

getHidden

public static java.lang.String getHidden(java.lang.String name,
                                         java.lang.String value)

Returns hidden component for html form

Parameters:

name - Name of the HTML hidden component.

value - Value of the HTML hidden component.

Returns:

HTML code containing the HTML hidden component.

getHidden

public static java.lang.String getHidden(java.lang.String name,
                                         int value)

Returns hidden component for html form

Parameters:

name - Name of the HTML hidden component.

value - Value of the HTML hidden component.

Returns:

HTML code containing the HTML hidden component.

getSubmit

public static java.lang.String getSubmit(java.lang.String name,
                                         java.lang.String value)

Returns submit component for html form

Parameters:

name - Name of the HTML submit component.

value - Value of the HTML submit component.

Returns:

HTML code containing the HTML submit component.

printSubmit

public void printSubmit(java.lang.String name,
                        java.lang.String value)

Prints translated submit button to current writer

Parameters:

name - button component name

value - text on button

getLabel

public static java.lang.String getLabel(java.lang.String text)

Returns NON-TRANSLATED text with label style (used in html forms). to do: should the text be translated?

Parameters:

text - content text

Returns:

HTML code for label

getH

public java.lang.String getH(java.lang.String text)

Returns page's main headline. Translates text.

Parameters:

text - content text

Returns:

HTML code for headline

getH

public java.lang.String getH(java.lang.String text,
                             int level)

Returns page's headline of given level. Translates text.

Parameters:

text - content text

level - content level

Returns:

HTML code for headline

begin_javascript

public static java.lang.String begin_javascript()

Retuns script tag and begin HTML comment. Always use in conjunction with end_javascript!

Returns:

HTML code to begin javascript.

See Also:

end_javascript()

end_javascript

public static java.lang.String end_javascript()

Retuns end HTML comment and end script tag. Always use in conjunction with begin_javascript!

Returns:

HTML code to end javascript

See Also:

begin_javascript()

begin_table

public static java.lang.String begin_table()

return begin table tag with parameters, standard formatting

Returns:

HTML code for begin table

getJsButton

public java.lang.String getJsButton(java.lang.String name,
                                    java.lang.String value,
                                    java.lang.String onClick)

Returns javascript code for printing a submit button. translated.

Parameters:

name - component name

value - component value

onClick - javascript code to execute on click

Returns:

javascript code for printing a submit button.

getCurrentPage

public static java.lang.String getCurrentPage(javax.servlet.http.HttpServletRequest r)
                                       throws java.net.MalformedURLException

Returns current page filename, no request parameters or path.

Parameters:

r - request from JSP page

Returns:

page filename

Throws:

MalformedURLException - if URI is not valid

getCurrentTime

public static java.lang.String getCurrentTime()

Returns current time in string. parameter "currentTime". Can be appended in URL.

Returns:

current time in string - can be appended in urls that mustn't be cached

printOptionValues

public void printOptionValues(java.util.Hashtable translations,
                              java.lang.String selected)

Taken from portal/pageAddUser. Sorts hashtable values and puts them in a combo box.

Parameters:

translations - Translation values in a hash table (key id)

selected - Selected value

printSelectList

public void printSelectList(java.lang.String name,
                            java.util.Hashtable values,
                            java.lang.String selected,
                            java.lang.String nullString)

Creates a new HTML Select list based on hashtable. hashtable values are not translated!

Parameters:

name - The name of HTML Select list.

values - Values to be printed (keys are ids)

selected - Id that is selected.

nullString - nullstring is added in the beginning with value 0 (if nullString==null, nothing is added)

printHtmlTable

public void printHtmlTable(HtmlTable h)

Prints a HtmlTable component on current writer

Parameters:

h - HtmlTable component

See Also:

HtmlTable

getCurrentTimeAsHidden

public static java.lang.String getCurrentTimeAsHidden()

Returns current time as a hidden control to ensure cache-free functionality.

Returns:

HTML code to be put inside a form

getLink

public static java.lang.String getLink(java.lang.String title,
                                       java.lang.String value,
                                       java.lang.String defaultTitle)

Returns HTML code for a link. If title is empty, defaultTitle is appended instead.

Parameters:

title - Visible text in link

value - value appended to base text

defaultTitle - visible text if title is empty

Returns:

HTML code for a link

getLink

public static java.lang.String getLink(java.lang.String title,
                                       java.lang.String value)

Returns HTML code for a link.

Parameters:

title - Visible text in link

value - value appended to base text

Returns:

HTML code for a link