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

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.HtmlFrame

All Implemented Interfaces:

javax.faces.component.StateHolder

public class HtmlFrame

extends UIXComponentBase

The FrameBean is used to specify attributes needed by an HTML frame. It does not render any child nodes, and should only be used as a facet on a FrameBorderLayout bean. The contents of a frame is selected by using the source attribute.

On mobile devices a list links to each frame is rendered for a frameBorderLayout, and each frame is brought up as a separate page.

Example:

 <frameBorderLayout  xmlns="http://xmlns.oracle.com/uix/ui" >
 
  <left>
   <frame source="frame_leftTest.uix" name="left" width="30%" />
  </left>
 
  <center>
   <frame source="frame_centerTest.uix" name="contents" />
  </center>
 
 </frameBorderLayout>

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static PropertyKey	HEIGHT_KEY
static PropertyKey	INLINE_STYLE_KEY
static PropertyKey	LONG_DESC_URL_KEY
static PropertyKey	NAME_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	SCROLLING_KEY
static PropertyKey	SHORT_DESC_KEY
static PropertyKey	SOURCE_KEY
static PropertyKey	STYLE_CLASS_KEY
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

HtmlFrame()
Construct an instance of the HtmlFrame.

Method Summary

protected FacesBean.Type	getBeanType()
java.lang.String	getFamily()
java.lang.String	getHeight() Gets the proposed height of this frame.
Style	getInlineStyle() Gets the inline CSS style for this element
java.lang.String	getLongDescURL() Gets This attribute specifies a link to a long description of the frame.
java.lang.String	getName() Gets the name used to identify this 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.
java.lang.String	getScrolling() Gets whether or not scrollbars are available on this frame.
java.lang.String	getShortDesc() Gets the short description of the bean.
java.lang.String	getSource() Gets the URI for the source of this frame
java.lang.String	getStyleClass() Gets the CSS style class of the bean.
java.lang.String	getWidth() Gets the proposed width of this frame This can be in pixels or percentage.
void	setHeight(java.lang.String height) Sets the proposed height of this frame.
void	setInlineStyle(Style inlineStyle) Sets the inline CSS style for this element
void	setLongDescURL(java.lang.String longDescURL) Sets This attribute specifies a link to a long description of the frame.
void	setName(java.lang.String name) Sets the name used to identify this 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	setScrolling(java.lang.String scrolling) Sets whether or not scrollbars are available on this frame.
void	setShortDesc(java.lang.String shortDesc) Sets the short description of the bean.
void	setSource(java.lang.String source) Sets the URI for the source of this frame
void	setStyleClass(java.lang.String styleClass) Sets the CSS style class of the bean.
void	setWidth(java.lang.String width) Sets the proposed width of this frame This can be in pixels or percentage.

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

SOURCE_KEY

public static final PropertyKey SOURCE_KEY

LONG_DESC_URL_KEY

public static final PropertyKey LONG_DESC_URL_KEY

NAME_KEY

public static final PropertyKey NAME_KEY

WIDTH_KEY

public static final PropertyKey WIDTH_KEY

HEIGHT_KEY

public static final PropertyKey HEIGHT_KEY

SCROLLING_KEY

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

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

HtmlFrame

public HtmlFrame()

Construct an instance of the HtmlFrame.

Method Detail

getSource

public final java.lang.String getSource()

Gets the URI for the source of this frame

setSource

public final void setSource(java.lang.String source)

Sets the URI for the source of this frame

getLongDescURL

public final java.lang.String getLongDescURL()

Gets This attribute specifies a link to a long description of the frame. This description should supplement the short description provided using the shortDesc attribute, and may be particularly useful for non-visual user agents.

setLongDescURL

public final void setLongDescURL(java.lang.String longDescURL)

Sets This attribute specifies a link to a long description of the frame. This description should supplement the short description provided using the shortDesc attribute, and may be particularly useful for non-visual user agents.

getName

public final java.lang.String getName()

Gets the name used to identify this frame

setName

public final void setName(java.lang.String name)

Sets the name used to identify this frame

getWidth

public final java.lang.String getWidth()

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

setWidth

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

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

getHeight

public final java.lang.String getHeight()

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

setHeight

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

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

getScrolling

public final java.lang.String getScrolling()

Gets whether or not scrollbars are available on this frame. Valid values for this attribute are the following constants:

SCROLLING_YES specifies that scrollbars are always available.

SCROLLING_NO specifies that scrollbars are never available.

SCROLLING_AUTO specifies that the browser determines whether to display scroll bars based on the size of the frame and its content. If you do not specify a value for scrolling, the default value is SCROLLING_AUTO.

setScrolling

public final void setScrolling(java.lang.String scrolling)

Sets whether or not scrollbars are available on this frame. Valid values for this attribute are the following constants:

SCROLLING_YES specifies that scrollbars are always available.

SCROLLING_NO specifies that scrollbars are never available.

SCROLLING_AUTO specifies that the browser determines whether to display scroll bars based on the size of the frame and its content. If you do not specify a value for scrolling, the default value is SCROLLING_AUTO.

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