|
||||||||||
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
com.sun.webui.jsf.component.CommonTasksSection
public class CommonTasksSection
The CommonTasksSection component is used to present a number of tasks that might commonly be performed by the user.
Field Summary | |
---|---|
static java.lang.String |
HELP_INLINE_FACET
Inline help text facet |
static java.lang.String |
SECTION_HELP
|
Fields inherited from interface javax.faces.component.NamingContainer |
---|
SEPARATOR_CHAR |
Constructor Summary | |
---|---|
CommonTasksSection()
Creates a new instance of CommonTasksSection |
Method Summary | |
---|---|
int |
getColumns()
Specifies the number of task columns to display in the common tasks section. |
int |
getCommonTaskCount()
Return the total number of CommonTask s that are present in a
CommonTasksSection
This gives the number of visible CommonTask elements and does not take into
account the ones that have rendered or visible attribute set to false. |
java.lang.String |
getFamily()
Return the family for this component. |
javax.faces.component.UIComponent |
getHelp(javax.faces.context.FacesContext context)
Get the help facet for the CommonTasksSection . |
java.lang.String |
getHelpText()
The help text to be displayed for the common tasks section. |
java.lang.String |
getStyle()
CSS style or styles that are applied to the outermost HTML element when the commontaskssection component is rendered. |
java.lang.String |
getStyleClass()
CSS style class or classes that are applied to the outermost HTML element when the commontaskssection component is rendered. |
java.lang.String |
getTitle()
The title text to be displayed for the common tasks section. |
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 |
setColumns(int columns)
Specifies the number of task columns to display in the common tasks section. |
void |
setHelpText(java.lang.String helpText)
The help text to be displayed for the common tasks section. |
void |
setId(java.lang.String id)
The component identifier for this component. |
void |
setRendered(boolean rendered)
Use the rendered attribute to indicate whether the HTML code for the component should be included in the rendered HTML page. |
void |
setStyle(java.lang.String style)
CSS style or styles that are applied to the outermost HTML element when the commontaskssection component is rendered. |
void |
setStyleClass(java.lang.String styleClass)
CSS style class or classes that are applied to the outermost HTML element when the commontaskssection component is rendered. |
void |
setTitle(java.lang.String title)
The title text to be displayed for the common tasks section. |
void |
setVisible(boolean visible)
Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page. |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, restoreAttachedState, saveAttachedState, setParent, setRendererType, setTransient, setValueBinding, setValueExpression |
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 HELP_INLINE_FACET
public static final java.lang.String SECTION_HELP
Constructor Detail |
---|
public CommonTasksSection()
Method Detail |
---|
public java.lang.String getFamily()
Return the family for this component.
getFamily
in class javax.faces.component.UIComponent
public void setId(java.lang.String id)
setId
in class javax.faces.component.UIComponentBase
public void setRendered(boolean rendered)
setRendered
in class javax.faces.component.UIComponentBase
public java.lang.String getHelpText()
The help text to be displayed for the common tasks section.
public void setHelpText(java.lang.String helpText)
The help text to be displayed for the common tasks section.
getHelpText()
public java.lang.String getStyle()
CSS style or styles that are applied to the outermost HTML element when the commontaskssection component is rendered.
public void setStyle(java.lang.String style)
CSS style or styles that are applied to the outermost HTML element when the commontaskssection component is rendered.
getStyle()
public java.lang.String getStyleClass()
CSS style class or classes that are applied to the outermost HTML element when the commontaskssection component is rendered.
public void setStyleClass(java.lang.String styleClass)
CSS style class or classes that are applied to the outermost HTML element when the commontaskssection component is rendered.
getStyleClass()
public java.lang.String getTitle()
The title text to be displayed for the common tasks section.
public void setTitle(java.lang.String title)
The title text to be displayed for the common tasks section.
getTitle()
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)
Use the visible attribute to indicate 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 int getColumns()
Specifies the number of task columns to display in the common tasks section.
public void setColumns(int columns)
Specifies the number of task columns to display in the common tasks section.
getColumns()
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 javax.faces.component.UIComponentBase
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 javax.faces.component.UIComponentBase
public int getCommonTaskCount()
CommonTask
s that are present in a
CommonTasksSection
This gives the number of visible CommonTask
elements and does not take into
account the ones that have rendered or visible attribute set to false.
public javax.faces.component.UIComponent getHelp(javax.faces.context.FacesContext context)
CommonTasksSection
. If a
developer specified facet exists, use it or otherwise
use the default facet.
context
- The faces context.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |