com.ibm.bpe.jsf.component.taglib
Class NavigatorTag

java.lang.Object
  extended byjavax.faces.webapp.UIComponentTag
      extended byjavax.faces.webapp.UIComponentBodyTag
          extended bycom.ibm.bpe.jsf.component.taglib.NavigatorTag
All Implemented Interfaces:
javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class NavigatorTag
extends javax.faces.webapp.UIComponentBodyTag

This class is used to configure a Navigator Component and corresponds to the bpe:navigator tag.

Table of tag attributes:

tag attributedescriptionmandatory
styleClass The CSS style class name used for rendering false
titleStyleClass The CSS style class name used for rendering the title false
embeddedStyleClass The CSS style class name used for rendering the embedded parts false
label The label shown false
userRoles A comma seperated list of user roles. If this list is provided the navigator will only be rendered to a user who has one of the roles. false
*

Example:

    <bpe:navigator label="#{bundle['NAVIGATION.TASK.INSTANCES']}" styleClass="navigatorFrame" titleStyleClass="taskNavigatorTitle" >

                <h:commandLink styleClass="navigatorItem navigatorItemList" id="MyTasks" action="#{TaskInstanceListBean.showMyTasks}" >
                                <h:outputText value="#{bundle['MY.TASKS']}" />
                </h:commandLink>

                <h:commandLink styleClass="navigatorItem navigatorItemList" id="TasksStartedByMe"  action ="#{TaskInstanceListBean.showTaskInstancesStartedByMe}" >
                                <h:outputText value="#{bundle['STARTED.BY.ME']}" />
                </h:commandLink>

                <h:commandLink styleClass="navigatorItem navigatorItemList" id="TasksAdministeredByMe" action="#{TaskInstanceListBean.showTaskInstancesAdministeredByMe}" >
                                <h:outputText value="#{bundle['ADMINISTERED.BY.ME']}" />
                </h:commandLink>	

                <h:commandLink styleClass="navigatorItem navigatorItemList" id="MyEscalations" action="#{EscalationListBean.showEscalations}" >
                                <h:outputText value="#{bundle['MY.ESCALATIONS']}" />
                </h:commandLink>

        </bpe:navigator>

 


Field Summary
static java.lang.String COPYRIGHT
           
 
Fields inherited from class javax.faces.webapp.UIComponentBodyTag
bodyContent
 
Fields inherited from class javax.faces.webapp.UIComponentTag
pageContext
 
Fields inherited from interface javax.servlet.jsp.tagext.BodyTag
EVAL_BODY_BUFFERED, EVAL_BODY_TAG
 
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
NavigatorTag()
          Default c'tor
 
Method Summary
 java.lang.String getComponentType()
           
 java.lang.String getEmbeddedStyleClass()
          Returns the CSS style class name used for rendering the embedded parts.
 java.lang.String getLabel()
          Returns the label.
 java.lang.String getRendererType()
           
 java.lang.String getStyleClass()
          Returns the CSS style class name used for rendering.
 java.lang.String getTitleStyleClass()
          Returns the CSS style class name used for rendering the title.
 java.lang.String getUserRoles()
          Returns the list of user roles that are entitled to see the navigator.
 void setEmbeddedStyleClass(java.lang.String cssStyle)
          Returns the CSS style class name used for rendering the embedded parts.
 void setLabel(java.lang.String label)
          Sets the label.
protected  void setProperties(javax.faces.component.UIComponent component)
          This method is not for public usage.
 void setStyleClass(java.lang.String cssStyle)
          Sets the CSS style class name used for rendering.
 void setTitleStyleClass(java.lang.String cssStyle)
          Sets the CSS style class name used for rendering the title.
 void setUserRoles(java.lang.String roles)
          Sets the list of user roles that are entitled to see the navigator.
protected  void setValueBinding(javax.faces.component.UIComponent component, java.lang.String attributeName, java.lang.String attributeValue)
          This method is not for public usage.
 
Methods inherited from class javax.faces.webapp.UIComponentBodyTag
doAfterBody, doInitBody, getBodyContent, getDoAfterBodyValue, getDoStartValue, getPreviousOut, release, setBodyContent
 
Methods inherited from class javax.faces.webapp.UIComponentTag
doEndTag, doStartTag, encodeBegin, encodeChildren, encodeEnd, findComponent, getComponentInstance, getCreated, getDoEndValue, getFacesContext, getFacetName, getId, getParent, getParentUIComponentTag, isSuppressed, isValueReference, setBinding, setId, setPageContext, setParent, setRendered, setupResponseWriter
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.servlet.jsp.tagext.Tag
doEndTag, doStartTag, getParent, setPageContext, setParent
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Constructor Detail

NavigatorTag

public NavigatorTag()
Default c'tor

Method Detail

getComponentType

public java.lang.String getComponentType()

getRendererType

public java.lang.String getRendererType()

getLabel

public java.lang.String getLabel()
Returns the label.

Returns:
Literal or a Value Binding Expression

setLabel

public void setLabel(java.lang.String label)
Sets the label.

Parameters:
label - Literal or a Value Binding Expression

setTitleStyleClass

public void setTitleStyleClass(java.lang.String cssStyle)
Sets the CSS style class name used for rendering the title.

Parameters:
cssStyle - The CSS title style class name

getTitleStyleClass

public java.lang.String getTitleStyleClass()
Returns the CSS style class name used for rendering the title.

Returns:
The CSS title style class name

setEmbeddedStyleClass

public void setEmbeddedStyleClass(java.lang.String cssStyle)
Returns the CSS style class name used for rendering the embedded parts.

Parameters:
cssStyle - The CSS style class name

getEmbeddedStyleClass

public java.lang.String getEmbeddedStyleClass()
Returns the CSS style class name used for rendering the embedded parts.

Returns:
cssStyle The CSS style class name

setStyleClass

public void setStyleClass(java.lang.String cssStyle)
Sets the CSS style class name used for rendering.

Parameters:
cssStyle - The CSS style class name

getStyleClass

public java.lang.String getStyleClass()
Returns the CSS style class name used for rendering.

Returns:
The CSS style class name

setUserRoles

public void setUserRoles(java.lang.String roles)
Sets the list of user roles that are entitled to see the navigator. A comma separated list of user roles is expected. If this list is provided the navigator will only be rendered to a user who has one of the roles.

Parameters:
roles - A comma separated list or user roles

getUserRoles

public java.lang.String getUserRoles()
Returns the list of user roles that are entitled to see the navigator.

Returns:
A comma separated list of user roles

setProperties

protected void setProperties(javax.faces.component.UIComponent component)
This method is not for public usage.


setValueBinding

protected void setValueBinding(javax.faces.component.UIComponent component,
                               java.lang.String attributeName,
                               java.lang.String attributeValue)
This method is not for public usage.

Parameters:
component -
attributeName -
attributeValue -