org.rcfaces.core.component
Class LineBreakComponent

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          org.rcfaces.core.internal.component.CameliaBaseComponent
              org.rcfaces.core.component.LineBreakComponent

All Implemented Interfaces:

StateHolder, IHiddenModeCapability, IStyleClassCapability, IVisibilityCapability, org.rcfaces.core.internal.capability.IComponentLifeCycle, org.rcfaces.core.internal.capability.IRCFacesComponent, org.rcfaces.core.internal.manager.IContainerManager, org.rcfaces.core.internal.manager.ITransientAttributesManager

public class LineBreakComponent
extends org.rcfaces.core.internal.component.CameliaBaseComponent
implements IStyleClassCapability, IVisibilityCapability, IHiddenModeCapability

The lineBreak Component is the <BR> HTML equivalent.

It is used often when simple HTML is not desirable : for example if a part of a page is loaded via AJAX it might be easier to have only a jsf tree memory represantation.

The lineBreak Component has the following capability :

• IStyleClassCapability
• IVisibilityCapability
• IHiddenModeCapability

The default lineBreak renderer is linked to the f_lineBreak javascript class. f_lineBreak extends f_component

Table of component style classes:

Style Name	Description
f_lineBreak	Defines styles for the wrapper element

Field Summary

protected static Set	CAMELIA_ATTRIBUTES
static String	COMPONENT_TYPE

Fields inherited from class org.rcfaces.core.internal.component.CameliaBaseComponent

engine

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

LineBreakComponent()

LineBreakComponent(String componentId)

Method Summary

protected Set	getCameliaFields()
int	getHiddenMode() Returns the hidden mode in client side.
int	getHiddenMode(FacesContext facesContext) See getHiddenMode() for more details
String	getStyleClass() Returns the style class of the component.
String	getStyleClass(FacesContext facesContext) See getStyleClass() for more details
Boolean	getVisibleState() Returns TRUE if the receiver is visible, FALSE if the receiver is specified "not visible", and null otherwise.
Boolean	getVisibleState(FacesContext facesContext)
boolean	isHiddenModeSetted() Returns true if the attribute "hiddenMode" is set.
boolean	isStyleClassSetted() Returns true if the attribute "styleClass" is set.
boolean	isVisible()
boolean	isVisible(FacesContext facesContext) See isVisible() for more details
boolean	isVisibleSetted() Returns true if the attribute "visible" is set.
void	setHiddenMode(int hiddenMode) Set the hidden mode in client side.
void	setHiddenMode(String hiddenMode)
void	setStyleClass(String styleClass) Specify the style class of the component.
void	setVisible(boolean visible) Marks the receiver as visible if the argument is TRUE, and marks it invisible if argument is FALSE.

Methods inherited from class org.rcfaces.core.internal.component.CameliaBaseComponent

clearListeners, confirmListenerAppend, constructPhase, constructTemplate, decodePhase, encodeBegin, encodeChildren, encodeEnd, getAsyncRenderer, getCameliaValueAlias, getChildren, getChildrenListState, getFamily, getRendererType, getTransientAttribute, getValueExpression, hasDefaultProperties, initializeComponent, initializePhase, isClientRendered, isRendered, isTemplateComponent, processDecodes, processEngineUpdates, processEngineValidators, processUpdates, processValidators, queueEvent, renderPhase, restoreState, saveState, setDefaultProperties, setRendered, setTransientAttribute, setValueExpression, toString, updatePhase, validationPhase, verifyAsyncDecode

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

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

CAMELIA_ATTRIBUTES

protected static final Set CAMELIA_ATTRIBUTES

Constructor Detail

LineBreakComponent

public LineBreakComponent()

LineBreakComponent

public LineBreakComponent(String componentId)

Method Detail

setHiddenMode

public void setHiddenMode(String hiddenMode)

getVisibleState

public Boolean getVisibleState(FacesContext facesContext)

getStyleClass

public String getStyleClass()

Description copied from interface: IStyleClassCapability

Returns the style class of the component.

Specified by:

getStyleClass in interface IStyleClassCapability

Returns:

style class

getStyleClass

public String getStyleClass(FacesContext facesContext)

See getStyleClass() for more details

isStyleClassSetted

public final boolean isStyleClassSetted()

Returns true if the attribute "styleClass" is set.

Returns:

true if the attribute is set.

setStyleClass

public void setStyleClass(String styleClass)

Description copied from interface: IStyleClassCapability

Specify the style class of the component.

Specified by:

setStyleClass in interface IStyleClassCapability

Parameters:

styleClass - style class

isVisible

public boolean isVisible()

Specified by:

isVisible in interface IVisibilityCapability

isVisible

public boolean isVisible(FacesContext facesContext)

See isVisible() for more details

isVisibleSetted

public final boolean isVisibleSetted()

Returns true if the attribute "visible" is set.

Returns:

true if the attribute is set.

setVisible

public void setVisible(boolean visible)

Description copied from interface: IVisibilityCapability

Marks the receiver as visible if the argument is TRUE, and marks it invisible if argument is FALSE.
If one of the receiver's ancestors is not visible or some other condition makes the receiver not visible, marking it visible may not actually cause it to be displayed.

Specified by:

setVisible in interface IVisibilityCapability

Parameters:

visible - the new visibility state.

getVisibleState

public Boolean getVisibleState()

Description copied from interface: IVisibilityCapability

Returns TRUE if the receiver is visible, FALSE if the receiver is specified "not visible", and null otherwise.
If one of the receiver's ancestors is not visible or some other condition makes the receiver not visible, this method may still indicate that it is considered visible even though it may not actually be showing.

Specified by:

getVisibleState in interface IVisibilityCapability

Returns:

the receiver's visibility state

getHiddenMode

public int getHiddenMode()

Description copied from interface: IHiddenModeCapability

Returns the hidden mode in client side.

Specified by:

getHiddenMode in interface IHiddenModeCapability

Returns:

hidden mode

getHiddenMode

public int getHiddenMode(FacesContext facesContext)

See getHiddenMode() for more details

isHiddenModeSetted

public final boolean isHiddenModeSetted()

Returns true if the attribute "hiddenMode" is set.

Returns:

true if the attribute is set.

setHiddenMode

public void setHiddenMode(int hiddenMode)

Description copied from interface: IHiddenModeCapability

Set the hidden mode in client side.

Specified by:

setHiddenMode in interface IHiddenModeCapability

Parameters:

hiddenMode - hidden mode

getCameliaFields

protected Set getCameliaFields()

Overrides:

getCameliaFields in class org.rcfaces.core.internal.component.CameliaBaseComponent