|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.openfaces.util.Components
public class Components
Method Summary | ||
---|---|---|
static java.lang.Object[] |
anyArrayToObjectArray(java.lang.Object array)
|
|
static javax.faces.component.html.HtmlOutputText |
composeHtmlOutputText(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent parent,
java.lang.String idSuffix,
java.lang.String text)
This method create new output text component and add it as facet to parent component |
|
static javax.faces.component.html.HtmlCommandButton |
createButtonFacet(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent parent,
java.lang.String idSuffix,
java.lang.String text)
This method create new command button component and add it as facet to parent component |
|
static javax.faces.component.UIComponent |
createChildComponent(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent parent,
java.lang.String componentType,
java.lang.String idSuffix)
This method add child to parent component |
|
static javax.faces.component.UIComponent |
createChildComponent(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent parent,
java.lang.String componentType,
java.lang.String idSuffix,
int i)
This method add child to parent component at the specified position |
|
static javax.faces.component.UIComponent |
createComponent(javax.faces.context.FacesContext context,
java.lang.String id,
java.lang.String componentType)
This method create components with given name and class and create, if needed, its subcomponents |
|
static javax.faces.component.html.HtmlOutputText |
createOutputText(javax.faces.context.FacesContext context,
java.lang.String text)
Create HtmlOutputText component with given text |
|
static javax.faces.component.html.HtmlOutputText |
createOutputText(javax.faces.context.FacesContext context,
java.lang.String text,
boolean escape)
Create HtmlOutputText component with given text |
|
static
|
findChildrenWithClass(javax.faces.component.UIComponent parent,
java.lang.Class<? extends T> childClass,
boolean onlyRendered,
boolean recursive)
|
|
static
|
findChildrenWithClass(javax.faces.component.UIComponent parent,
java.lang.Class<T> childClass)
|
|
static
|
findChildWithClass(javax.faces.component.UIComponent parent,
java.lang.Class<T> childClass)
|
|
static
|
findChildWithClass(javax.faces.component.UIComponent parent,
java.lang.Class<T> childClass,
java.lang.String childTagName)
|
|
static javax.faces.component.UIForm |
findForm(javax.faces.component.UIComponent component)
|
|
static void |
generateIdIfNotSpecified(javax.faces.component.UIComponent component)
Check component id and generate it, if necessary |
|
static java.lang.String |
generateIdWithSuffix(javax.faces.component.UIComponent baseComponent,
java.lang.String idSuffix)
Generate id on base of component id. |
|
static javax.faces.component.UIComponent |
getChildBySuffix(javax.faces.component.UIComponent component,
java.lang.String idSuffix)
Find child component by its suffix |
|
static
|
getChildWithClass(javax.faces.component.UIComponent parent,
java.lang.Class<T> childClass,
java.lang.String defaultIdSuffix)
|
|
static javax.faces.component.UIForm |
getEnclosingForm(javax.faces.component.UIComponent component)
Return the closest form for component |
|
static javax.faces.component.UIComponent |
getFacet(javax.faces.component.UIComponent component,
java.lang.String facetName)
|
|
static javax.faces.component.UIComponent |
getFacet(javax.faces.component.UIComponent parent,
java.lang.String identifier,
java.lang.Class enforceComponentClass)
This method searches in parent component for facet with given name and throw exception, if not found. |
|
static javax.faces.component.UIComponent |
getFacetOwner(javax.faces.component.UIComponent facetComponent)
|
|
static
|
getOrCreateFacet(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent parent,
java.lang.String componentType,
java.lang.String identifier,
java.lang.Class<E> enforceComponentClass)
This method checks and create, if needed new facet of parent component. |
|
static
|
getOrCreateFacet(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent parent,
java.lang.String componentType,
java.lang.String facetName,
java.lang.String id,
java.lang.Class<E> enforceComponentClass)
|
|
static
|
getParentWithClass(javax.faces.component.UIComponent component,
java.lang.Class<E> parentClass)
|
|
static boolean |
isChildComponent(javax.faces.component.UIComponent child,
javax.faces.component.UIComponent parent)
|
|
static boolean |
isComponentIdSpecified(javax.faces.component.UIComponent component)
|
|
static boolean |
isImplicitPanel(javax.faces.component.UIComponent facet)
|
|
static java.lang.String |
referenceIdToClientId(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent base,
java.lang.String refId)
|
|
static javax.faces.component.UIComponent |
referenceIdToComponent(javax.faces.component.UIComponent component,
java.lang.String refId)
|
|
static void |
runScheduledActions()
|
|
static void |
runWhenReady(SelfScheduledAction action)
|
|
static java.lang.Object |
setRequestMapValue(java.lang.String requestMapKey,
java.lang.Object value)
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static java.lang.Object[] anyArrayToObjectArray(java.lang.Object array)
public static java.lang.String referenceIdToClientId(javax.faces.context.FacesContext context, javax.faces.component.UIComponent base, java.lang.String refId)
public static javax.faces.component.UIComponent referenceIdToComponent(javax.faces.component.UIComponent component, java.lang.String refId)
public static java.lang.Object setRequestMapValue(java.lang.String requestMapKey, java.lang.Object value)
public static <T extends javax.faces.component.UIComponent> T getChildWithClass(javax.faces.component.UIComponent parent, java.lang.Class<T> childClass, java.lang.String defaultIdSuffix)
public static <T extends javax.faces.component.UIComponent> T findChildWithClass(javax.faces.component.UIComponent parent, java.lang.Class<T> childClass)
public static <T extends javax.faces.component.UIComponent> T findChildWithClass(javax.faces.component.UIComponent parent, java.lang.Class<T> childClass, java.lang.String childTagName)
public static <T extends javax.faces.component.UIComponent> java.util.List<T> findChildrenWithClass(javax.faces.component.UIComponent parent, java.lang.Class<T> childClass)
public static <T> java.util.List<T> findChildrenWithClass(javax.faces.component.UIComponent parent, java.lang.Class<? extends T> childClass, boolean onlyRendered, boolean recursive)
public static boolean isComponentIdSpecified(javax.faces.component.UIComponent component)
public static javax.faces.component.html.HtmlOutputText composeHtmlOutputText(javax.faces.context.FacesContext context, javax.faces.component.UIComponent parent, java.lang.String idSuffix, java.lang.String text)
context
- FacesContext
for the current requestparent
- Method will search fo facet in this component or create it, if neededidSuffix
- The suffix identifying the HtmlOutputText
to be returnedtext
- The text in output text field
public static javax.faces.component.UIComponent createChildComponent(javax.faces.context.FacesContext context, javax.faces.component.UIComponent parent, java.lang.String componentType, java.lang.String idSuffix)
context
- FacesContext
for the current requestparent
- Method will create child for this componentcomponentType
- The class for child creationidSuffix
- The suffix identifying the child UIComponent
to be returned
public static javax.faces.component.UIComponent createChildComponent(javax.faces.context.FacesContext context, javax.faces.component.UIComponent parent, java.lang.String componentType, java.lang.String idSuffix, int i)
context
- FacesContext
for the current requestparent
- Method will create child for this componentcomponentType
- The class for child creationidSuffix
- The suffix identifying the child UIComponent
to be returnedi
- index at which the specified child is to be inserted to paranet's child list
public static javax.faces.component.UIComponent createComponent(javax.faces.context.FacesContext context, java.lang.String id, java.lang.String componentType)
context
- FacesContext
for the current requestid
- The id identifying the UIComponent
to be returnedcomponentType
- The component type for which to create and return a new UIComponent
instance
public static javax.faces.component.html.HtmlCommandButton createButtonFacet(javax.faces.context.FacesContext context, javax.faces.component.UIComponent parent, java.lang.String idSuffix, java.lang.String text)
context
- FacesContext
for the current requestparent
- Method will search fo facet in this component or create it, if neededidSuffix
- The suffix identifying the HtmlCommandButton
to be returnedtext
- The text on command button
public static java.lang.String generateIdWithSuffix(javax.faces.component.UIComponent baseComponent, java.lang.String idSuffix)
baseComponent
- The component, which id will be used for generatingidSuffix
- The suffix, which will be added to component id
public static javax.faces.component.html.HtmlOutputText createOutputText(javax.faces.context.FacesContext context, java.lang.String text, boolean escape)
HtmlOutputText
component with given text
context
- FacesContext
for the current requesttext
- The text to be set in output textescape
- Flag indicating that characters that are sensitive in HTML and XML markup must be escaped.
HtmlOutputText
public static javax.faces.component.html.HtmlOutputText createOutputText(javax.faces.context.FacesContext context, java.lang.String text)
HtmlOutputText
component with given text
context
- FacesContext
for the current requesttext
- The text to be set in output text
HtmlOutputText
public static javax.faces.component.UIForm getEnclosingForm(javax.faces.component.UIComponent component)
component
- The component, which form we obtain
public static javax.faces.component.UIForm findForm(javax.faces.component.UIComponent component)
public static void generateIdIfNotSpecified(javax.faces.component.UIComponent component)
component
- The component for id generationpublic static javax.faces.component.UIComponent getChildBySuffix(javax.faces.component.UIComponent component, java.lang.String idSuffix)
component
- The parent component to search inidSuffix
- The suffix identifying the UIComponent
to be returned
UIComponent
, or null
if the component was not found.generateIdWithSuffix(javax.faces.component.UIComponent, java.lang.String)
public static void runWhenReady(SelfScheduledAction action)
public static void runScheduledActions()
public static boolean isChildComponent(javax.faces.component.UIComponent child, javax.faces.component.UIComponent parent)
public static <E extends javax.faces.component.UIComponent> E getOrCreateFacet(javax.faces.context.FacesContext context, javax.faces.component.UIComponent parent, java.lang.String componentType, java.lang.String identifier, java.lang.Class<E> enforceComponentClass)
context
- FacesContext
for the current requestparent
- Method will search fo facet in this component or create it, if neededcomponentType
- The component type for which to create and return a new UIComponent
instanceidentifier
- The id identifying the UIComponent
to be returnedenforceComponentClass
- If facet with given identifier exist, but it's class doesn't
seem to be equal to enforceComponentClass, facet will be recreated
public static <E extends javax.faces.component.UIComponent> E getOrCreateFacet(javax.faces.context.FacesContext context, javax.faces.component.UIComponent parent, java.lang.String componentType, java.lang.String facetName, java.lang.String id, java.lang.Class<E> enforceComponentClass)
public static javax.faces.component.UIComponent getFacet(javax.faces.component.UIComponent parent, java.lang.String identifier, java.lang.Class enforceComponentClass)
parent
- The component, in which facet will be searchedidentifier
- The id identifying the UIComponent
to be returnedenforceComponentClass
- If facet with given identifier exist, but it's class doesn't
seem to be equal to enforceComponentClass, exception will be thrown
public static <E extends javax.faces.component.UIComponent> E getParentWithClass(javax.faces.component.UIComponent component, java.lang.Class<E> parentClass)
public static javax.faces.component.UIComponent getFacet(javax.faces.component.UIComponent component, java.lang.String facetName)
public static boolean isImplicitPanel(javax.faces.component.UIComponent facet)
public static javax.faces.component.UIComponent getFacetOwner(javax.faces.component.UIComponent facetComponent)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |