org.rcfaces.core.component
Class ExternalBoxComponent

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIOutput
              extended by org.rcfaces.core.internal.component.CameliaOutputComponent
                  extended by org.rcfaces.core.component.AbstractOutputComponent
                      extended by org.rcfaces.core.component.ExternalBoxComponent
All Implemented Interfaces:
StateHolder, ValueHolder, IClientDataCapability, IErrorEventCapability, IForegroundBackgroundColorCapability, IHeightCapability, IHelpCapability, IHiddenModeCapability, IInitEventCapability, ILayoutPositionCapability, ILoadEventCapability, ILookAndFeelCapability, IMarginCapability, IMouseEventCapability, IOverStyleClassCapability, IPartialRenderingCapability, IPositionCapability, IPropertyChangeEventCapability, IServerDataCapability, ISizeCapability, IStyleClassCapability, IToolTipCapability, IUnlockedClientAttributesCapability, IUserEventCapability, IValueLockedCapability, IVisibilityCapability, IWAIRoleCapability, IWidthCapability, org.rcfaces.core.internal.capability.IComponentLifeCycle, org.rcfaces.core.internal.capability.IConvertValueHolder, org.rcfaces.core.internal.capability.IRCFacesComponent, org.rcfaces.core.internal.manager.IClientDataManager, org.rcfaces.core.internal.manager.IContainerManager, org.rcfaces.core.internal.manager.IServerDataManager, org.rcfaces.core.internal.manager.ITransientAttributesManager

public class ExternalBoxComponent
extends AbstractOutputComponent
implements ILoadEventCapability, IOverStyleClassCapability

The externalBox Component is a container based on the standard HTML tag <IFrame>. .

The externalBox Component has the following capabilities :

The default externalBox renderer is link to the f_externalBox javascript class. f_externalBox extends f_component

Table of component style classes :

Table of component style classes:

Style Name Description
f_externalBox Defines styles for the wrapper Frame element


Field Summary
protected static Set CAMELIA_ATTRIBUTES
           
protected static String CAMELIA_VALUE_ALIAS
           
static String COMPONENT_TYPE
           
 
Fields inherited from class org.rcfaces.core.internal.component.CameliaOutputComponent
engine
 
Fields inherited from class javax.faces.component.UIOutput
COMPONENT_FAMILY
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Fields inherited from interface org.rcfaces.core.component.capability.IHiddenModeCapability
CLIENT_HIDDEN_MODE, DEFAULT_HIDDEN_MODE, IGNORE_HIDDEN_MODE, PHANTOM_HIDDEN_MODE, SERVER_HIDDEN_MODE
 
Constructor Summary
ExternalBoxComponent()
           
ExternalBoxComponent(String componentId)
           
 
Method Summary
 void addLoadListener(ILoadListener listener)
          Adds a listener to the component for the load event
protected  Set getCameliaFields()
           
protected  String getCameliaValueAlias()
           
 String getContentURL()
           
 String getContentURL(FacesContext facesContext)
           
 String getOverStyleClass()
           
 String getOverStyleClass(FacesContext facesContext)
          See getOverStyleClass() for more details
 String getScrolling()
           
 String getScrolling(FacesContext facesContext)
           
 boolean isContentURLSetted()
          Returns true if the attribute "contentURL" is set.
 boolean isOverStyleClassSetted()
          Returns true if the attribute "overStyleClass" is set.
 boolean isScrollingSetted()
          Returns true if the attribute "scrolling" is set.
 FacesListener[] listLoadListeners()
          Returns a list of load listener for the component
 void removeLoadListener(ILoadListener listener)
          Removes a listener from the component for the load event
 void setContentURL(String contentURL)
           
 void setOverStyleClass(String overStyleClass)
           
 void setScrolling(String scrolling)
           
 
Methods inherited from class org.rcfaces.core.component.AbstractOutputComponent
addErrorListener, addInitListener, addMouseOutListener, addMouseOverListener, addPropertyChangeListener, addUserEventListener, getAriaLabel, getAriaLabel, getAriaLevel, getAriaLevel, getBackgroundColor, getBackgroundColor, getBottom, getBottom, getClientData, getClientData, getClientDataCount, getClientDataMap, getClientDataMap, getForegroundColor, getForegroundColor, getHeight, getHeight, getHelpMessage, getHelpMessage, getHelpURL, getHelpURL, getHiddenMode, getHiddenMode, getLeft, getLeft, getLookId, getLookId, getMarginBottom, getMarginBottom, getMarginLeft, getMarginLeft, getMarginRight, getMarginRight, getMarginTop, getMarginTop, getRight, getRight, getServerData, getServerData, getServerDataCount, getServerDataMap, getServerDataMap, getStyleClass, getStyleClass, getToolTipText, getToolTipText, getTop, getTop, getUnlockedClientAttributeNames, getUnlockedClientAttributeNames, getVisibleState, getVisibleState, getWaiRole, getWaiRole, getWidth, getWidth, getX, getX, getY, getY, isAriaLabelSetted, isAriaLevelSetted, isBackgroundColorSetted, isBottomSetted, isForegroundColorSetted, isHeightSetted, isHelpMessageSetted, isHelpURLSetted, isHiddenModeSetted, isLeftSetted, isLookIdSetted, isMarginBottomSetted, isMarginLeftSetted, isMarginRightSetted, isMarginTopSetted, isPartialRendering, isPartialRendering, isPartialRenderingSetted, isRightSetted, isStyleClassSetted, isToolTipTextSetted, isTopSetted, isUnlockedClientAttributeNamesSetted, isValueLocked, isValueLocked, isValueLockedSetted, isVisible, isVisible, isVisibleSetted, isWaiRoleSetted, isWidthSetted, isXSetted, isYSetted, listClientDataKeys, listClientDataKeys, listErrorListeners, listInitListeners, listMouseOutListeners, listMouseOverListeners, listPropertyChangeListeners, listServerDataKeys, listServerDataKeys, listUserEventListeners, removeClientData, removeErrorListener, removeInitListener, removeMouseOutListener, removeMouseOverListener, removePropertyChangeListener, removeServerData, removeUserEventListener, setAriaLabel, setAriaLevel, setBackgroundColor, setBottom, setClientData, setClientData, setForegroundColor, setHeight, setHelpMessage, setHelpURL, setHiddenMode, setHiddenMode, setLeft, setLookId, setMarginBottom, setMarginLeft, setMarginRight, setMargins, setMarginTop, setPartialRendering, setRight, setServerData, setServerData, setStyleClass, setToolTipText, setTop, setUnlockedClientAttributeNames, setValueLocked, setVisible, setWaiRole, setWidth, setX, setY
 
Methods inherited from class org.rcfaces.core.internal.component.CameliaOutputComponent
clearListeners, confirmListenerAppend, constructPhase, constructTemplate, decodePhase, encodeBegin, encodeChildren, encodeEnd, getAsyncRenderer, getChildren, getChildrenListState, getFamily, getRendererType, getTransientAttribute, getValueExpression, hasDefaultProperties, initializeComponent, initializePhase, isClientRendered, isRendered, isTemplateComponent, processDecodes, processEngineUpdates, processEngineValidators, processUpdates, processValidators, queueEvent, renderPhase, restoreState, saveState, setConverter, setConverter, setDefaultProperties, setRendered, setTransientAttribute, setValueExpression, toString, updatePhase, validationPhase, verifyAsyncDecode
 
Methods inherited from class javax.faces.component.UIOutput
getConverter, getLocalValue, getValue, setConverter, setValue
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, decode, findComponent, getAttributes, getChildCount, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendersChildren, getValueBinding, invokeOnComponent, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.rcfaces.core.internal.manager.IContainerManager
getChildCount
 
Methods inherited from interface javax.faces.component.ValueHolder
getConverter, getLocalValue, getValue, setConverter, setValue
 

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE
See Also:
Constant Field Values

CAMELIA_ATTRIBUTES

protected static final Set CAMELIA_ATTRIBUTES

CAMELIA_VALUE_ALIAS

protected static final String CAMELIA_VALUE_ALIAS
See Also:
Constant Field Values
Constructor Detail

ExternalBoxComponent

public ExternalBoxComponent()

ExternalBoxComponent

public ExternalBoxComponent(String componentId)
Method Detail

addLoadListener

public final void addLoadListener(ILoadListener listener)
Description copied from interface: ILoadEventCapability
Adds a listener to the component for the load event

Specified by:
addLoadListener in interface ILoadEventCapability
Parameters:
listener - the load listener to add

removeLoadListener

public final void removeLoadListener(ILoadListener listener)
Description copied from interface: ILoadEventCapability
Removes a listener from the component for the load event

Specified by:
removeLoadListener in interface ILoadEventCapability
Parameters:
listener - the load listener to remove

listLoadListeners

public final FacesListener[] listLoadListeners()
Description copied from interface: ILoadEventCapability
Returns a list of load listener for the component

Specified by:
listLoadListeners in interface ILoadEventCapability
Returns:
load listeners' list

getOverStyleClass

public String getOverStyleClass()
Specified by:
getOverStyleClass in interface IOverStyleClassCapability

getOverStyleClass

public String getOverStyleClass(FacesContext facesContext)
See getOverStyleClass() for more details


isOverStyleClassSetted

public final boolean isOverStyleClassSetted()
Returns true if the attribute "overStyleClass" is set.

Returns:
true if the attribute is set.

setOverStyleClass

public void setOverStyleClass(String overStyleClass)
Specified by:
setOverStyleClass in interface IOverStyleClassCapability

getScrolling

public String getScrolling()

getScrolling

public String getScrolling(FacesContext facesContext)

setScrolling

public void setScrolling(String scrolling)

isScrollingSetted

public boolean isScrollingSetted()
Returns true if the attribute "scrolling" is set.

Returns:
true if the attribute is set.

getContentURL

public String getContentURL()

getContentURL

public String getContentURL(FacesContext facesContext)

setContentURL

public void setContentURL(String contentURL)

isContentURLSetted

public boolean isContentURLSetted()
Returns true if the attribute "contentURL" is set.

Returns:
true if the attribute is set.

getCameliaFields

protected Set getCameliaFields()
Overrides:
getCameliaFields in class AbstractOutputComponent

getCameliaValueAlias

protected String getCameliaValueAlias()
Overrides:
getCameliaValueAlias in class org.rcfaces.core.internal.component.CameliaOutputComponent


Copyright © 2006-2011 Vedana. All Rights Reserved.