public interface GXITagsAccesor
getTagsAccesor()
,setTagContent,setTagAttribute
,
or complex tags such as combobox, radio buttons and table.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 tagId,
String keyCol)
This method is used for setting the key column(s) of a gx table tag.
|
String |
getFileName(String tagId)
Retrieves a file name of an uploaded file according to the tag ID
(<gx:input type="file" id=" |
InputStream |
getInputStream(String tagId)
Retrieves an Input Stream for an uploaded file according to the tag ID
(<gx:input type="file" id=" |
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
addTableKeyColumn(String, String) .If key columns were not added, the row index is returned. |
String[] |
getTableSelectedKeys(String tagId)
Returns the values of the selected keys, as specified in
addTableKeyColumn(String, String) . |
String |
getTagAttribute(String tagId,
String attributeName)
Returns the content of an attribute of a specific tag per tag id and the attribute name
|
String |
getTagContent(String tagId)
Retrieves the tag content from the Request scope.
|
void |
setBodyAttribute(String attrName,
String content)
Deprecated.
Use
addJSToForm(String jsString) - <script>document.body.<ATTR_NAME> = <ATTR_VALUE>;</script> instead |
void |
setFormAttribute(String attrName,
String content)
Sets a dynamic attribute to <gx:form> tag.
|
void |
setPageVisible(boolean visible)
When set to false, the page will not be rendered.
|
void |
setTagAttribute(String tagId,
String attrName,
String content)
Sets a dynamic attribute to the specified tag ID.
|
void |
setTagContent(String tagId,
String content)
Sets content to a gx tag with the specified tag ID.
|
void |
setTagList(String tagId,
GXINameValueCollection list)
This method provides a text-value collection to either a radio button list
(<gx:radioButtonList>) or
to a combo box element (<gx:select>) . |
void |
setTagList(String tagId,
Hashtable list)
Deprecated.
Use
setTagList(String tagId,com.sabratec.applinx.framework.GXINameValueCollection) instead |
void |
setTagTable(String tagId,
GXITable table) |
void |
setTagTable(String tagId,
GXITable table,
com.sabratec.j2ee.framework.web.tables.GXITableBuildConfig config,
GXITableEvents events) |
void |
setTagTable(String tagId,
GXITable table,
GXITableBuildConfig config) |
void |
setTagTable(String tagId,
GXITable table,
GXITableBuildConfig config,
GXITableEvents events)
This method is used for filling a
<gx:table> tag with the data from the data table GXITable . |
void |
setTagVisible(String tagId,
boolean visible)
When set to false, the specified tag ID will not be rendered.
|
void setTagContent(String tagId, String content)
<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.
tagId
- The ID of the gx tagcontent
- The dynamic content to set to the gx tagString getTagContent(String tagId)
setTagContent
for the specified tag ID was already set it will be returned,
otherwise the form/queryString value will be returned.tagId
- the content of the specified tag IDvoid setTagVisible(String tagId, boolean visible)
tagId
- The tag ID to hidevisible
- true/false to determine whether to hide/show a tagvoid setPageVisible(boolean visible)
visible
- true/false to determine whether to hide/show the pagevoid setTagAttribute(String tagId, String attrName, String content)
tagId
- the tag IDattrName
- the name of the attribute to setcontent
- the content for the attributevoid setTagList(String tagId, Hashtable list)
setTagList(String tagId,com.sabratec.applinx.framework.GXINameValueCollection)
insteadvoid setTagList(String tagId, GXINameValueCollection list)
(<gx:radioButtonList>)
or
to a combo box element (<gx:select>)
.
To use this method, initialize a name-value collection
and add text-value pairs to it.tagId
- the tag ID of the radio button list/combo box which the dynamic list should be providedlist
- the list of text-value itemsvoid setTagTable(String tagId, GXITable table, com.sabratec.j2ee.framework.web.tables.GXITableBuildConfig config, GXITableEvents events)
void setTagTable(String tagId, GXITable table, GXITableBuildConfig config, GXITableEvents events)
<gx:table>
tag with the data from the data table GXITable
.tagId
- The ID of <gx:table>table
- The data tableconfig
- a configuration class with common options of how to build the table HTMLevents
- a table events class which receives events on every new element creation (row,cell and a tag with a cell).GXITableBuildConfig
,
GXITableEvents
,
GXAbstractHtmlTableTag
,
GXIClientBaseObject.getTable()
void addTableKeyColumn(String tagId, String keyCol)
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 getTableSelectedKey(String)
and use it in order to find and drill down to the relevant row.tagId
- The table tag IDkeyCol
- The key column name in GXITable.getColumns()
String getTableName()
String getTableSelectedKey(String tagId)
addTableKeyColumn(String, String)
.tagId
- The table tag IDString[] getTableSelectedKeys(String tagId)
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.tagId
- The table tag IDvoid AddHiddenFieldToForm(String name, String value)
name
- The name of the hidden fieldvalue
- The value of the hidden fieldvoid AddJSToForm(String jsString)
jsString
- The JavaScript command(s)void AddHtmlTextToForm(String htmlText)
htmltext
- the html text to addvoid setBodyAttribute(String attrName, String content)
addJSToForm(String jsString) - <script>document.body.<ATTR_NAME> = <ATTR_VALUE>;</script>
insteadvoid setFormAttribute(String attrName, String content)
attrName
- The name of the attributecontent
- The content of the attributeInputStream getInputStream(String tagId) throws IOException
(<gx:input type="file" id="...>).
tagId
- the input file tag IDIOException
String getFileName(String tagId) throws IOException
(<gx:input type="file" id="...>).
tagId
- The input file tag IDIOException
String getTagAttribute(String tagId, String attributeName)
tagId
- the tag IDattributeName
- the attribute nameCopyright 2021 Software AG. All rights reserved. Use is subject to license terms.