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

java.lang.Object
  javax.faces.component.UIComponent
      oracle.adf.view.faces.component.UIXComponent
          oracle.adf.view.faces.component.UIXComponentBase
              oracle.adf.view.faces.component.UIXPanel
                  oracle.adf.view.faces.component.core.layout.CorePanelBox

All Implemented Interfaces:

StateHolder

public class CorePanelBox

extends UIXPanel

The panelBox is used to place ancillary information on a page, offset by a certain color.

There are four possible attributes to set for the content container. The width of the container can be set to either an exact pixel size or a percentage of the element the content container is within.

Content containers can have headers and icons. Set the text and icon attributes to gain these items. If neither is set, the content container will only display its children. If there is a header but no icon, the header will show and the content will be offset to line up with the start of the header. If an icon is set, the icon will appear to the left of the header, but the content will still be offset to the left of the header. If an icon is set but no header, the icon will still be displayed on the left but no header text will be visible.

Content containers can have various color schemes, which can be specified by setting the background attribute to "light", "medium", "dark", or "transparent". The default is "light" if no background is set. Note that the appearance affects the color of the background, border, header, and header line.

Content containers will generally have only one child with the actual contents as its children. This child will describe how the content should be displayed. However, the content container can have multiple children, in which case the children are displayed in a stack fashion, lined up vertically.

Example:

   <af:panelBox text="Header"
                   background="medium"
                   icon="/images/info.gif"
                   width="25%" >
       <af:panelGroup layout="vertical">
         <af:goLink text="point 1" destination="http://www.oracle.com"/>
         <af:goLink text="point 2" destination="http://www.oracle.com"/>
         <af:goLink text="point 3" destination="http://www.oracle.com"/>
         <af:goLink text="point 4" destination="http://www.oracle.com"/>
         <af:goLink text="point 5" destination="http://www.oracle.com"/>
       </af:panelGroup>
   </af:panelBox>

Field Summary

static java.lang.String	BACKGROUND_DARK Enumerated value indicating that the control has a dark background.
static PropertyKey	BACKGROUND_KEY
static java.lang.String	BACKGROUND_LIGHT Enumerated value indicating that the control has a light background.
static java.lang.String	BACKGROUND_MEDIUM Enumerated value indicating that the control has a medium background.
static java.lang.String	BACKGROUND_TRANSPARENT Enumerated value indicating that the control has a transparent background, so the background color of the control will be the color of the background the control is placed over.
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static PropertyKey	ICON_KEY
static PropertyKey	INLINE_STYLE_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	SHORT_DESC_KEY
static PropertyKey	STYLE_CLASS_KEY
static PropertyKey	TEXT_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

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

Method Summary

java.lang.String	getBackground() Gets the appearance type of the content container.
protected FacesBean.Type	getBeanType()
java.lang.String	getFamily()
java.lang.String	getIcon() Gets An URL to an image to use for the icon of the content container.
java.lang.String	getInlineStyle() Gets the inline CSS style for this element
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.
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	getText() Gets The header of the content container.
java.lang.String	getWidth() Gets the width of the content container in pixels or as a percentage.
void	setBackground(java.lang.String background) Sets the appearance type of the content container.
void	setIcon(java.lang.String icon) Sets An URL to an image to use for the icon of the content container.
void	setInlineStyle(java.lang.String inlineStyle) Sets the inline CSS style for this element
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	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	setText(java.lang.String text) Sets The header of the content container.
void	setWidth(java.lang.String width) Sets the width of the content container in pixels or as a 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

BACKGROUND_DARK

public static final java.lang.String BACKGROUND_DARK

Enumerated value indicating that the control has a dark background.

See Also:

Constant Field Values

BACKGROUND_MEDIUM

public static final java.lang.String BACKGROUND_MEDIUM

Enumerated value indicating that the control has a medium background.

See Also:

Constant Field Values

BACKGROUND_LIGHT

public static final java.lang.String BACKGROUND_LIGHT

Enumerated value indicating that the control has a light background.

See Also:

Constant Field Values

BACKGROUND_TRANSPARENT

public static final java.lang.String BACKGROUND_TRANSPARENT

Enumerated value indicating that the control has a transparent background, so the background color of the control will be the color of the background the control is placed over.

See Also:

Constant Field Values

TYPE

public static final FacesBean.Type TYPE

WIDTH_KEY

public static final PropertyKey WIDTH_KEY

BACKGROUND_KEY

public static final PropertyKey BACKGROUND_KEY

TEXT_KEY

public static final PropertyKey TEXT_KEY

ICON_KEY

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

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

CorePanelBox

public CorePanelBox()

Construct an instance of the CorePanelBox.

CorePanelBox

protected CorePanelBox(java.lang.String rendererType)

Construct an instance of the CorePanelBox.

Method Detail

getWidth

public final java.lang.String getWidth()

Gets the width of the content container in pixels or as a percentage.

setWidth

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

Sets the width of the content container in pixels or as a percentage.

getBackground

public final java.lang.String getBackground()

Gets the appearance type of the content container. It should be one of "light", "medium", "dark", or "transparent"

setBackground

public final void setBackground(java.lang.String background)

Sets the appearance type of the content container. It should be one of "light", "medium", "dark", or "transparent"

getText

public final java.lang.String getText()

Gets The header of the content container.

setText

public final void setText(java.lang.String text)

Sets The header of the content container.

getIcon

public final java.lang.String getIcon()

Gets An URL to an image to use for the icon of the content container.

setIcon

public final void setIcon(java.lang.String icon)

Sets An URL to an image to use for the icon of the content container.

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