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:

StateHolder

public class HtmlFrame

extends UIXComponentBase

The frame 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 component. 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:

 <afh:frameBorderLayout >
 
  <f:facet name="left">
   <afh:frame source="frame_leftTest.jspx" name="left" width="30%" />
  </f:facet>
 
  <f:facet name="center">
   <afh:frame source="frame_centerTest.jspx" name="contents" />
  </f:facet>
 
 </afh: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	MARGIN_HEIGHT_KEY
static PropertyKey	MARGIN_WIDTH_KEY
static PropertyKey	NAME_KEY
static PropertyKey	PARTIAL_TRIGGERS_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

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Constructor Summary

	HtmlFrame() Construct an instance of the HtmlFrame.
protected	HtmlFrame(java.lang.String rendererType) 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.
java.lang.String	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.
int	getMarginHeight() Gets the width of the frame margin.
int	getMarginWidth() Gets the width of the frame margin.
java.lang.String	getName() Gets the name used to identify this frame
java.lang.String[]	getPartialTriggers() Gets the IDs of the components that should trigger a partial update.
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(java.lang.String 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	setMarginHeight(int marginHeight) Sets the width of the frame margin.
void	setMarginWidth(int marginWidth) Sets the width of the frame margin.
void	setName(java.lang.String name) Sets the name used to identify this frame
void	setPartialTriggers(java.lang.String[] partialTriggers) Sets the IDs of the components that should trigger a partial update.
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

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

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

MARGIN_WIDTH_KEY

public static final PropertyKey MARGIN_WIDTH_KEY

MARGIN_HEIGHT_KEY

public static final PropertyKey MARGIN_HEIGHT_KEY

SCROLLING_KEY

public static final PropertyKey SCROLLING_KEY

SHORT_DESC_KEY

public static final PropertyKey SHORT_DESC_KEY

PARTIAL_TRIGGERS_KEY

public static final PropertyKey PARTIAL_TRIGGERS_KEY

STYLE_CLASS_KEY

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

HtmlFrame

protected HtmlFrame(java.lang.String rendererType)

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 frameBorderLayout component.

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 frameBorderLayout component.

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 frameBorderLayout component.

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 frameBorderLayout component.

getMarginWidth

public final int getMarginWidth()

Gets the width of the frame margin. The value must be greater than zero (pixels).

setMarginWidth

public final void setMarginWidth(int marginWidth)

Sets the width of the frame margin. The value must be greater than zero (pixels).

getMarginHeight

public final int getMarginHeight()

Gets the width of the frame margin. The value must be greater than zero (pixels).

setMarginHeight

public final void setMarginHeight(int marginHeight)

Sets the width of the frame margin. The value must be greater than zero (pixels).

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:

"yes" specifies that scrollbars are always available.

"no" specifies that scrollbars are never available.

"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 "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:

"yes" specifies that scrollbars are always available.

"no" specifies that scrollbars are never available.

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

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.

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()

Specified by:

getFamily in class UIXComponentBase

getBeanType

protected FacesBean.Type getBeanType()

Overrides:

getBeanType in class UIXComponentBase