|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UICommand
com.sun.webui.jsf.component.WebuiCommand
com.sun.webui.jsf.component.CommonTask
public class CommonTask
The CommonTask component is used to greate a single task within a CommonTasksSection or CommonTasksGroup component.
Field Summary | |
---|---|
static java.lang.String |
COMMONTASK_FACET
Common Task facet identifier |
static java.lang.String |
INFOLINK_FACET
Info link facet identifier |
static java.lang.String |
INFOPANEL_FACET
Info panel facet identifier |
Fields inherited from class javax.faces.component.UICommand |
---|
COMPONENT_FAMILY, COMPONENT_TYPE |
Fields inherited from interface javax.faces.component.NamingContainer |
---|
SEPARATOR_CHAR |
Constructor Summary | |
---|---|
CommonTask()
Creates a new instance of Task |
Method Summary | |
---|---|
java.lang.String |
getFamily()
Return the family for this component. |
java.lang.String |
getIcon()
Specifies a theme key for an image to be displayed in front of the text for the task. |
int |
getImageHeight()
Specifies the height in pixels of the image that is specified with the imageUrl attribute |
java.lang.String |
getImageUrl()
The path to an image to be displayed in front of the text for the task. |
int |
getImageWidth()
Specifies the width in pixels of the image that is specified with the imageUrl attribute. |
javax.faces.component.UIComponent |
getInfoLink()
Checks whether a facet has been specified for the Hyperlink inside the info panel. |
java.lang.String |
getInfoLinkText()
Specifies the text for the link that is displayed at the bottom of the task's information panel. |
java.lang.String |
getInfoLinkUrl()
Specifies the URL for the link that is displayed at the bottom of the task's information panel. |
javax.faces.component.UIComponent |
getInfoPanel()
Checks whether a facet has been specified for the infoPanel. |
java.lang.String |
getInfoText()
Specifies the text to be displayed in the information panel for this task. |
java.lang.String |
getInfoTitle()
Specifies the title text to be displayed in the information panel for this task. |
java.lang.String |
getOnBlur()
Scripting code that is executed when this element loses the focus. |
java.lang.String |
getOnClick()
Scripting code that is executed when a mouse click occurs over this component. |
java.lang.String |
getOnDblClick()
Scripting code that is executed when a mouse double click occurs over this component. |
java.lang.String |
getOnFocus()
Scripting code that is executed when this component receives the focus. |
java.lang.String |
getOnKeyDown()
Scripting code that is executed when the user presses down on a key while the component has focus. |
java.lang.String |
getOnKeyPress()
Scripting code that is executed when the user presses and releases a key while the component has the focus. |
java.lang.String |
getOnKeyUp()
Scripting code that is executed when the user releases a key while the component has focus. |
java.lang.String |
getOnMouseDown()
Scripting code that is executed when the user presses a mouse button while the mouse pointer is on the component. |
java.lang.String |
getOnMouseMove()
Scripting code that is executed when the user moves the mouse pointer while it is over the component. |
java.lang.String |
getOnMouseOut()
Scripting code that is executed when the user moves the mouse pointer off this component. |
java.lang.String |
getOnMouseOver()
Scripting code that is executed when the user moves the mouse pointer into the boundary of this component. |
java.lang.String |
getOnMouseUp()
Scripting code that is executed when the user releases a mouse button while the mouse pointer is on the component. |
java.lang.String |
getStyle()
CSS style(s) that are applied to the outermost HTML element when this component is rendered. |
java.lang.String |
getStyleClass()
CSS style class(es) that are to be applied to the outermost HTML element when this component is rendered. |
int |
getTabIndex()
Position of this element in the tabbing order of the current document. |
java.lang.String |
getTarget()
The resource at the specified URL is displayed in the frame that is specified with the target attribute. |
javax.faces.component.UIComponent |
getTaskAction()
Returns a component that represents the action element for the CommonTask .When the user clicks on this action element, it takes him to the corresponding task. In the default case, when no facet is specified, an hyperlink is created, with the default styles applied to it and is returned back to the invoking function. |
java.lang.Object |
getText()
The text to be displayed for the task. |
java.lang.String |
getTitle()
The title. |
java.lang.String |
getToolTip()
Sets the value of the title attribute for the HTML element. |
java.lang.Object |
getValue()
|
javax.el.ValueExpression |
getValueExpression(java.lang.String name)
Return the ValueExpression stored for the
specified name (if any), respecting any property aliases. |
boolean |
isDisabled()
Indicates that activation of this component by the user is not currently permitted. |
boolean |
isImmediate()
Flag indicating that event handling for this component should be handled immediately (in Apply Request Values phase) rather than waiting until Invoke Application phase. |
boolean |
isVisible()
Indicates whether the component should be viewable by the user in the rendered HTML page. |
void |
restoreState(javax.faces.context.FacesContext _context,
java.lang.Object _state)
Restore the state of this component. |
java.lang.Object |
saveState(javax.faces.context.FacesContext _context)
Save the state of this component. |
void |
setDisabled(boolean disabled)
Indicates that activation of this component by the user is not currently permitted. |
void |
setIcon(java.lang.String icon)
Specifies a theme key for an image to be displayed in front of the text for the task. |
void |
setImageHeight(int imageHeight)
Specifies the height in pixels of the image that is specified with the imageUrl attribute |
void |
setImageUrl(java.lang.String imageUrl)
The path to an image to be displayed in front of the text for the task. |
void |
setImageWidth(int imageWidth)
Specifies the width in pixels of the image that is specified with the imageUrl attribute. |
void |
setImmediate(boolean immediate)
Flag indicating that event handling for this component should be handled immediately (in Apply Request Values phase) rather than waiting until Invoke Application phase. |
void |
setInfoLinkText(java.lang.String infoLinkText)
Specifies the text for the link that is displayed at the bottom of the task's information panel. |
void |
setInfoLinkUrl(java.lang.String infoLinkUrl)
Specifies the URL for the link that is displayed at the bottom of the task's information panel. |
void |
setInfoText(java.lang.String infoText)
Specifies the text to be displayed in the information panel for this task. |
void |
setInfoTitle(java.lang.String infoTitle)
Specifies the title text to be displayed in the information panel for this task. |
void |
setOnBlur(java.lang.String onBlur)
Scripting code that is executed when this element loses the focus. |
void |
setOnClick(java.lang.String onClick)
Scripting code that is executed when a mouse click occurs over this component. |
void |
setOnDblClick(java.lang.String onDblClick)
Scripting code that is executed when a mouse double click occurs over this component. |
void |
setOnFocus(java.lang.String onFocus)
Scripting code that is executed when this component receives the focus. |
void |
setOnKeyDown(java.lang.String onKeyDown)
Scripting code that is executed when the user presses down on a key while the component has focus. |
void |
setOnKeyPress(java.lang.String onKeyPress)
Scripting code that is executed when the user presses and releases a key while the component has the focus. |
void |
setOnKeyUp(java.lang.String onKeyUp)
Scripting code that is executed when the user releases a key while the component has focus. |
void |
setOnMouseDown(java.lang.String onMouseDown)
Scripting code that is executed when the user presses a mouse button while the mouse pointer is on the component. |
void |
setOnMouseMove(java.lang.String onMouseMove)
Scripting code that is executed when the user moves the mouse pointer while it is over the component. |
void |
setOnMouseOut(java.lang.String onMouseOut)
Scripting code that is executed when the user moves the mouse pointer off this component. |
void |
setOnMouseOver(java.lang.String onMouseOver)
Scripting code that is executed when the user moves the mouse pointer into the boundary of this component. |
void |
setOnMouseUp(java.lang.String onMouseUp)
Scripting code that is executed when the user releases a mouse button while the mouse pointer is on the component. |
void |
setStyle(java.lang.String style)
CSS style(s) that are applied to the outermost HTML element when this component is rendered. |
void |
setStyleClass(java.lang.String styleClass)
CSS style class(es) that are to be applied to the outermost HTML element when this component is rendered. |
void |
setTabIndex(int tabIndex)
Position of this element in the tabbing order of the current document. |
void |
setTarget(java.lang.String target)
The resource at the specified URL is displayed in the frame that is specified with the target attribute. |
void |
setText(java.lang.Object text)
The text to be displayed for the task. |
void |
setTitle(java.lang.String title)
The title. |
void |
setToolTip(java.lang.String toolTip)
Sets the value of the title attribute for the HTML element. |
void |
setValueExpression(java.lang.String name,
javax.el.ValueExpression binding)
Set the ValueExpression stored for the
specified name (if any), respecting any property
aliases. |
void |
setVisible(boolean visible)
Indicates whether the component should be viewable by the user in the rendered HTML page. |
Methods inherited from class com.sun.webui.jsf.component.WebuiCommand |
---|
broadcast, getAction, getActionExpression, getActionListener, getActionListenerExpression, processDecodes, processUpdates, processValidators, setActionListenerExpression, setId, setRendered |
Methods inherited from class javax.faces.component.UICommand |
---|
addActionListener, getActionListeners, queueEvent, removeActionListener, setAction, setActionExpression, setActionListener, setValue |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, restoreAttachedState, saveAttachedState, setParent, setRendererType, setTransient, setValueBinding |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getContainerClientId |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String COMMONTASK_FACET
public static final java.lang.String INFOPANEL_FACET
public static final java.lang.String INFOLINK_FACET
Constructor Detail |
---|
public CommonTask()
Method Detail |
---|
public java.lang.String getFamily()
Return the family for this component.
getFamily
in class javax.faces.component.UICommand
public java.lang.Object getValue()
getValue
in class javax.faces.component.UICommand
public javax.el.ValueExpression getValueExpression(java.lang.String name)
Return the ValueExpression
stored for the
specified name (if any), respecting any property aliases.
getValueExpression
in class javax.faces.component.UIComponentBase
name
- Name of value binding expression to retrievepublic void setValueExpression(java.lang.String name, javax.el.ValueExpression binding)
Set the ValueExpression
stored for the
specified name (if any), respecting any property
aliases.
setValueExpression
in class javax.faces.component.UIComponentBase
name
- Name of value binding to setbinding
- ValueExpression to set, or null to removepublic boolean isDisabled()
public void setDisabled(boolean disabled)
public java.lang.String getIcon()
Specifies a theme key for an image to be displayed in front of the text for
the task. The key CTS_OVERVIEW
will generate
an image that can be used to mark tasks that are for overview information about the task
public void setIcon(java.lang.String icon)
Specifies a theme key for an image to be displayed in front of the text for
the task. The key CTS_OVERVIEW
will generate
an image that can be used to mark tasks that are for overview information about the task
getIcon()
public int getImageHeight()
Specifies the height in pixels of the image that is specified with the imageUrl attribute
public void setImageHeight(int imageHeight)
Specifies the height in pixels of the image that is specified with the imageUrl attribute
getImageHeight()
public java.lang.String getImageUrl()
The path to an image to be displayed in front of the text for the task. If both icon and imageUrl are provided, the icon takes precedence over the path specified for the image.
public void setImageUrl(java.lang.String imageUrl)
The path to an image to be displayed in front of the text for the task. If both icon and imageUrl are provided, the icon takes precedence over the path specified for the image.
getImageUrl()
public int getImageWidth()
Specifies the width in pixels of the image that is specified with the imageUrl attribute.
public void setImageWidth(int imageWidth)
Specifies the width in pixels of the image that is specified with the imageUrl attribute.
getImageWidth()
public boolean isImmediate()
isImmediate
in interface javax.faces.component.ActionSource
isImmediate
in class javax.faces.component.UICommand
public void setImmediate(boolean immediate)
setImmediate
in interface javax.faces.component.ActionSource
setImmediate
in class WebuiCommand
public java.lang.String getInfoLinkText()
Specifies the text for the link that is displayed at the bottom of the task's information panel.
public void setInfoLinkText(java.lang.String infoLinkText)
Specifies the text for the link that is displayed at the bottom of the task's information panel.
getInfoLinkText()
public java.lang.String getInfoLinkUrl()
Specifies the URL for the link that is displayed at the bottom of the task's information panel.
public void setInfoLinkUrl(java.lang.String infoLinkUrl)
Specifies the URL for the link that is displayed at the bottom of the task's information panel.
getInfoLinkUrl()
public java.lang.String getInfoText()
Specifies the text to be displayed in the information panel for this task.
public void setInfoText(java.lang.String infoText)
Specifies the text to be displayed in the information panel for this task.
getInfoText()
public java.lang.String getInfoTitle()
Specifies the title text to be displayed in the information panel for this task.
public void setInfoTitle(java.lang.String infoTitle)
Specifies the title text to be displayed in the information panel for this task.
getInfoTitle()
public java.lang.String getOnBlur()
Scripting code that is executed when this element loses the focus.
public void setOnBlur(java.lang.String onBlur)
Scripting code that is executed when this element loses the focus.
getOnBlur()
public java.lang.String getOnClick()
Scripting code that is executed when a mouse click occurs over this component.
public void setOnClick(java.lang.String onClick)
Scripting code that is executed when a mouse click occurs over this component.
getOnClick()
public java.lang.String getOnDblClick()
Scripting code that is executed when a mouse double click occurs over this component.
public void setOnDblClick(java.lang.String onDblClick)
Scripting code that is executed when a mouse double click occurs over this component.
getOnDblClick()
public java.lang.String getOnFocus()
Scripting code that is executed when this component receives the focus. An element receivesthe focus when the user selects the element by pressing the tab key or clicking the mouse.
public void setOnFocus(java.lang.String onFocus)
Scripting code that is executed when this component receives the focus. An element receivesthe focus when the user selects the element by pressing the tab key or clicking the mouse.
getOnFocus()
public java.lang.String getOnKeyDown()
Scripting code that is executed when the user presses down on a key while the component has focus.
public void setOnKeyDown(java.lang.String onKeyDown)
Scripting code that is executed when the user presses down on a key while the component has focus.
getOnKeyDown()
public java.lang.String getOnKeyPress()
Scripting code that is executed when the user presses and releases a key while the component has the focus.
public void setOnKeyPress(java.lang.String onKeyPress)
Scripting code that is executed when the user presses and releases a key while the component has the focus.
getOnKeyPress()
public java.lang.String getOnKeyUp()
Scripting code that is executed when the user releases a key while the component has focus.
public void setOnKeyUp(java.lang.String onKeyUp)
Scripting code that is executed when the user releases a key while the component has focus.
getOnKeyUp()
public java.lang.String getOnMouseDown()
Scripting code that is executed when the user presses a mouse button while the mouse pointer is on the component.
public void setOnMouseDown(java.lang.String onMouseDown)
Scripting code that is executed when the user presses a mouse button while the mouse pointer is on the component.
getOnMouseDown()
public java.lang.String getOnMouseMove()
Scripting code that is executed when the user moves the mouse pointer while it is over the component.
public void setOnMouseMove(java.lang.String onMouseMove)
Scripting code that is executed when the user moves the mouse pointer while it is over the component.
getOnMouseMove()
public java.lang.String getOnMouseOut()
Scripting code that is executed when the user moves the mouse pointer off this component.
public void setOnMouseOut(java.lang.String onMouseOut)
Scripting code that is executed when the user moves the mouse pointer off this component.
getOnMouseOut()
public java.lang.String getOnMouseOver()
Scripting code that is executed when the user moves the mouse pointer into the boundary of this component.
public void setOnMouseOver(java.lang.String onMouseOver)
Scripting code that is executed when the user moves the mouse pointer into the boundary of this component.
getOnMouseOver()
public java.lang.String getOnMouseUp()
Scripting code that is executed when the user releases a mouse button while the mouse pointer is on the component.
public void setOnMouseUp(java.lang.String onMouseUp)
Scripting code that is executed when the user releases a mouse button while the mouse pointer is on the component.
getOnMouseUp()
public java.lang.String getStyle()
CSS style(s) that are applied to the outermost HTML element when this component is rendered.
public void setStyle(java.lang.String style)
CSS style(s) that are applied to the outermost HTML element when this component is rendered.
getStyle()
public java.lang.String getStyleClass()
CSS style class(es) that are to be applied to the outermost HTML element when this component is rendered.
public void setStyleClass(java.lang.String styleClass)
CSS style class(es) that are to be applied to the outermost HTML element when this component is rendered.
getStyleClass()
public int getTabIndex()
Position of this element in the tabbing order of the current document. Tabbing order determines the sequence in which elements receive focus when the tab key is pressed. The value must be an integer between 0 and 32767.
public void setTabIndex(int tabIndex)
Position of this element in the tabbing order of the current document. Tabbing order determines the sequence in which elements receive focus when the tab key is pressed. The value must be an integer between 0 and 32767.
getTabIndex()
public java.lang.String getTarget()
The resource at the specified URL is displayed in the frame that is specified with the target attribute. Values such as "_blank" that are valid for the target attribute of a HTML anchor element are also valid for this attribute in this component
public void setTarget(java.lang.String target)
The resource at the specified URL is displayed in the frame that is specified with the target attribute. Values such as "_blank" that are valid for the target attribute of a HTML anchor element are also valid for this attribute in this component
getTarget()
public java.lang.Object getText()
The text to be displayed for the task.
public void setText(java.lang.Object text)
The text to be displayed for the task.
getText()
public java.lang.String getTitle()
public void setTitle(java.lang.String title)
public java.lang.String getToolTip()
Sets the value of the title attribute for the HTML element. The specified text will display as a tooltip if the mouse cursor hovers over the HTML element.
public void setToolTip(java.lang.String toolTip)
Sets the value of the title attribute for the HTML element. The specified text will display as a tooltip if the mouse cursor hovers over the HTML element.
getToolTip()
public boolean isVisible()
Indicates whether the component should be viewable by the user in the rendered HTML page. If set to false, the HTML code for the component is present in the page, but the component is hidden with style attributes. By default, visible is set to true, so HTML for the component HTML is included and visible to the user. If the component is not visible, it can still be processed on subsequent form submissions because the HTML is present.
public void setVisible(boolean visible)
Indicates whether the component should be viewable by the user in the rendered HTML page. If set to false, the HTML code for the component is present in the page, but the component is hidden with style attributes. By default, visible is set to true, so HTML for the component HTML is included and visible to the user. If the component is not visible, it can still be processed on subsequent form submissions because the HTML is present.
isVisible()
public void restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
Restore the state of this component.
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class WebuiCommand
public java.lang.Object saveState(javax.faces.context.FacesContext _context)
Save the state of this component.
saveState
in interface javax.faces.component.StateHolder
saveState
in class WebuiCommand
public javax.faces.component.UIComponent getTaskAction()
CommonTask
.
public javax.faces.component.UIComponent getInfoLink()
Hyperlink
public javax.faces.component.UIComponent getInfoPanel()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |