|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.servlet.jsp.tagext.TagSupport
com.ibm.ccd.ui.tags.BaseUITag
public abstract class BaseUITag
Field Summary | |
---|---|
protected java.lang.String |
alt
attributes for the alt field of html element.The default value is blank string. |
protected java.lang.String |
enabled
attribute enabled can have value true or false.Html field can enabled or disabled. |
protected boolean |
fromHtmlEmitter
This attribute is true when the Tag Class is invoked from Emitter caller class and not from customized tag.so pageContext will not be available.portletContext will be available. |
protected java.lang.String |
id
attributes for the id field of html element |
protected boolean |
labelRequired
At times the tag needs to be generated without the label, this attribute helps control the label generation |
protected java.util.Locale |
locale
Locales are passed from Request object.The default is locale is US. |
protected org.apache.jetspeed.portlet.PortletLog |
log
attribute used for log |
protected java.lang.String |
mandatory
attributes for the mandatory field of html element.The default value is false. |
protected java.lang.String |
name
attributes for the name field of html element |
protected javax.servlet.jsp.JspWriter |
out
this JspWriter to place the output |
protected org.apache.jetspeed.portlet.PortletContext |
portletContext
attribute stores the PortletContext |
protected java.lang.String |
style
attributes for the style field of html element |
protected UILabel |
uiLabel
attribute UILabel is used to for localized label for html field |
protected java.lang.String |
value
attributes for the value field of html element |
Fields inherited from class javax.servlet.jsp.tagext.TagSupport |
---|
pageContext |
Fields inherited from interface javax.servlet.jsp.tagext.IterationTag |
---|
EVAL_BODY_AGAIN |
Fields inherited from interface javax.servlet.jsp.tagext.Tag |
---|
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE |
Constructor Summary | |
---|---|
BaseUITag()
BaseUITag : Constructor |
Method Summary | |
---|---|
protected void |
displayField()
Renders the html content which the tag is expected to display. |
protected void |
displayForMandatory()
performs the mandatory field check. |
protected void |
displayLabel()
Displays the label for this html component. |
protected void |
displayTag()
Constructs the html component structure. |
int |
doEndTag()
doEndTag is called by the JSP container when the tag is closed |
int |
doStartTag()
doStartTag is called by the JSP container when the tag is encountered |
java.lang.String |
getAlt()
|
java.lang.String |
getEnabled()
|
java.lang.String |
getId()
|
java.util.Locale |
getLocale()
|
org.apache.jetspeed.portlet.PortletLog |
getLog()
|
java.lang.String |
getMandatory()
|
java.lang.String |
getName()
|
org.apache.jetspeed.portlet.PortletContext |
getPortletContext()
|
java.lang.String |
getSize()
attribute for getting the size of html elements.Some html element may not use it. |
java.lang.String |
getStyle()
|
java.lang.String |
getTextLabel(org.apache.jetspeed.portlet.PortletRequest portletRequest,
java.lang.String key)
|
java.lang.String |
getTextMessages(org.apache.jetspeed.portlet.PortletRequest portletRequest,
java.lang.String key)
|
UILabel |
getUiLabel()
|
java.lang.String |
getValue()
|
protected void |
initialize()
|
protected boolean |
isEnabled()
|
protected boolean |
isFromHtmlEmitter()
This method returns true if Tag class is invoked from Emitter Class |
boolean |
isLabelRequired()
|
protected boolean |
isMandatory()
|
protected abstract void |
renderField()
Method for generating the html field.Tag Subclasses needs overwrite this method |
void |
setAlt(java.lang.String string)
|
void |
setEnabled(java.lang.String param)
|
void |
setId(java.lang.String string)
|
void |
setLabelRequired(boolean b)
|
void |
setLocale(java.util.Locale locale)
|
void |
setLog(org.apache.jetspeed.portlet.PortletLog log)
|
void |
setMandatory(java.lang.String string)
|
void |
setName(java.lang.String string)
|
void |
setPortletContext(org.apache.jetspeed.portlet.PortletContext context)
|
void |
setSize(java.lang.String string)
attribute for setting the size of html elements. |
void |
setStyle(java.lang.String string)
|
void |
setUiLabel(UILabel label)
|
void |
setValue(java.lang.String string)
|
protected int |
validate(java.lang.String inputParam,
int defaultValue)
|
Methods inherited from class javax.servlet.jsp.tagext.TagSupport |
---|
doAfterBody, findAncestorWithClass, getParent, getValue, getValues, release, removeValue, setPageContext, setParent, setValue |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected java.lang.String name
protected java.lang.String id
protected java.lang.String value
protected java.lang.String style
protected java.lang.String alt
protected java.lang.String mandatory
protected UILabel uiLabel
protected org.apache.jetspeed.portlet.PortletLog log
protected org.apache.jetspeed.portlet.PortletContext portletContext
protected boolean labelRequired
protected boolean fromHtmlEmitter
protected java.util.Locale locale
protected java.lang.String enabled
protected javax.servlet.jsp.JspWriter out
Constructor Detail |
---|
public BaseUITag()
Method Detail |
---|
protected void initialize()
protected int validate(java.lang.String inputParam, int defaultValue) throws java.lang.Exception
inputParam
- defaultValue
-
java.lang.Exception
public int doStartTag()
doStartTag
in interface javax.servlet.jsp.tagext.Tag
doStartTag
in class javax.servlet.jsp.tagext.TagSupport
protected void displayTag() throws java.lang.Exception
java.io.JspException
java.lang.Exception
protected void displayLabel() throws java.lang.Exception
javax.servlet.jsp.JspException
java.lang.Exception
protected void displayField() throws java.lang.Exception
javax.servlet.jsp.JspException
java.lang.Exception
public java.lang.String getTextLabel(org.apache.jetspeed.portlet.PortletRequest portletRequest, java.lang.String key)
portletRequest
- key
-
public java.lang.String getTextMessages(org.apache.jetspeed.portlet.PortletRequest portletRequest, java.lang.String key)
portletRequest
- key
-
protected abstract void renderField() throws java.lang.Exception
java.lang.Exception
protected void displayForMandatory() throws javax.servlet.jsp.JspException
javax.servlet.jsp.JspException
public int doEndTag()
doEndTag
in interface javax.servlet.jsp.tagext.Tag
doEndTag
in class javax.servlet.jsp.tagext.TagSupport
public java.lang.String getValue()
public void setValue(java.lang.String string)
string
- public java.lang.String getName()
public void setName(java.lang.String string)
string
- public java.lang.String getId()
getId
in class javax.servlet.jsp.tagext.TagSupport
public void setId(java.lang.String string)
setId
in class javax.servlet.jsp.tagext.TagSupport
string
- public org.apache.jetspeed.portlet.PortletLog getLog()
public org.apache.jetspeed.portlet.PortletContext getPortletContext()
public void setLog(org.apache.jetspeed.portlet.PortletLog log)
log
- public void setPortletContext(org.apache.jetspeed.portlet.PortletContext context)
context
- public java.lang.String getStyle()
public void setStyle(java.lang.String string)
string
- public boolean isLabelRequired()
public UILabel getUiLabel()
public void setLabelRequired(boolean b)
b
- public void setUiLabel(UILabel label)
label
- protected boolean isFromHtmlEmitter()
public java.util.Locale getLocale()
public void setLocale(java.util.Locale locale)
locale
- public java.lang.String getMandatory()
protected boolean isMandatory()
public void setMandatory(java.lang.String string)
string
- protected boolean isEnabled()
public void setEnabled(java.lang.String param)
param
- public java.lang.String getSize()
public void setSize(java.lang.String string)
public java.lang.String getEnabled()
public java.lang.String getAlt()
public void setAlt(java.lang.String string)
string
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |