Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle WebCenter
11g Release 1 (11.1.1.3.0)
E15995-02


oracle.adf.view.page.editor.component
Class LayoutCustomizable

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.rich.component.rich.layout.RichPanelGroupLayout
                      extended by oracle.adf.view.page.editor.component.LayoutCustomizable

All Implemented Interfaces:
javax.faces.component.StateHolder

public class LayoutCustomizable
extends oracle.adf.view.rich.component.rich.layout.RichPanelGroupLayout
Since:
release specific (what release of product did this appear in)

Field Summary
static org.apache.myfaces.trinidad.bean.PropertyKey ACCESS_KEY_KEY
           
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
static org.apache.myfaces.trinidad.bean.PropertyKey LAYOUT_TYPE_KEY
           
static java.lang.String RENDERER_TYPE
           
static org.apache.myfaces.trinidad.bean.PropertyKey SHOW_ICON_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey SHOW_LAYOUT_CHANGER_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey SHOW_TYPES_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey TEXT_KEY
           
static org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
           

 

Fields inherited from class oracle.adf.view.rich.component.rich.layout.RichPanelGroupLayout
CLIENT_ATTRIBUTES_KEY, CLIENT_COMPONENT_KEY, CLIENT_LISTENERS_KEY, CUSTOMIZATION_ID_KEY, HALIGN_CENTER, HALIGN_END, HALIGN_KEY, HALIGN_LEFT, HALIGN_RIGHT, HALIGN_START, INLINE_STYLE_KEY, LANDMARK_BANNER, LANDMARK_COMPLEMENTARY, LANDMARK_CONTENTINFO, LANDMARK_KEY, LANDMARK_MAIN, LANDMARK_NAVIGATION, LANDMARK_NONE, LANDMARK_SEARCH, LAYOUT_DEFAULT, LAYOUT_HORIZONTAL, LAYOUT_KEY, LAYOUT_SCROLL, LAYOUT_VERTICAL, PARTIAL_TRIGGERS_KEY, SEPARATOR_FACET, SHORT_DESC_KEY, STYLE_CLASS_KEY, THEME_KEY, UNSECURE_KEY, VALIGN_BASELINE, VALIGN_BOTTOM, VALIGN_KEY, VALIGN_MIDDLE, VALIGN_TOP, VISIBLE_KEY

 

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

 

Method Summary
 void broadcast(javax.faces.event.FacesEvent facesEvent)
          Handle change layout event.
 char getAccessKey()
          Gets a character used to gain quick access to this link.
protected  org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
           
 java.lang.String getFamily()
           
 boolean getRendersChildren()
           
 boolean getShowIcon()
           
 boolean getShowLayoutChanger()
           
 java.lang.String[] getShowTypes()
           
 java.lang.String getText()
           
 java.lang.String getType()
           
 void setAccessKey(char accessKey)
          Sets a character used to gain quick access to this link.
 void setShowIcon(boolean showIcon)
           
 void setShowLayoutChanger(boolean showLayoutChanger)
           
 void setShowTypes(java.lang.String[] showTypes)
           
 void setText(java.lang.String text)
           
 void setType(java.lang.String type)
           

 

Methods inherited from class oracle.adf.view.rich.component.rich.layout.RichPanelGroupLayout
getClientAttributes, getClientListeners, getCustomizationId, getHalign, getInlineStyle, getLandmark, getLayout, getPartialTriggers, getSeparator, getShortDesc, getStyleClass, getTheme, getUnsecure, getValign, isClientComponent, isVisible, setClientAttributes, setClientComponent, setClientListeners, setCustomizationId, setHalign, setInlineStyle, setLandmark, setLayout, setPartialTriggers, setSeparator, setShortDesc, setStyleClass, setTheme, setUnsecure, setValign, setVisible

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, 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, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeFacesListener, restoreState, satisfiesPartialTrigger, 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, encodeFlattenedChild, encodeFlattenedChildren, 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

TYPE

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

LAYOUT_TYPE_KEY

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

SHOW_ICON_KEY

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

TEXT_KEY

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

SHOW_LAYOUT_CHANGER_KEY

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

ACCESS_KEY_KEY

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

SHOW_TYPES_KEY

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

RENDERER_TYPE

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

LayoutCustomizable

public LayoutCustomizable()

Method Detail

setType

public void setType(java.lang.String type)

setShowIcon

public void setShowIcon(boolean showIcon)

setText

public void setText(java.lang.String text)

setShowLayoutChanger

public void setShowLayoutChanger(boolean showLayoutChanger)

setShowTypes

public void setShowTypes(java.lang.String[] showTypes)

getRendersChildren

public boolean getRendersChildren()
Overrides:
getRendersChildren in class org.apache.myfaces.trinidad.component.UIXComponentBase

getType

public java.lang.String getType()

getShowIcon

public boolean getShowIcon()

getText

public java.lang.String getText()

getShowLayoutChanger

public boolean getShowLayoutChanger()

getShowTypes

public java.lang.String[] getShowTypes()

broadcast

public void broadcast(javax.faces.event.FacesEvent facesEvent)
               throws javax.faces.event.AbortProcessingException
Handle change layout event. Rest of the events are handled by UIComponent.broadcast(facesEvent)
Overrides:
broadcast in class org.apache.myfaces.trinidad.component.UIXComponentBase
Parameters:
facesEvent - the facesEvent object
Throws:
javax.faces.event.AbortProcessingException

getAccessKey

public char getAccessKey()
Gets a character used to gain quick access to this link. For accessibility reasons, this functionality is not supported in screen reader mode.

If the same access key appears in multiple input fields in the same page of output, the rendering user agent will cycle among the elements accessed by the similar keys. Note that user agents are inconsistent about dealing with two links having same access key, and so the cycling behavior is dependent on what the user agent provides.

This attribute is sometimes referred to as the "mnemonic".

The character specified by this attribute must exist in the Text attribute of this Link instance. If it does not, the user will receive no visual indication of the existence of the accessKey.

Note that the accessKey is triggered by browser-specific and platform-specific modifier keys. It even has browser-specific meaning. For example, Internet Explorer 7.0 will set focus when you press Alt+<accessKey>. Firefox 2.0 on some operating systems you press Alt+Shift+<accessKey>. Firefox 2.0 on other operating systems you press Control+<accessKey>. Refer to your browser's documentation for how it treats accessKey.

Returns:
the new accessKey value

setAccessKey

public void setAccessKey(char accessKey)
Sets a character used to gain quick access to this link. For accessibility reasons, this functionality is not supported in screen reader mode.

If the same access key appears in multiple input fields in the same page of output, the rendering user agent will cycle among the elements accessed by the similar keys. Note that user agents are inconsistent about dealing with two links having same access key, and so the cycling behavior is dependent on what the user agent provides.

This attribute is sometimes referred to as the "mnemonic".

The character specified by this attribute must exist in the Text attribute of this Link instance. If it does not, the user will receive no visual indication of the existence of the accessKey.

Note that the accessKey is triggered by browser-specific and platform-specific modifier keys. It even has browser-specific meaning. For example, Internet Explorer 7.0 will set focus when you press Alt+<accessKey>. Firefox 2.0 on some operating systems you press Alt+Shift+<accessKey>. Firefox 2.0 on other operating systems you press Control+<accessKey>. Refer to your browser's documentation for how it treats accessKey.

Parameters:
accessKey - the new accessKey value

getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class oracle.adf.view.rich.component.rich.layout.RichPanelGroupLayout

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
Overrides:
getBeanType in class oracle.adf.view.rich.component.rich.layout.RichPanelGroupLayout

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle WebCenter
11g Release 1 (11.1.1.3.0)
E15995-02


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