oracle.adf.view.faces.component.html
Class HtmlFrameBorderLayout

java.lang.Object
  |
  +--javax.faces.component.UIComponent
        |
        +--oracle.adf.view.faces.component.UIXComponent
              |
              +--oracle.adf.view.faces.component.UIXComponentBase
                    |
                    +--oracle.adf.view.faces.component.html.HtmlFrameBorderLayout

All Implemented Interfaces:

javax.faces.component.StateHolder

public class HtmlFrameBorderLayout

extends UIXComponentBase

frameBorderLayout is a layout bean which can be used to place seven frames at left, right, top, bottom, innerLeft, innerRight and center positions. It does not render any children except for the specified facets which must all be either FrameBeans or FrameBorderLayoutBeans. The user may use either left/right or start/end as facets, but not both. Left/right takes precedence over start/end.

On mobile devices a list linking to each frame is rendered.

Example:

 <frameBorderLayout>
  <left>
   <frame source="frame_leftTest.uix" name="left" width="30%" />
  </left>
 
  <center>
   <frame source="frame_centerTest.uix" name="contents" />
  </center>
 </frameBorderLayout>

*

This bean is not supported on the following agent types: pda, phone, voice.

Field Summary

static java.lang.String	ALTERNATE_CONTENT_FACET
static java.lang.String	BOTTOM_FACET
static java.lang.String	CENTER_FACET
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	END_FACET
static PropertyKey	HEIGHT_KEY
static PropertyKey	INLINE_STYLE_KEY
static java.lang.String	INNER_END_FACET
static java.lang.String	INNER_LEFT_FACET
static java.lang.String	INNER_RIGHT_FACET
static java.lang.String	INNER_START_FACET
static java.lang.String	LEFT_FACET
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 java.lang.String	RIGHT_FACET
static PropertyKey	SHORT_DESC_KEY
static java.lang.String	START_FACET
static PropertyKey	STYLE_CLASS_KEY
static java.lang.String	TOP_FACET
static FacesBean.Type	TYPE
static PropertyKey	WIDTH_KEY

Fields inherited from class oracle.adf.view.faces.component.UIXComponentBase

ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Constructor Summary

HtmlFrameBorderLayout()
Construct an instance of the HtmlFrameBorderLayout.

Method Summary

javax.faces.component.UIComponent	getAlternateContent() These contents will be rendered inside HTML NOFRAMES tags.
protected FacesBean.Type	getBeanType()
javax.faces.component.UIComponent	getBottom() The frame to be rendered below the center frame.
javax.faces.component.UIComponent	getCenter() The frame to be rendered in the center.
javax.faces.component.UIComponent	getEnd() The frame to be rendered to the right of the center frame, if the reading direction is left-to-right, or left otherwise.
java.lang.String	getFamily()
java.lang.String	getHeight() Gets The proposed height of this frameBorderLayout.
Style	getInlineStyle() Gets the inline CSS style for this element
javax.faces.component.UIComponent	getInnerEnd() The frame to be rendered as the innerRight frame, if the reading direction is left-to-right, or innerLeft frame otherwise.
javax.faces.component.UIComponent	getInnerLeft() The frame to be rendered between the left frame and the center frame.
javax.faces.component.UIComponent	getInnerRight() The frame to be rendered between the right frame and the center frame.
javax.faces.component.UIComponent	getInnerStart() The frame to be rendered as the innerLeft frame, if the reading direction is left-to-right, or innerRight frame otherwise.
javax.faces.component.UIComponent	getLeft() The frame to be rendered to the left of the center frame.
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.
javax.faces.component.UIComponent	getRight() The frame to be rendered to the right of the center frame.
java.lang.String	getShortDesc() Gets the short description of the bean.
javax.faces.component.UIComponent	getStart() The frame to be rendered to the left of the center frame, if the reading direction is left-to-right, or right otherwise.
java.lang.String	getStyleClass() Gets the CSS style class of the bean.
javax.faces.component.UIComponent	getTop() The frame to be rendered above the center frame.
java.lang.String	getWidth() Gets The proposed width of this frameBorderLayout.
void	setAlternateContent(javax.faces.component.UIComponent alternateContentFacet) These contents will be rendered inside HTML NOFRAMES tags.
void	setBottom(javax.faces.component.UIComponent bottomFacet) The frame to be rendered below the center frame.
void	setCenter(javax.faces.component.UIComponent centerFacet) The frame to be rendered in the center.
void	setEnd(javax.faces.component.UIComponent endFacet) The frame to be rendered to the right of the center frame, if the reading direction is left-to-right, or left otherwise.
void	setHeight(java.lang.String height) Sets The proposed height of this frameBorderLayout.
void	setInlineStyle(Style inlineStyle) Sets the inline CSS style for this element
void	setInnerEnd(javax.faces.component.UIComponent innerEndFacet) The frame to be rendered as the innerRight frame, if the reading direction is left-to-right, or innerLeft frame otherwise.
void	setInnerLeft(javax.faces.component.UIComponent innerLeftFacet) The frame to be rendered between the left frame and the center frame.
void	setInnerRight(javax.faces.component.UIComponent innerRightFacet) The frame to be rendered between the right frame and the center frame.
void	setInnerStart(javax.faces.component.UIComponent innerStartFacet) The frame to be rendered as the innerLeft frame, if the reading direction is left-to-right, or innerRight frame otherwise.
void	setLeft(javax.faces.component.UIComponent leftFacet) The frame to be rendered to the left of the center frame.
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	setRight(javax.faces.component.UIComponent rightFacet) The frame to be rendered to the right of the center frame.
void	setShortDesc(java.lang.String shortDesc) Sets the short description of the bean.
void	setStart(javax.faces.component.UIComponent startFacet) The frame to be rendered to the left of the center frame, if the reading direction is left-to-right, or right otherwise.
void	setStyleClass(java.lang.String styleClass) Sets the CSS style class of the bean.
void	setTop(javax.faces.component.UIComponent topFacet) The frame to be rendered above the center frame.
void	setWidth(java.lang.String width) Sets The proposed width of this frameBorderLayout.

Methods inherited from class oracle.adf.view.faces.component.UIXComponentBase

addFacesListener, broadcast, createFacesBean, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttribute, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getIntProperty, getLocalClientId, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreState, saveState, setAttribute, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, toString

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

WIDTH_KEY

public static final PropertyKey WIDTH_KEY

HEIGHT_KEY

public static final PropertyKey HEIGHT_KEY

SHORT_DESC_KEY

public static final PropertyKey SHORT_DESC_KEY

STYLE_CLASS_KEY

public static final PropertyKey STYLE_CLASS_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

INLINE_STYLE_KEY

public static final PropertyKey INLINE_STYLE_KEY

CENTER_FACET

public static final java.lang.String CENTER_FACET

See Also:

Constant Field Values

TOP_FACET

public static final java.lang.String TOP_FACET

See Also:

Constant Field Values

BOTTOM_FACET

public static final java.lang.String BOTTOM_FACET

See Also:

Constant Field Values

LEFT_FACET

public static final java.lang.String LEFT_FACET

See Also:

Constant Field Values

RIGHT_FACET

public static final java.lang.String RIGHT_FACET

See Also:

Constant Field Values

START_FACET

public static final java.lang.String START_FACET

See Also:

Constant Field Values

END_FACET

public static final java.lang.String END_FACET

See Also:

Constant Field Values

INNER_LEFT_FACET

public static final java.lang.String INNER_LEFT_FACET

See Also:

Constant Field Values

INNER_RIGHT_FACET

public static final java.lang.String INNER_RIGHT_FACET

See Also:

Constant Field Values

INNER_START_FACET

public static final java.lang.String INNER_START_FACET

See Also:

Constant Field Values

INNER_END_FACET

public static final java.lang.String INNER_END_FACET

See Also:

Constant Field Values

ALTERNATE_CONTENT_FACET

public static final java.lang.String ALTERNATE_CONTENT_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

HtmlFrameBorderLayout

public HtmlFrameBorderLayout()

Construct an instance of the HtmlFrameBorderLayout.

Method Detail

getCenter

public final javax.faces.component.UIComponent getCenter()

The frame to be rendered in the center.

This is a required property on the bean.

setCenter

public final void setCenter(javax.faces.component.UIComponent centerFacet)

The frame to be rendered in the center.

This is a required property on the bean.

getTop

public final javax.faces.component.UIComponent getTop()

The frame to be rendered above the center frame. This frame's height attribute is used to allocate its height.

setTop

public final void setTop(javax.faces.component.UIComponent topFacet)

The frame to be rendered above the center frame. This frame's height attribute is used to allocate its height.

getBottom

public final javax.faces.component.UIComponent getBottom()

The frame to be rendered below the center frame. This frame's height attribute is used to allocate its height.

setBottom

public final void setBottom(javax.faces.component.UIComponent bottomFacet)

The frame to be rendered below the center frame. This frame's height attribute is used to allocate its height.

getLeft

public final javax.faces.component.UIComponent getLeft()

The frame to be rendered to the left of the center frame. This frame's width attribute is used to allocate its width.

setLeft

public final void setLeft(javax.faces.component.UIComponent leftFacet)

The frame to be rendered to the left of the center frame. This frame's width attribute is used to allocate its width.

getRight

public final javax.faces.component.UIComponent getRight()

The frame to be rendered to the right of the center frame. This frame's width attribute is used to allocate its width.

setRight

public final void setRight(javax.faces.component.UIComponent rightFacet)

The frame to be rendered to the right of the center frame. This frame's width attribute is used to allocate its width.

getStart

public final javax.faces.component.UIComponent getStart()

The frame to be rendered to the left of the center frame, if the reading direction is left-to-right, or right otherwise. This frame's width attribute is used to allocate its width.

setStart

public final void setStart(javax.faces.component.UIComponent startFacet)

The frame to be rendered to the left of the center frame, if the reading direction is left-to-right, or right otherwise. This frame's width attribute is used to allocate its width.

getEnd

public final javax.faces.component.UIComponent getEnd()

The frame to be rendered to the right of the center frame, if the reading direction is left-to-right, or left otherwise. This frame's width attribute is used to allocate its width.

setEnd

public final void setEnd(javax.faces.component.UIComponent endFacet)

The frame to be rendered to the right of the center frame, if the reading direction is left-to-right, or left otherwise. This frame's width attribute is used to allocate its width.

getInnerLeft

public final javax.faces.component.UIComponent getInnerLeft()

The frame to be rendered between the left frame and the center frame. This frame's width attribute is used to allocate its width.

setInnerLeft

public final void setInnerLeft(javax.faces.component.UIComponent innerLeftFacet)

The frame to be rendered between the left frame and the center frame. This frame's width attribute is used to allocate its width.

getInnerRight

public final javax.faces.component.UIComponent getInnerRight()

The frame to be rendered between the right frame and the center frame. This frame's width attribute is used to allocate its width.

setInnerRight

public final void setInnerRight(javax.faces.component.UIComponent innerRightFacet)

The frame to be rendered between the right frame and the center frame. This frame's width attribute is used to allocate its width.

getInnerStart

public final javax.faces.component.UIComponent getInnerStart()

The frame to be rendered as the innerLeft frame, if the reading direction is left-to-right, or innerRight frame otherwise. This frame's width attribute is used to allocate its width.

setInnerStart

public final void setInnerStart(javax.faces.component.UIComponent innerStartFacet)

The frame to be rendered as the innerLeft frame, if the reading direction is left-to-right, or innerRight frame otherwise. This frame's width attribute is used to allocate its width.

getInnerEnd

public final javax.faces.component.UIComponent getInnerEnd()

The frame to be rendered as the innerRight frame, if the reading direction is left-to-right, or innerLeft frame otherwise. This frame's width attribute is used to allocate its width.

setInnerEnd

public final void setInnerEnd(javax.faces.component.UIComponent innerEndFacet)

The frame to be rendered as the innerRight frame, if the reading direction is left-to-right, or innerLeft frame otherwise. This frame's width attribute is used to allocate its width.

getAlternateContent

public final javax.faces.component.UIComponent getAlternateContent()

These contents will be rendered inside HTML NOFRAMES tags. Browsers that do not support frames will render these contents.

setAlternateContent

public final void setAlternateContent(javax.faces.component.UIComponent alternateContentFacet)

These contents will be rendered inside HTML NOFRAMES tags. Browsers that do not support frames will render these contents.

getWidth

public final java.lang.String getWidth()

Gets The proposed width of this frameBorderLayout. This can be in pixels or percentage. This attribute is used only if this a nested frameBorderLayout in a left/right facet of a FrameBorderLayoutBean.

setWidth

public final void setWidth(java.lang.String width)

Sets The proposed width of this frameBorderLayout. This can be in pixels or percentage. This attribute is used only if this a nested frameBorderLayout in a left/right facet of a FrameBorderLayoutBean.

getHeight

public final java.lang.String getHeight()

Gets The proposed height of this frameBorderLayout. This can be in pixels or percentage. This attribute is used only if this a nested frameBorderLayout in a top/bottom facet of a FrameBorderLayoutBean.

setHeight

public final void setHeight(java.lang.String height)

Sets The proposed height of this frameBorderLayout. This can be in pixels or percentage. This attribute is used only if this a nested frameBorderLayout in a top/bottom facet of a FrameBorderLayoutBean.

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.

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.

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.

getInlineStyle

public final Style getInlineStyle()

Gets the inline CSS style for this element

setInlineStyle

public final void setInlineStyle(Style inlineStyle)

Sets the inline CSS style for this element

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class UIXComponentBase

getBeanType

protected FacesBean.Type getBeanType()

Overrides:

getBeanType in class UIXComponentBase