com.sabratec.j2ee.framework.web.taglib

Class GXTagsAccesorImpl

java.lang.Object

com.sabratec.j2ee.framework.web.taglib.GXTagsAccesorImpl

All Implemented Interfaces:

GXITagsAccesor, Serializable

public class GXTagsAccesorImpl
extends Object
implements GXITagsAccesor, Serializable

Impl. class for GXITagsAccesor

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GXTagsAccesorImpl(HttpServletRequest request)

Method Summary

Modifier and Type	Method and Description
void	AddHiddenFieldToForm(String name, String value) Dynamically adds an input hidden field to the JSP page.
void	AddHtmlTextToForm(String htmlText) Adds an HTML text to the JSP page.
void	AddJSToForm(String jsString) Adds a JavaScript code to the JSP page.
void	addTableKeyColumn(String refTagId, String keyCol) This method is used for setting the key column(s) of a gx table tag.
String	getBodyAttribute(String attrName)
Hashtable	getBodyAttributes()
String	getFileName(String refTagId) Retrieves a file name of an uploaded file according to the tag ID (<gx:input type="file" id="...>).
String	getFormAttribute(String attrName)
Hashtable	getFormAttributes()
String	getFormTopString()
Map	getHiddens()
InputStream	getInputStream(String refTagId) Retrieves an Input Stream for an uploaded file according to the tag ID (<gx:input type="file" id="...>).
Hashtable	getInputTagAttributes(String refTagid)
String	getPanelToUpdate()
String	getPanelToUpdateContent()
String	getTableName() Used for retrieving the table tag ID in the current page
String	getTableSelectedKey(String tagId) Returns the value of the selected key, as specified in GXITagsAccesor.addTableKeyColumn(String, String). If key columns were not added, the row index is returned.
String[]	getTableSelectedKeys(String refTagId) Returns the values of the selected keys, as specified in GXITagsAccesor.addTableKeyColumn(String, String).
String	getTagAttribute(String refTagId, String attrName) Returns the content of an attribute of a specific tag per tag id and the attribute name
Hashtable	getTagAttributes(String refTagid)
String	getTagContent(String tagId) Retrieves the tag content from the Request scope.
String[]	getTagContents(String refTagName)
boolean	isTagVisible(String refTagId)
void	recycleBodyTag()
void	recycleTag(String refTagId, Hashtable tagPrivateAttributes)
void	removeTagAttribute(String refTagId, String attrName)
void	setAttributeListIfEmpty(String refTagId, Hashtable attrList)
void	setBodyAttribute(String attrName, String content)
void	setBodyAttributeIfEmpty(String attrName, String content)
void	setFormAttribute(String attrName, String content) Sets a dynamic attribute to <gx:form> tag.
void	setInputTagAttribute(String refTagId, String attrName, String content)
void	setPageVisible(boolean visible) When set to false, the page will not be rendered.
void	setPanelToUpdateContent(String content)
void	setTagAttribute(String refTagId, String attrName, String content) Sets a dynamic attribute to the specified tag ID.
void	setTagContent(String refTagId, String content) Sets content to a gx tag with the specified tag ID.
void	setTagContentIfEmpty(String refTagId, String content)
void	setTagList(String refTagId, GXINameValueCollection list)
void	setTagList(String refTagId, Hashtable list)
void	setTagTable(String tagId, GXITable table)
void	setTagTable(String refTagId, GXITable table, com.sabratec.j2ee.framework.web.tables.GXITableBuildConfig config, GXITableEvents events) Deprecated. Use setTagTable(String, GXITable, GXITableBuildConfig, GXITableEvents) instead
void	setTagTable(String tagId, GXITable table, GXITableBuildConfig config)
void	setTagTable(String refTagId, GXITable table, GXITableBuildConfig config, GXITableEvents events)
void	setTagVisible(String refTagId, boolean visible) When set to false, the specified tag ID will not be rendered.
void	setTagVisibleIfEmpty(String refTagId, boolean visible)

Methods inherited from class java.lang.Object

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

Constructor Detail

GXTagsAccesorImpl

public GXTagsAccesorImpl(HttpServletRequest request)

Method Detail

setTagContent

public void setTagContent(String refTagId,
                          String content)

Description copied from interface: GXITagsAccesor

Sets content to a gx tag with the specified tag ID. The content is set to the relevant tag according to the tag type:

• <gx:input> - the content is set in the value attribute.
• <gx:span> (or any other label tag) - the content is set as the inner HTML.
• <gx:select> - the content is set by the option whose value is equal to the specified content.
• <gx:radioButtonList> - the content is set by the radio button whose value is equal to the specified content.
• <gx:checkbox> - the check box is checked if the content equals the checked value.

Specified by:

setTagContent in interface GXITagsAccesor

Parameters:

refTagId - The ID of the gx tag

content - The dynamic content to set to the gx tag

setTagContentIfEmpty

public void setTagContentIfEmpty(String refTagId,
                                 String content)

getTagContents

public String[] getTagContents(String refTagName)

getTagContent

public String getTagContent(String tagId)

Description copied from interface: GXITagsAccesor

Retrieves the tag content from the Request scope. If setTagContent for the specified tag ID was already set it will be returned, otherwise the form/queryString value will be returned.

Specified by:

getTagContent in interface GXITagsAccesor

Parameters:

tagId - the content of the specified tag ID

Returns:

the tag's content/value

setTagVisible

public void setTagVisible(String refTagId,
                          boolean visible)

Description copied from interface: GXITagsAccesor

When set to false, the specified tag ID will not be rendered.

Specified by:

setTagVisible in interface GXITagsAccesor

Parameters:

refTagId - The tag ID to hide

visible - true/false to determine whether to hide/show a tag

setTagVisibleIfEmpty

public void setTagVisibleIfEmpty(String refTagId,
                                 boolean visible)

isTagVisible

public boolean isTagVisible(String refTagId)

setTagList

public void setTagList(String refTagId,
                       Hashtable list)

Specified by:

setTagList in interface GXITagsAccesor

setTagTable

public void setTagTable(String tagId,
                        GXITable table)

Specified by:

setTagTable in interface GXITagsAccesor

See Also:

GXITagsAccesor.setTagTable(String, GXITable, GXITableBuildConfig, GXITableEvents)

setTagTable

public void setTagTable(String tagId,
                        GXITable table,
                        GXITableBuildConfig config)

Specified by:

setTagTable in interface GXITagsAccesor

See Also:

GXITagsAccesor.setTagTable(String, GXITable, GXITableBuildConfig, GXITableEvents)

setTagTable

@Deprecated
public void setTagTable(String refTagId,
                                     GXITable table,
                                     com.sabratec.j2ee.framework.web.tables.GXITableBuildConfig config,
                                     GXITableEvents events)

Deprecated. Use setTagTable(String, GXITable, GXITableBuildConfig, GXITableEvents) instead

Specified by:

setTagTable in interface GXITagsAccesor

setTagTable

public void setTagTable(String refTagId,
                        GXITable table,
                        GXITableBuildConfig config,
                        GXITableEvents events)

Specified by:

setTagTable in interface GXITagsAccesor

addTableKeyColumn

public void addTableKeyColumn(String refTagId,
                              String keyCol)

Description copied from interface: GXITagsAccesor

This method is used for setting the key column(s) of a gx table tag. Setting a key column is needed when you are interested to know the key column value when a row is selected. For example, if you have collected a multiple screens table with an item number column, and you would like to show details of an item (according to the item number) when clicking on a button in this row.
If you will use addTableKeyColumn("TABLE TAG ID","ItemNumber") before the table is displayed, when you will select a row and post back to the context class, you will be able to retrieve the selected item number using GXITagsAccesor.getTableSelectedKey(String) and use it in order to find and drill down to the relevant row.

Specified by:

addTableKeyColumn in interface GXITagsAccesor

Parameters:

refTagId - The table tag ID

keyCol - The key column name in GXITable.getColumns()

getTableSelectedKey

public String getTableSelectedKey(String tagId)

Description copied from interface: GXITagsAccesor

Returns the value of the selected key, as specified in GXITagsAccesor.addTableKeyColumn(String, String).
If key columns were not added, the row index is returned.

Specified by:

getTableSelectedKey in interface GXITagsAccesor

Parameters:

tagId - The table tag ID

Returns:

The key column value

getTableSelectedKeys

public String[] getTableSelectedKeys(String refTagId)

Description copied from interface: GXITagsAccesor

Returns the values of the selected keys, as specified in GXITagsAccesor.addTableKeyColumn(String, String). Use this method when you specify more then one key column in the method addTableKeyColumn. If key columns were not added, the row index is returned.

Specified by:

getTableSelectedKeys in interface GXITagsAccesor

Parameters:

refTagId - The table tag ID

Returns:

A String array of the key columns values

getTableName

public String getTableName()

Description copied from interface: GXITagsAccesor

Used for retrieving the table tag ID in the current page

Specified by:

getTableName in interface GXITagsAccesor

Returns:

The last built table name

removeTagAttribute

public void removeTagAttribute(String refTagId,
                               String attrName)

setTagAttribute

public void setTagAttribute(String refTagId,
                            String attrName,
                            String content)

Description copied from interface: GXITagsAccesor

Sets a dynamic attribute to the specified tag ID. When such a static attribute exsists in gx tag in the JSP page, it will be overriden.

Specified by:

setTagAttribute in interface GXITagsAccesor

Parameters:

refTagId - the tag ID

attrName - the name of the attribute to set

content - the content for the attribute

setInputTagAttribute

public void setInputTagAttribute(String refTagId,
                                 String attrName,
                                 String content)

setAttributeListIfEmpty

public void setAttributeListIfEmpty(String refTagId,
                                    Hashtable attrList)

getTagAttribute

public String getTagAttribute(String refTagId,
                              String attrName)

Description copied from interface: GXITagsAccesor

Returns the content of an attribute of a specific tag per tag id and the attribute name

Specified by:

getTagAttribute in interface GXITagsAccesor

Parameters:

refTagId - the tag ID

attrName - the attribute name

Returns:

the content of an attribute of a specific tag per tag id and the attribute name

AddHiddenFieldToForm

public void AddHiddenFieldToForm(String name,
                                 String value)

Description copied from interface: GXITagsAccesor

Dynamically adds an input hidden field to the JSP page.

Specified by:

AddHiddenFieldToForm in interface GXITagsAccesor

Parameters:

name - The name of the hidden field

value - The value of the hidden field

getHiddens

public Map getHiddens()

AddJSToForm

public void AddJSToForm(String jsString)

Description copied from interface: GXITagsAccesor

Adds a JavaScript code to the JSP page. The script should be wrapped with <script>...</script> tag.

Specified by:

AddJSToForm in interface GXITagsAccesor

Parameters:

jsString - The JavaScript command(s)

AddHtmlTextToForm

public void AddHtmlTextToForm(String htmlText)

Adds an HTML text to the JSP page.

Specified by:

AddHtmlTextToForm in interface GXITagsAccesor

Parameters:

htmltext - the html text to add

getFormTopString

public String getFormTopString()

setBodyAttributeIfEmpty

public void setBodyAttributeIfEmpty(String attrName,
                                    String content)

setBodyAttribute

public void setBodyAttribute(String attrName,
                             String content)

Specified by:

setBodyAttribute in interface GXITagsAccesor

getBodyAttribute

public String getBodyAttribute(String attrName)

setFormAttribute

public void setFormAttribute(String attrName,
                             String content)

Description copied from interface: GXITagsAccesor

Sets a dynamic attribute to <gx:form> tag.

Specified by:

setFormAttribute in interface GXITagsAccesor

Parameters:

attrName - The name of the attribute

content - The content of the attribute

getFormAttribute

public String getFormAttribute(String attrName)

getTagAttributes

public Hashtable getTagAttributes(String refTagid)

getInputTagAttributes

public Hashtable getInputTagAttributes(String refTagid)

getBodyAttributes

public Hashtable getBodyAttributes()

getFormAttributes

public Hashtable getFormAttributes()

setTagList

public void setTagList(String refTagId,
                       GXINameValueCollection list)

Specified by:

setTagList in interface GXITagsAccesor

recycleTag

public void recycleTag(String refTagId,
                       Hashtable tagPrivateAttributes)

recycleBodyTag

public void recycleBodyTag()

getInputStream

public InputStream getInputStream(String refTagId)
                           throws IOException

Description copied from interface: GXITagsAccesor

Retrieves an Input Stream for an uploaded file according to the tag ID (<gx:input type="file" id="...>).


Specified by:

getInputStream in interface GXITagsAccesor

Parameters:

refTagId - the input file tag ID

Returns:

Input Stream of the uploaded file

Throws:

IOException

getFileName

public String getFileName(String refTagId)
                   throws IOException

Description copied from interface: GXITagsAccesor

Retrieves a file name of an uploaded file according to the tag ID (<gx:input type="file" id="...>).


Specified by:

getFileName in interface GXITagsAccesor

Parameters:

refTagId - The input file tag ID

Returns:

The file name

Throws:

IOException

getPanelToUpdate

public String getPanelToUpdate()

getPanelToUpdateContent

public String getPanelToUpdateContent()

setPanelToUpdateContent

public void setPanelToUpdateContent(String content)

setPageVisible

public void setPageVisible(boolean visible)

Description copied from interface: GXITagsAccesor

When set to false, the page will not be rendered.

Specified by:

setPageVisible in interface GXITagsAccesor

Parameters:

visible - true/false to determine whether to hide/show the page