|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Object
|
+--com.opencms.template.A_CmsXmlContent
|
+--com.opencms.template.CmsXmlTemplateFile
|
+--com.opencms.defaults.CmsXmlFormTemplateFile
Template content definition for generating HTML forms. This is an extension of the default template content definition. Special tags for handling HTML form elements are added here. See the handleXxxTag Methods for more details.
| Field Summary | |
static String |
C_RADIO_CLASS
Stylesheet class string of the radio button |
static String |
C_RADIO_CLASSNAME
Stylesheet class name of the radio button |
static String |
C_RADIO_LINK
Name of the radio button link |
static String |
C_RADIO_METHOD
Method of the radio buttons |
static String |
C_RADIO_NAME
Name of the radio button value |
static String |
C_RADIO_ORDER
Name of the radio ordering information |
static String |
C_RADIO_RADIONAME
Name of the radio buttons |
static String |
C_RADIO_SELECTEDENTRY
Datablock conatining the optional entry for the "checked" option |
static String |
C_RADIO_SELECTEDOPTION
Datablock conatining the "checked" option |
static String |
C_SELECTBOX_CLASS
Stylesheet class string of the select box |
static String |
C_SELECTBOX_CLASSNAME
Stylesheet class name of the select box |
static String |
C_SELECTBOX_DIV
Div flag of the select box |
static String |
C_SELECTBOX_METHOD
Method of the select box |
static String |
C_SELECTBOX_NAME
Name of the select box |
static String |
C_SELECTBOX_ONCHANGE
Onchange of the select box |
static String |
C_SELECTBOX_OPTIONNAME
option name of the select box |
static String |
C_SELECTBOX_OPTIONVALUE
option value of the select box |
static String |
C_SELECTBOX_SIZE
Size of the select box |
static String |
C_SELECTBOX_WIDTH
Width of the select box |
static String |
C_SELECTBOX_WIDTHNAME
Stylesheet class name of the select box |
static String |
C_TAG_RADIO_CLASS
Name of the radio "class" option tag in the input definiton template |
static String |
C_TAG_RADIO_COLENTRY
Name of the radion column entry tag in the input definiton template |
static String |
C_TAG_RADIO_ROWENTRY
Name of the radion row entry tag in the input definiton template |
static String |
C_TAG_SELECTBOX_CLASS
Name of the selectbox "class" option tag in the input definiton template |
static String |
C_TAG_SELECTBOX_END
Name of the select end tag in the input definiton template |
static String |
C_TAG_SELECTBOX_OPTION
Name of the (select) option tag in the input definiton template |
static String |
C_TAG_SELECTBOX_SELOPTION
Name of the (select) selected option tag in the input definiton template |
static String |
C_TAG_SELECTBOX_START
Name of the select start tag in the input definiton template |
static String |
C_TAG_SELECTBOX_START_DIV
Name of the select div start tag in the input definiton template |
static String |
C_TAG_SELECTBOX_WIDTH
Name of the selectbox "width" option tag in the input definiton template |
| Fields inherited from class com.opencms.template.CmsXmlTemplateFile |
C_EDIT_TEMPLATE, C_TEMPLATE |
| Fields inherited from class com.opencms.template.A_CmsXmlContent |
C_ERR_NODATABLOCK, C_MINIMUM_CLASSNAME, C_PARAMTYPES_HANDLING_METHODS, C_PARAMTYPES_USER_METHODS, C_REGISTER_FIRST_RUN, C_REGISTER_MAIN_RUN, C_TEMPLATE_EXTENSION, C_TEMPLATEPATH, m_cms, m_firstRunTags, m_knownTags, m_mainProcessTags |
| Fields inherited from interface com.opencms.boot.I_CmsLogChannels |
C_FLEX_CACHE, C_FLEX_LOADER, C_LOGGING, C_MODULE_CRITICAL, C_MODULE_DEBUG, C_MODULE_INFO, C_OPENCMS_CACHE, C_OPENCMS_CRITICAL, C_OPENCMS_CRONSCHEDULER, C_OPENCMS_DEBUG, C_OPENCMS_ELEMENTCACHE, C_OPENCMS_INFO, C_OPENCMS_INIT, C_OPENCMS_POOL, C_OPENCMS_STATICEXPORT, C_OPENCMS_STREAMING, C_PREPROCESSOR_IS_LOGGING |
| Constructor Summary | |
CmsXmlFormTemplateFile()
Default constructor. |
|
CmsXmlFormTemplateFile(CmsObject cms,
CmsFile file)
Constructor for creating a new object containing the content of the given filename. |
|
CmsXmlFormTemplateFile(CmsObject cms,
String filename)
Constructor for creating a new object containing the content of the given filename. |
|
| Method Summary | |
String |
getXmlDocumentTagName()
Gets the expected tagname for the XML documents of this content type |
Object |
handleRadiobuttonTag(Element n,
Object callingObject,
Object userObj)
Handles any occurence of the special XML tag <RADIOBUTTON> for
generating HTML form radio buttons.
|
Object |
handleSelectTag(Element n,
Object callingObject,
Object userObj)
Handles any occurence of the special XML tag <SELECT> for
generating HTML form select boxes.
|
| Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
public static final String C_SELECTBOX_NAME
public static final String C_SELECTBOX_SIZE
public static final String C_SELECTBOX_DIV
public static final String C_SELECTBOX_CLASS
public static final String C_SELECTBOX_CLASSNAME
public static final String C_SELECTBOX_WIDTHNAME
public static final String C_SELECTBOX_WIDTH
public static final String C_SELECTBOX_ONCHANGE
public static final String C_SELECTBOX_METHOD
public static final String C_SELECTBOX_OPTIONNAME
public static final String C_SELECTBOX_OPTIONVALUE
public static final String C_RADIO_RADIONAME
public static final String C_RADIO_NAME
public static final String C_RADIO_LINK
public static final String C_RADIO_CLASS
public static final String C_RADIO_CLASSNAME
public static final String C_RADIO_SELECTEDOPTION
public static final String C_RADIO_SELECTEDENTRY
public static final String C_RADIO_METHOD
public static final String C_RADIO_ORDER
public static final String C_TAG_SELECTBOX_START
public static final String C_TAG_SELECTBOX_START_DIV
public static final String C_TAG_SELECTBOX_END
public static final String C_TAG_SELECTBOX_CLASS
public static final String C_TAG_SELECTBOX_WIDTH
public static final String C_TAG_SELECTBOX_OPTION
public static final String C_TAG_SELECTBOX_SELOPTION
public static final String C_TAG_RADIO_CLASS
public static final String C_TAG_RADIO_COLENTRY
public static final String C_TAG_RADIO_ROWENTRY
| Constructor Detail |
public CmsXmlFormTemplateFile()
throws CmsException
public CmsXmlFormTemplateFile(CmsObject cms,
CmsFile file)
throws CmsException
cms - CmsObject object for accessing system resources.
public CmsXmlFormTemplateFile(CmsObject cms,
String filename)
throws CmsException
cms - CmsObject object for accessing system resources.filename - Name of the body file that shoul be read.| Method Detail |
public String getXmlDocumentTagName()
getXmlDocumentTagName in class CmsXmlTemplateFile
public Object handleRadiobuttonTag(Element n,
Object callingObject,
Object userObj)
throws CmsException
<RADIOBUTTON> for
generating HTML form radio buttons.
The definition of a HTML radio button will be taken from I_CmsWpConstants.C_VFS_PATH_DEFAULT_INTERNAL + "HTMLFormDefs". If the file is missing, this method will crash. Ensure this file is created and filled with all required XML tags.
Radio buttons can be generated by adding the special XML tag
<RADIOBUTTON class="myClass" method="myMethod" name="myName"/>
to the template file. This tag will be replaced with the correspondig group of radio buttons
while processing the template file. The class parameter is optional.
The method parameter will be used to look up a user defined method
in the template class assigned to the template file. This method should look like
public Integer myMethod(CmsObject cms, Vector names, Vector values, Hashtable parameters)
and will be used to get the content of the requested radion button group. The vectors names
and values should be filled with the appropriate values. The return value should be an
Integer containing the pre-selected radio button or -1, if no value should be pre-selected.
n - XML element containing the current special workplace tag.callingObject - reference to the calling object.userObj - hashtable containig all user parameters.
CmsException
public Object handleSelectTag(Element n,
Object callingObject,
Object userObj)
throws CmsException
<SELECT> for
generating HTML form select boxes.
The definition of a HTML selectbox will be taken from I_CmsWpConstants.C_VFS_PATH_DEFAULT_INTERNAL + "HTMLFormDefs". If the file is missing, this method will crash. Ensure this file is created and filled with all required XML tags.
Select boxes can be generated by adding the special XML tag
<SELECT class="myClass" method="myMethod" name="myName" onchange="..." size="..."/>
to the template file. This tag will be replaced with the correspondig select box
while processing the template file. The class parameter is optional and
The method parameter will be used to look up a user defined method
in the template class assigned to the template file. This method should look like
public Integer myMethod(CmsObject cms, Vector names, Vector values, Hashtable parameters)
and will be used to get the content of the requested select box group. The vectors names
and values should be filled with the appropriate values. The return value should be an
Integer containing the pre-selected option or -1, if no value should be pre-selected.
n - XML element containing the current special workplace tag.callingObject - reference to the calling object.userObj - hashtable containig all user parameters.
CmsException
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||