Skip navigation links

Oracle Fusion Middleware Customizable Components Java API Reference for Oracle WebCenter
11g Release 1 (11.1.1)
E10692-01


oracle.adf.view.core.component.customizable
Class PanelCustomizable

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by org.apache.myfaces.trinidad.component.UIXComponent
          extended by org.apache.myfaces.trinidad.component.UIXComponentBase
              extended by org.apache.myfaces.trinidad.component.UIXPanel
                  extended by oracle.adf.view.core.component.customizable.PanelCustomizable

All Implemented Interfaces:
javax.faces.component.StateHolder
Direct Known Subclasses:
PanelCustomizable, PanelCustomizable

public class PanelCustomizable
extends org.apache.myfaces.trinidad.component.UIXPanel

PanelCustomizable is a layout component that wraps its children in one of two ways - either horizontal or vertical. In addition, if the children are ShowDetailFrame components, then the children ShowDetailFrame components can also be moved around within this component.

  Example 1: 
 
 <cust:panelCustomizable type="vertical" >
    <cust:showDetailFrame text="Show Detail Frame 1" >
      <af:objectImage source="graph.gif" />
    </cust:showDetailFrame>
    <cust:showDetailFrame text="Show Detail Frame 2" >
      <af:objectImage source="graph2.gif" />
    </cust:showDetailFrame>
 </cust:panelCustomizable >
  
  

In this example, you can move the showDetailFrame 1 and 2 up and down.

  Example 2: 
 
 <cust:panelCustomizable type="horizontal" >
    <cust:showDetailFrame text="Show Detail Frame 1" >
      <af:objectImage source="graph.gif" />
    </cust:showDetailFrame>
    <cust:showDetailFrame text="Show Detail Frame 2" >
      <af:objectImage source="graph2.gif" />
    </cust:showDetailFrame>
 </cust:panelCustomizable >
  
  

In this example, you can move the showDetailFrame children horizontally.


Field Summary
static org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY
           
static java.lang.String COMPONENT_FAMILY
           
static org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey HEIGHT_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY
           
static java.lang.String LAYOUT_HORIZONTAL
           
static org.apache.myfaces.trinidad.bean.PropertyKey LAYOUT_KEY
           
static java.lang.String LAYOUT_SCROLL
           
static java.lang.String LAYOUT_VERTICAL
           
static org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY
           
static java.lang.String SEPARATOR_FACET
           
static org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY
           
static org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
           
static org.apache.myfaces.trinidad.bean.PropertyKey WIDTH_KEY
           

 

Fields inherited from class org.apache.myfaces.trinidad.component.UIXPanel
COMPONENT_TYPE

 

Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

 

Fields inherited from class javax.faces.component.UIComponent
bindings

 

Constructor Summary
protected PanelCustomizable(java.lang.String rendererType)
          Constructs an instance of the PanelCustomizable component.

 

Method Summary
 void decode(javax.faces.context.FacesContext context)
          
protected  org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
          
 oracle.adf.view.rich.event.ClientListenerSet getClientListeners()
          Gets a set of client listeners.
 java.lang.String getCustomizationId()
          Get the value of CustomizationId attribute.
 java.lang.String getFamily()
          Returns the component family.
 java.lang.String getHeight()
          Specifies a fixed height for this component.
 java.lang.String getInlineStyle()
          Returns the inlineStyle attribute of the component
 java.lang.String getLayout()
          Get the value of layout attribute.
 java.lang.String getShortDesc()
          Returns the shortDesc attribute of the component
 java.lang.String getStyleClass()
          Returns the styleClass attribute of the component
 java.lang.String getWidth()
          Specifies a fixed width for this component.
 void setClientListeners(oracle.adf.view.rich.event.ClientListenerSet clientListeners)
          Sets a set of client listeners.
 void setCustomizationId(java.lang.String custId)
          Sets the value of CustomizationId attribute.
 void setHeight(java.lang.String height)
          Sets the height of the component.
 void setInlineStyle(java.lang.String inlineStyle)
          Sets the inlineStyle attribute of the component.
 void setLayout(java.lang.String layout)
          Sets the value of layout attribute.
 void setShortDesc(java.lang.String shortDesc)
          Sets the shortDesc attribute of the component.
 void setStyleClass(java.lang.String styleClass)
          Sets the styleClass attribute of the component.
 void setWidth(java.lang.String width)
          Sets the width of the component.

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decodeChildren, decodeChildrenImpl, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeFacesListener, restoreState, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent
addPartialTarget, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree

 

Methods inherited from class javax.faces.component.UIComponent
getContainerClientId

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Field Detail

COMPONENT_FAMILY

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

LAYOUT_VERTICAL

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

LAYOUT_HORIZONTAL

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

LAYOUT_SCROLL

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

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

LAYOUT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey LAYOUT_KEY

WIDTH_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey WIDTH_KEY

SHORT_DESC_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY

INLINE_STYLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY

STYLE_CLASS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY

PARTIAL_TRIGGERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY

HEIGHT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey HEIGHT_KEY

CLIENT_LISTENERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY

CUSTOMIZATION_ID_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY

SEPARATOR_FACET

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

Constructor Detail

PanelCustomizable

protected PanelCustomizable(java.lang.String rendererType)
Constructs an instance of the PanelCustomizable component.

Method Detail

getFamily

public java.lang.String getFamily()
Returns the component family.
Overrides:
getFamily in class org.apache.myfaces.trinidad.component.UIXPanel

getLayout

public final java.lang.String getLayout()
Get the value of layout attribute.
Returns:
the current value of the layout attribute. This value can either be horizontal or vertical.

setLayout

public final void setLayout(java.lang.String layout)
Sets the value of layout attribute.
Parameters:
layout - can either be horizontal or vertical

getCustomizationId

public final java.lang.String getCustomizationId()
Get the value of CustomizationId attribute.
Returns:
the current value of the CustomizationId attribute.

setCustomizationId

public final void setCustomizationId(java.lang.String custId)
Sets the value of CustomizationId attribute.
Parameters:
custId -

getWidth

public java.lang.String getWidth()
Specifies a fixed width for this component. If no width attribute specified, then the layout wraps to the width of the child elements. Width can be specified either in pixels or in percentage terms.
Returns:
the current value of the width attribute

setWidth

public void setWidth(java.lang.String width)
Sets the width of the component.
Parameters:
width - can be specified either in pixels or in percentage terms

getHeight

public java.lang.String getHeight()
Specifies a fixed height for this component. If no width attribute specified, then the layout wraps to the height of the child elements. Width can be specified either in pixels or in percentage terms.
Returns:
the current value of height attribute

setHeight

public void setHeight(java.lang.String height)
Sets the height of the component.
Parameters:
height - can be specified either in pixels or in percentage terms

getShortDesc

public java.lang.String getShortDesc()
Returns the shortDesc attribute of the component
Returns:
String representing the shortDesc attribute value

setShortDesc

public void setShortDesc(java.lang.String shortDesc)
Sets the shortDesc attribute of the component.
Parameters:
shortDesc - the new shortDesc attribute value

getInlineStyle

public java.lang.String getInlineStyle()
Returns the inlineStyle attribute of the component
Returns:
String representing the inlineStyle attribute value

setInlineStyle

public void setInlineStyle(java.lang.String inlineStyle)
Sets the inlineStyle attribute of the component.
Parameters:
inlineStyle - the new inlineStyle attribute value

getStyleClass

public java.lang.String getStyleClass()
Returns the styleClass attribute of the component
Returns:
String representing the styleClass attribute value

setStyleClass

public void setStyleClass(java.lang.String styleClass)
Sets the styleClass attribute of the component.
Parameters:
styleClass - the new styleClass attribute value

getClientListeners

public final oracle.adf.view.rich.event.ClientListenerSet getClientListeners()
Gets a set of client listeners.

setClientListeners

public final void setClientListeners(oracle.adf.view.rich.event.ClientListenerSet clientListeners)
Sets a set of client listeners.

decode

public void decode(javax.faces.context.FacesContext context)
Overrides:
decode in class org.apache.myfaces.trinidad.component.UIXComponentBase

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
Overrides:
getBeanType in class org.apache.myfaces.trinidad.component.UIXPanel

Skip navigation links

Oracle Fusion Middleware Customizable Components Java API Reference for Oracle WebCenter
11g Release 1 (11.1.1)
E10692-01


Copyright © 2005, 2009, Oracle. All rights reserved.