public abstract class IlvBaseTag extends javax.faces.webapp.UIComponentBodyTag implements IlvFacesConstants
IlvBaseTag
is the base class for the tag handlers of JViews faces components.
The methods provide an easy way to set properties on the component.bodyContent, pageContext, UNIQUE_ID_PREFIX
AFTER_HANDLER, BASETEXTDIRECTION, BEFORE_HANDLER, BUTTON_GROUP_ID, BUTTON_TYPE, CHARTS_BUNDLE, CHARTS_MESSAGE_BUNDLE, CORE_BUNDLE, CORE_MESSAGE_BUNDLE, CURSOR, DATA, DECODED_PROPERTY, DEFAULT_LINE_COLOR, DELETION_ALLOWED, DIAGRAMMER_BUNDLE, DIAGRAMMER_MESSAGE_BUNDLE, ENABLED, EVENT_TYPE, FILL_ON, FORCE_UPDATE_PROPERTIES, FRAMEWORK_BUNDLE, FRAMEWORK_MESSAGE_BUNDLE, GANTT_BUNDLE, GANTT_MESSAGE_BUNDLE, HEIGHT, IMAGE, IMAGE_MODE, INFO_PROVIDER_MB, INT_NOT_DEFINED, INTERACTORS, INTERCEPT_INTERACTOR, ITEM_DISABLED_STYLE_CLASS, ITEM_HIGHLIGHTED_STYLE_CLASS, ITEM_STYLE_CLASS, LINE_COLOR, LINE_WIDTH, MAPS_BUNDLE, MAPS_MESSAGE_BUNDLE, MENU_MODEL_ID, MESSAGE, MESSAGE_BOX, MESSAGE_BOX_ID, MOVE_ALLOWED, OBJECT_FINDER, PARAM_COMPID, PARAM_DATA, PARAM_KEY, PARAM_NAMESPACE, PARAM_RESOURCE, PARAM_SERVICE, PARAM_TYPE, POPUP_MENU, POPUP_MENU_FACTORY, POPUP_MENU_FACTORY_CLASS, PORTLET_NAMESPACE, PROGRESSIVE_ZOOM, PROJECT, RENDER, RESOURCES_PATH, RESOURCES_PATH_PREFIX, ROLLOVER_IMAGE, SCROLL_BAR, SELECTED, SELECTED_IMAGE, SERVICE_FORWARD, SERVICE_FORWARD_INT, SERVLET, SERVLET_CLASS, SERVLET_URL, STYLE, STYLE_CLASS, TGO_BUNDLE, TGO_MESSAGE_BUNDLE, TITLE, TOGGLE, VALUE, VIEW, VIEW_ID, WIDTH
Modifier | Constructor and Description |
---|---|
protected |
IlvBaseTag()
Creates a new
IlvBaseTag instance. |
Modifier and Type | Method and Description |
---|---|
String |
getComponentType()
Returns the component type for the component that is or will be
bound to this tag.
|
String |
getPartialTriggers()
Returns the space separated list of partial trigger IDs.
|
String |
getRendererType()
Return the
rendererType property that selects the
Renderer to be used for encoding this component, or
null to ask the component to render itself directly. |
protected String[] |
getStringArray(String param)
Decodes the specified space separated list of strings.
|
void |
setPartialTriggers(String partialTriggers)
Sets the space separated list of partial trigger IDs.
|
protected void |
setProperties(javax.faces.component.UIComponent component)
Override properties and attributes of the specified component,
if the corresponding properties of this tag handler instance were
explicitly set.
|
protected void |
setProperty(javax.faces.component.UIComponent component,
String propertyId,
String propertyValue)
Sets a property on the component.
|
protected boolean |
setVBProperty(javax.faces.component.UIComponent component,
String propertyId,
String propertyValue)
Sets the property on the component if the property value is a referenced
value.
|
void |
testSetProperties(javax.faces.component.UIComponent component) |
createComponent, getParentUIComponentTag, hasBinding, isSuppressed, isValueReference, release, setBinding, setRendered
addChild, addFacet, addVerbatimAfterComponent, addVerbatimBeforeComponent, createVerbatimComponent, createVerbatimComponentFromBodyContent, doAfterBody, doEndTag, doInitBody, doStartTag, encodeBegin, encodeChildren, encodeEnd, findComponent, getBodyContent, getComponentInstance, getCreated, getCreatedComponents, getDoAfterBodyValue, getDoEndValue, getDoStartValue, getFacesContext, getFacesJspId, getFacetName, getId, getIndexOfNextChildTag, getJspId, getParent, getParentUIComponentClassicTagBase, getPreviousOut, setBodyContent, setId, setJspId, setPageContext, setParent, setupResponseWriter
public String getComponentType()
Returns the component type for the component that is or will be bound to this tag.
This implementation returns null
, subclasses must
override this method to return the appropriate value.
getComponentType
in class javax.faces.webapp.UIComponentTagBase
public String getRendererType()
Return the rendererType
property that selects the
Renderer
to be used for encoding this component, or
null
to ask the component to render itself directly.
This implementation return null
, subclasses must override
this method to return the appropriate value.
getRendererType
in class javax.faces.webapp.UIComponentTagBase
protected boolean setVBProperty(javax.faces.component.UIComponent component, String propertyId, String propertyValue)
component
- The component to customize.propertyId
- The name of the property to set.propertyValue
- The value of the property.true
If the property is a referenced value and was set, false
otherwise.protected void setProperty(javax.faces.component.UIComponent component, String propertyId, String propertyValue)
component
- The component to customize.propertyId
- The name of the property to set.propertyValue
- The value of the property.public void testSetProperties(javax.faces.component.UIComponent component)
component
- The component to test.protected void setProperties(javax.faces.component.UIComponent component)
Override properties and attributes of the specified component, if the corresponding properties of this tag handler instance were explicitly set. This method must be called ONLY if the specified component was in fact created during the execution of this tag handler instance, and this call will occur BEFORE the component is added to the view.
Tag subclasses that want to support additional set properties
must ensure that the base class setProperties()
method is still called. A typical implementation that supports
extra properties foo
and bar
would look
something like this:
protected void setProperties(UIComponent component) { super.setProperties(component); if (foo != null) { component.setAttribute("foo", foo); } if (bar != null) { component.setAttribute("bar", bar); } }
setProperties
in class javax.faces.webapp.UIComponentTag
component
- The component whose properties are to be
overriddenprotected String[] getStringArray(String param)
param
- The string to decode.null
if the parameter is null
.public String getPartialTriggers()
public void setPartialTriggers(String partialTriggers)
partialTriggers
- The partial triggers.© Copyright Rogue Wave Software, Inc. 1997, 2018. All Rights Reserved.