Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

oracle.adf.view.faces.component.core.layout
Class CorePanelForm

java.lang.Object
  extended byjavax.faces.component.UIComponent
      extended byoracle.adf.view.faces.component.UIXComponent
          extended byoracle.adf.view.faces.component.UIXComponentBase
              extended byoracle.adf.view.faces.component.UIXPanel
                  extended byoracle.adf.view.faces.component.core.layout.CorePanelForm
All Implemented Interfaces:
StateHolder
public class CorePanelForm
extends UIXPanel

The panelForm lays out input form controls, such that their labels and fields line up vertically. It supports multiple columns, and also supports a footer facet.

Usually, this component will simply contain labelled ADF Faces input components in its main content - these are inputText, inputFile, selectInputColor, selectInputText, selectInputDate, selectBooleanCheckBox, selectBooleanRadio, selectOneChoice, selectOneListBox, selectOneRadio, and selectManyListBox. These components must have their "simple" attribute set to false, which is the default, and will cause the labels and fields inside the panelForm to be aligned vertically.

When more complex field contents are needed, use a panelLabelAndMessage around the more complex contents needed; see the example below.

Other components can be added to panelForm, but they will not line up with labels and fields automatically, and each will appear on its own row. You can use other panel components - like panelHorizontal - to get some level of layout within a row, but to align contents with the other labels and fields, use panelLabelAndMessage or the "footer" facet.

This component can be used to lay out multiple columns using the rows attribute. The children are laid out down and then across.

panelForm Attributes and Children

The panelForm component supports the following attributes:

The panelForm component supports the following facets:

Example:

 <af:panelForm rows="6" labelWidth="40%">
     <!-- A bunch of form components -->
     <af:inputText label="Text"/>
     <af:inputFile label="File"/>
     <af:selectInputText label="SelectInput"/>
     <af:selectInputDate label="Date"/>
     <af:inputText label="Attribute"/>
     <af:inputText label="Attribute"/>
     <af:inputText label="Attribute"/>
     <af:inputText label="Attribute"/>
 
     <!-- Now, an example of panelLabelAndMessage for more complex content -->
     <af:panelLabelAndMessage label="Date Range">
       <af:panelHorizontal>
         <af:selectInputDate simple="true" shortDesc="Start date"/>
         <af:selectInputDate simple="true" shortDesc="End date"/>
       </af:panelHorizontal>
     </af:panelLabelAndMessage>
     <f:facet name="footer">
       <af:panelButtonBar>
         <af:commandButton text="Button 1"/>
         <af:commandButton text="Button 2"/>
       </af:panelButtonBar>
     </f:facet>      
 </af:panelForm>

Field Summary
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
static PropertyKey FIELD_WIDTH_KEY
           
static java.lang.String FOOTER_FACET
           
static PropertyKey INLINE_STYLE_KEY
           
static PropertyKey LABEL_WIDTH_KEY
           
static PropertyKey MAX_COLUMNS_KEY
           
static PropertyKey ONCLICK_KEY
           
static PropertyKey ONDBLCLICK_KEY
           
static PropertyKey ONKEYDOWN_KEY
           
static PropertyKey ONKEYPRESS_KEY
           
static PropertyKey ONKEYUP_KEY
           
static PropertyKey ONMOUSEDOWN_KEY
           
static PropertyKey ONMOUSEMOVE_KEY
           
static PropertyKey ONMOUSEOUT_KEY
           
static PropertyKey ONMOUSEOVER_KEY
           
static PropertyKey ONMOUSEUP_KEY
           
static PropertyKey PARTIAL_TRIGGERS_KEY
           
static PropertyKey ROWS_KEY
           
static PropertyKey SHORT_DESC_KEY
           
static PropertyKey STYLE_CLASS_KEY
           
static FacesBean.Type TYPE
           
static PropertyKey WIDTH_KEY
           
 
Fields inherited from class oracle.adf.view.faces.component.UIXComponentBase
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY
 
Constructor Summary
  CorePanelForm()
          Construct an instance of the CorePanelForm.
protected CorePanelForm(java.lang.String rendererType)
          Construct an instance of the CorePanelForm.
 
Method Summary
protected  FacesBean.Type getBeanType()
           
 java.lang.String getFamily()
           
 java.lang.String getFieldWidth()
          Gets the preferred width of the field.
 UIComponent getFooter()
          this facet is rendered under the fields and usually contains a panelButtonBar.
 java.lang.String getInlineStyle()
          Gets the inline CSS style for this element
 java.lang.String getLabelWidth()
          Gets the preferred width of the label.
 int getMaxColumns()
          Gets the maximum number of columns to show.
 java.lang.String getOnclick()
          Gets an onclick Javascript handler.
 java.lang.String getOndblclick()
          Gets an ondblclick Javascript handler.
 java.lang.String getOnkeydown()
          Gets an onkeydown Javascript handler.
 java.lang.String getOnkeypress()
          Gets an onkeypress Javascript handler.
 java.lang.String getOnkeyup()
          Gets an onkeyup Javascript handler.
 java.lang.String getOnmousedown()
          Gets an onmousedown Javascript handler.
 java.lang.String getOnmousemove()
          Gets an onmousemove Javascript handler.
 java.lang.String getOnmouseout()
          Gets an onmouseout Javascript handler.
 java.lang.String getOnmouseover()
          Gets an onmouseover Javascript handler.
 java.lang.String getOnmouseup()
          Gets an onmouseup Javascript handler.
 java.lang.String[] getPartialTriggers()
          Gets the IDs of the components that should trigger a partial update.
 int getRows()
          Gets the number of rows after which to start a new column.
 java.lang.String getShortDesc()
          Gets the short description of the bean.
 java.lang.String getStyleClass()
          Gets the CSS style class of the bean.
 java.lang.String getWidth()
          Gets the preferred total width of the layout.
 void setFieldWidth(java.lang.String fieldWidth)
          Sets the preferred width of the field.
 void setFooter(UIComponent footerFacet)
          this facet is rendered under the fields and usually contains a panelButtonBar.
 void setInlineStyle(java.lang.String inlineStyle)
          Sets the inline CSS style for this element
 void setLabelWidth(java.lang.String labelWidth)
          Sets the preferred width of the label.
 void setMaxColumns(int maxColumns)
          Sets the maximum number of columns to show.
 void setOnclick(java.lang.String onclick)
          Sets an onclick Javascript handler.
 void setOndblclick(java.lang.String ondblclick)
          Sets an ondblclick Javascript handler.
 void setOnkeydown(java.lang.String onkeydown)
          Sets an onkeydown Javascript handler.
 void setOnkeypress(java.lang.String onkeypress)
          Sets an onkeypress Javascript handler.
 void setOnkeyup(java.lang.String onkeyup)
          Sets an onkeyup Javascript handler.
 void setOnmousedown(java.lang.String onmousedown)
          Sets an onmousedown Javascript handler.
 void setOnmousemove(java.lang.String onmousemove)
          Sets an onmousemove Javascript handler.
 void setOnmouseout(java.lang.String onmouseout)
          Sets an onmouseout Javascript handler.
 void setOnmouseover(java.lang.String onmouseover)
          Sets an onmouseover Javascript handler.
 void setOnmouseup(java.lang.String onmouseup)
          Sets an onmouseup Javascript handler.
 void setPartialTriggers(java.lang.String[] partialTriggers)
          Sets the IDs of the components that should trigger a partial update.
 void setRows(int rows)
          Sets the number of rows after which to start a new column.
 void setShortDesc(java.lang.String shortDesc)
          Sets the short description of the bean.
 void setStyleClass(java.lang.String styleClass)
          Sets the CSS style class of the bean.
 void setWidth(java.lang.String width)
          Sets the preferred total width of the layout.
 
Methods inherited from class oracle.adf.view.faces.component.UIXComponentBase
addAttributeChange, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcast, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getLocalClientId, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeFacesListener, restoreState, saveState, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TYPE

public static final FacesBean.Type TYPE

ROWS_KEY

public static final PropertyKey ROWS_KEY

MAX_COLUMNS_KEY

public static final PropertyKey MAX_COLUMNS_KEY

WIDTH_KEY

public static final PropertyKey WIDTH_KEY

LABEL_WIDTH_KEY

public static final PropertyKey LABEL_WIDTH_KEY

FIELD_WIDTH_KEY

public static final PropertyKey FIELD_WIDTH_KEY

SHORT_DESC_KEY

public static final PropertyKey SHORT_DESC_KEY

PARTIAL_TRIGGERS_KEY

public static final PropertyKey PARTIAL_TRIGGERS_KEY

ONCLICK_KEY

public static final PropertyKey ONCLICK_KEY

ONDBLCLICK_KEY

public static final PropertyKey ONDBLCLICK_KEY

ONMOUSEDOWN_KEY

public static final PropertyKey ONMOUSEDOWN_KEY

ONMOUSEUP_KEY

public static final PropertyKey ONMOUSEUP_KEY

ONMOUSEOVER_KEY

public static final PropertyKey ONMOUSEOVER_KEY

ONMOUSEMOVE_KEY

public static final PropertyKey ONMOUSEMOVE_KEY

ONMOUSEOUT_KEY

public static final PropertyKey ONMOUSEOUT_KEY

ONKEYPRESS_KEY

public static final PropertyKey ONKEYPRESS_KEY

ONKEYDOWN_KEY

public static final PropertyKey ONKEYDOWN_KEY

ONKEYUP_KEY

public static final PropertyKey ONKEYUP_KEY

STYLE_CLASS_KEY

public static final PropertyKey STYLE_CLASS_KEY

INLINE_STYLE_KEY

public static final PropertyKey INLINE_STYLE_KEY

FOOTER_FACET

public static final java.lang.String FOOTER_FACET
See Also:
Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

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

CorePanelForm

public CorePanelForm()
Construct an instance of the CorePanelForm.

CorePanelForm

protected CorePanelForm(java.lang.String rendererType)
Construct an instance of the CorePanelForm.

Method Detail

getFooter

public final UIComponent getFooter()
this facet is rendered under the fields and usually contains a panelButtonBar.

This facet may not always line up perfectly, especially if the labels or fields are longer than expected. Try adjusting things with the labelWidth and fieldWidth attributes when necessary. Also, the columns attribute on inputText may be helpful.

setFooter

public final void setFooter(UIComponent footerFacet)
this facet is rendered under the fields and usually contains a panelButtonBar.

This facet may not always line up perfectly, especially if the labels or fields are longer than expected. Try adjusting things with the labelWidth and fieldWidth attributes when necessary. Also, the columns attribute on inputText may be helpful.

getRows

public final int getRows()
Gets the number of rows after which to start a new column. This attribute defaults to Integer.MAX_VALUE. The number of rows actually rendered depends also on the columns attribute. If the children will not fit in the given number of rows and columns, the number of rows will increase to accomodate the children. This attribute is not supported on the following agent types: phone, voice.

setRows

public final void setRows(int rows)
Sets the number of rows after which to start a new column. This attribute defaults to Integer.MAX_VALUE. The number of rows actually rendered depends also on the columns attribute. If the children will not fit in the given number of rows and columns, the number of rows will increase to accomodate the children. This attribute is not supported on the following agent types: phone, voice.

getMaxColumns

public final int getMaxColumns()
Gets the maximum number of columns to show. This attribute defaults to 3 and 2 on PDAs. This attribute is not supported on the following agent types: phone, voice.

setMaxColumns

public final void setMaxColumns(int maxColumns)
Sets the maximum number of columns to show. This attribute defaults to 3 and 2 on PDAs. This attribute is not supported on the following agent types: phone, voice.

getWidth

public final java.lang.String getWidth()
Gets the preferred total width of the layout. May be specified as either a percentage or an absolute number of pixels

setWidth

public final void setWidth(java.lang.String width)
Sets the preferred total width of the layout. May be specified as either a percentage or an absolute number of pixels

getLabelWidth

public final java.lang.String getLabelWidth()
Gets the preferred width of the label. Usually a percentage, but may be specified as either a percentage or an absolute number of pixels. If the width is not specified, it will default appropriately. If specified as a percentage the labelWidth plus the fieldWidth should add up to 100%, regardless of the number of columns. If the labelWidth is specified and is a percentage the fieldWidth will be derived appropriately if not specified. This attribute is not supported on the following agent types: phone, voice.

setLabelWidth

public final void setLabelWidth(java.lang.String labelWidth)
Sets the preferred width of the label. Usually a percentage, but may be specified as either a percentage or an absolute number of pixels. If the width is not specified, it will default appropriately. If specified as a percentage the labelWidth plus the fieldWidth should add up to 100%, regardless of the number of columns. If the labelWidth is specified and is a percentage the fieldWidth will be derived appropriately if not specified. This attribute is not supported on the following agent types: phone, voice.

getFieldWidth

public final java.lang.String getFieldWidth()
Gets the preferred width of the field. Usually a percentage, but may be specified as either a percentage or an absolute number of pixels. If the width is not specified, it will default appropriately. If specified as a percentage the labelWidth plus the fieldWidth should add up to 100%, regardless of the number of columns. If the fieldWidth is specified and is a percentage the labelWidth will be derived appropriately if not specified. This attribute is not supported on the following agent types: phone, voice.

setFieldWidth

public final void setFieldWidth(java.lang.String fieldWidth)
Sets the preferred width of the field. Usually a percentage, but may be specified as either a percentage or an absolute number of pixels. If the width is not specified, it will default appropriately. If specified as a percentage the labelWidth plus the fieldWidth should add up to 100%, regardless of the number of columns. If the fieldWidth is specified and is a percentage the labelWidth will be derived appropriately if not specified. This attribute is not supported on the following agent types: phone, voice.

getShortDesc

public final java.lang.String getShortDesc()
Gets the short description of the bean. This text is commonly used by user agents to display tooltip help text.

setShortDesc

public final void setShortDesc(java.lang.String shortDesc)
Sets the short description of the bean. This text is commonly used by user agents to display tooltip help text.

getPartialTriggers

public final java.lang.String[] getPartialTriggers()
Gets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.

setPartialTriggers

public final void setPartialTriggers(java.lang.String[] partialTriggers)
Sets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.

getOnclick

public final java.lang.String getOnclick()
Gets an onclick Javascript handler.

setOnclick

public final void setOnclick(java.lang.String onclick)
Sets an onclick Javascript handler.

getOndblclick

public final java.lang.String getOndblclick()
Gets an ondblclick Javascript handler.

setOndblclick

public final void setOndblclick(java.lang.String ondblclick)
Sets an ondblclick Javascript handler.

getOnmousedown

public final java.lang.String getOnmousedown()
Gets an onmousedown Javascript handler.

setOnmousedown

public final void setOnmousedown(java.lang.String onmousedown)
Sets an onmousedown Javascript handler.

getOnmouseup

public final java.lang.String getOnmouseup()
Gets an onmouseup Javascript handler.

setOnmouseup

public final void setOnmouseup(java.lang.String onmouseup)
Sets an onmouseup Javascript handler.

getOnmouseover

public final java.lang.String getOnmouseover()
Gets an onmouseover Javascript handler.

setOnmouseover

public final void setOnmouseover(java.lang.String onmouseover)
Sets an onmouseover Javascript handler.

getOnmousemove

public final java.lang.String getOnmousemove()
Gets an onmousemove Javascript handler.

setOnmousemove

public final void setOnmousemove(java.lang.String onmousemove)
Sets an onmousemove Javascript handler.

getOnmouseout

public final java.lang.String getOnmouseout()
Gets an onmouseout Javascript handler.

setOnmouseout

public final void setOnmouseout(java.lang.String onmouseout)
Sets an onmouseout Javascript handler.

getOnkeypress

public final java.lang.String getOnkeypress()
Gets an onkeypress Javascript handler.

setOnkeypress

public final void setOnkeypress(java.lang.String onkeypress)
Sets an onkeypress Javascript handler.

getOnkeydown

public final java.lang.String getOnkeydown()
Gets an onkeydown Javascript handler.

setOnkeydown

public final void setOnkeydown(java.lang.String onkeydown)
Sets an onkeydown Javascript handler.

getOnkeyup

public final java.lang.String getOnkeyup()
Gets an onkeyup Javascript handler.

setOnkeyup

public final void setOnkeyup(java.lang.String onkeyup)
Sets an onkeyup Javascript handler.

getStyleClass

public final java.lang.String getStyleClass()
Gets the CSS style class of the bean.

setStyleClass

public final void setStyleClass(java.lang.String styleClass)
Sets the CSS style class of the bean.

getInlineStyle

public final java.lang.String getInlineStyle()
Gets the inline CSS style for this element

setInlineStyle

public final void setInlineStyle(java.lang.String inlineStyle)
Sets the inline CSS style for this element

getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class UIXPanel

getBeanType

protected FacesBean.Type getBeanType()
Overrides:
getBeanType in class UIXPanel
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2003-2007 Oracle Corporation. All Rights Reserved.