org.rcfaces.core.component
Class RulerComponent

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by org.rcfaces.core.internal.component.CameliaBaseComponent
              extended by org.rcfaces.core.component.RulerComponent
All Implemented Interfaces:
StateHolder, IAlignmentCapability, IForegroundBackgroundColorCapability, IHeightCapability, IHiddenModeCapability, ILayoutPositionCapability, ILookAndFeelCapability, IMarginCapability, IOrientationCapability, IPositionCapability, ISizeCapability, IVisibilityCapability, IWidthCapability, 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 RulerComponent
extends org.rcfaces.core.internal.component.CameliaBaseComponent
implements IPositionCapability, ILayoutPositionCapability, IMarginCapability, ISizeCapability, IVisibilityCapability, IHiddenModeCapability, ILookAndFeelCapability, IOrientationCapability, IForegroundBackgroundColorCapability, IAlignmentCapability

The ruler Component is the <HR> 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 ruler Component has the following capability :

The default ruler renderer is linked to the f_ruler javascript class. f_ruler extends f_component

Table of component style classes:

Style Name Description
f_ruler Defines styles for the HR 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
 
Fields inherited from interface org.rcfaces.core.component.capability.IAlignmentCapability
CENTER, LEFT, RIGHT
 
Constructor Summary
RulerComponent()
           
RulerComponent(String componentId)
           
 
Method Summary
 String getAlignment()
          Returns a string that represents the alignement of the data in the component.
 String getAlignment(FacesContext facesContext)
          See getAlignment() for more details
 String getBackgroundColor()
          Returns the receiver's background color.
 String getBackgroundColor(FacesContext facesContext)
          See getBackgroundColor() for more details
 int getBottom()
           
 int getBottom(FacesContext facesContext)
          See getBottom() for more details
protected  Set getCameliaFields()
           
 String getForegroundColor()
          Returns the foreground color that the receiver will use to draw.
 String getForegroundColor(FacesContext facesContext)
          See getForegroundColor() for more details
 String getHeight()
          Returns a string value (as specified by CSS) for the height of the component.
 String getHeight(FacesContext facesContext)
          See getHeight() for more details
 int getHiddenMode()
          Returns the hidden mode in client side.
 int getHiddenMode(FacesContext facesContext)
          See getHiddenMode() for more details
 int getLeft()
           
 int getLeft(FacesContext facesContext)
          See getLeft() for more details
 String getLookId()
          Returns a string value specifying the choosen look of the component.
 String getLookId(FacesContext facesContext)
          See getLookId() for more details
 String getMarginBottom()
          Returns a string value specifying the margin size for the component's bottom (compliant to CSS margin-bottom).
 String getMarginBottom(FacesContext facesContext)
          See getMarginBottom() for more details
 String getMarginLeft()
          Returns a string value specifying the margin size for the component's left (compliant to CSS margin-left).
 String getMarginLeft(FacesContext facesContext)
          See getMarginLeft() for more details
 String getMarginRight()
          Returns a string value specifying the margin size for the component's right (compliant to CSS margin-right).
 String getMarginRight(FacesContext facesContext)
          See getMarginRight() for more details
 String getMarginTop()
          Returns a string value specifying the margin size for the component's top (compliant to CSS margin-top).
 String getMarginTop(FacesContext facesContext)
          See getMarginTop() for more details
 String getOrientation()
          Returns a string value specifying the orientation of the component.
 String getOrientation(FacesContext facesContext)
          See getOrientation() for more details
 int getRight()
           
 int getRight(FacesContext facesContext)
          See getRight() for more details
 int getTop()
           
 int getTop(FacesContext facesContext)
          See getTop() 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)
           
 String getWidth()
          Returns a string value (as specified by CSS) for the width of the component.
 String getWidth(FacesContext facesContext)
          See getWidth() for more details
 String getX()
          Returns a string value (as specified by CSS) for the x position of the component.
 String getX(FacesContext facesContext)
          See getX() for more details
 String getY()
          Returns a string value (as specified by CSS) for the y position of the component.
 String getY(FacesContext facesContext)
          See getY() for more details
 boolean isAlignmentSetted()
          Returns true if the attribute "alignment" is set.
 boolean isBackgroundColorSetted()
          Returns true if the attribute "backgroundColor" is set.
 boolean isBottomSetted()
          Returns true if the attribute "bottom" is set.
 boolean isForegroundColorSetted()
          Returns true if the attribute "foregroundColor" is set.
 boolean isHeightSetted()
          Returns true if the attribute "height" is set.
 boolean isHiddenModeSetted()
          Returns true if the attribute "hiddenMode" is set.
 boolean isLeftSetted()
          Returns true if the attribute "left" is set.
 boolean isLookIdSetted()
          Returns true if the attribute "lookId" is set.
 boolean isMarginBottomSetted()
          Returns true if the attribute "marginBottom" is set.
 boolean isMarginLeftSetted()
          Returns true if the attribute "marginLeft" is set.
 boolean isMarginRightSetted()
          Returns true if the attribute "marginRight" is set.
 boolean isMarginTopSetted()
          Returns true if the attribute "marginTop" is set.
 boolean isOrientationSetted()
          Returns true if the attribute "orientation" is set.
 boolean isRightSetted()
          Returns true if the attribute "right" is set.
 boolean isTopSetted()
          Returns true if the attribute "top" is set.
 boolean isVisible()
           
 boolean isVisible(FacesContext facesContext)
          See isVisible() for more details
 boolean isVisibleSetted()
          Returns true if the attribute "visible" is set.
 boolean isWidthSetted()
          Returns true if the attribute "width" is set.
 boolean isXSetted()
          Returns true if the attribute "x" is set.
 boolean isYSetted()
          Returns true if the attribute "y" is set.
 void setAlignment(String alignment)
          Sets a string that represents the alignement of the data in the component.
 void setBackgroundColor(String backgroundColor)
          Sets the receiver's background color to the color specified by the argument, or to the default system color for the control if the argument is null.
 void setBottom(int bottom)
           
 void setForegroundColor(String foregroundColor)
          Sets the receiver's foreground color to the color specified by the argument, or to the default system color for the control if the argument is null.
 void setHeight(String height)
          Sets a string value (as specified by CSS) for the height of the component.
 void setHiddenMode(int hiddenMode)
          Set the hidden mode in client side.
 void setHiddenMode(String hiddenMode)
           
 void setLeft(int left)
           
 void setLookId(String lookId)
          Sets a string value specifying the choosen look of the component.
 void setMarginBottom(String marginBottom)
          Sets a string value specifying the margin size for the component's bottom (compliant to CSS margin-bottom).
 void setMarginLeft(String marginLeft)
          Sets a string value specifying the margin size for the component's left (compliant to CSS margin-left).
 void setMarginRight(String marginRight)
          Sets a string value specifying the margin size for the component's right (compliant to CSS margin-right).
 void setMargins(String margins)
           
 void setMarginTop(String marginTop)
          Sets a string value specifying the margin size for the component's top (compliant to CSS margin-top).
 void setOrientation(String orientation)
          Sets a string value specifying the orientation of the component.
 void setRight(int right)
           
 void setTop(int top)
           
 void setVisible(boolean visible)
          Marks the receiver as visible if the argument is TRUE, and marks it invisible if argument is FALSE.
 void setWidth(String width)
          Sets a string value (as specified by CSS) for the width of the component.
 void setX(String x)
          Sets a string value (as specified by CSS) for the x position of the component.
 void setY(String y)
          Sets a string value (as specified by CSS) for the y position of the component.
 
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

RulerComponent

public RulerComponent()

RulerComponent

public RulerComponent(String componentId)
Method Detail

setMargins

public void setMargins(String margins)

setHiddenMode

public void setHiddenMode(String hiddenMode)

getVisibleState

public Boolean getVisibleState(FacesContext facesContext)

getX

public String getX()
Description copied from interface: IPositionCapability
Returns a string value (as specified by CSS) for the x position of the component.

Specified by:
getX in interface IPositionCapability
Returns:
as specified by CSS

getX

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


isXSetted

public final boolean isXSetted()
Returns true if the attribute "x" is set.

Returns:
true if the attribute is set.

setX

public void setX(String x)
Description copied from interface: IPositionCapability
Sets a string value (as specified by CSS) for the x position of the component.

Specified by:
setX in interface IPositionCapability
Parameters:
x - as specified by CSS

getY

public String getY()
Description copied from interface: IPositionCapability
Returns a string value (as specified by CSS) for the y position of the component.

Specified by:
getY in interface IPositionCapability
Returns:
as specified by CSS

getY

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


isYSetted

public final boolean isYSetted()
Returns true if the attribute "y" is set.

Returns:
true if the attribute is set.

setY

public void setY(String y)
Description copied from interface: IPositionCapability
Sets a string value (as specified by CSS) for the y position of the component.

Specified by:
setY in interface IPositionCapability
Parameters:
y - as specified by CSS

getBottom

public int getBottom()
Specified by:
getBottom in interface ILayoutPositionCapability

getBottom

public int getBottom(FacesContext facesContext)
See getBottom() for more details


isBottomSetted

public final boolean isBottomSetted()
Returns true if the attribute "bottom" is set.

Returns:
true if the attribute is set.

setBottom

public void setBottom(int bottom)
Specified by:
setBottom in interface ILayoutPositionCapability

getLeft

public int getLeft()
Specified by:
getLeft in interface ILayoutPositionCapability

getLeft

public int getLeft(FacesContext facesContext)
See getLeft() for more details


isLeftSetted

public final boolean isLeftSetted()
Returns true if the attribute "left" is set.

Returns:
true if the attribute is set.

setLeft

public void setLeft(int left)
Specified by:
setLeft in interface ILayoutPositionCapability

getRight

public int getRight()
Specified by:
getRight in interface ILayoutPositionCapability

getRight

public int getRight(FacesContext facesContext)
See getRight() for more details


isRightSetted

public final boolean isRightSetted()
Returns true if the attribute "right" is set.

Returns:
true if the attribute is set.

setRight

public void setRight(int right)
Specified by:
setRight in interface ILayoutPositionCapability

getTop

public int getTop()
Specified by:
getTop in interface ILayoutPositionCapability

getTop

public int getTop(FacesContext facesContext)
See getTop() for more details


isTopSetted

public final boolean isTopSetted()
Returns true if the attribute "top" is set.

Returns:
true if the attribute is set.

setTop

public void setTop(int top)
Specified by:
setTop in interface ILayoutPositionCapability

getMarginBottom

public String getMarginBottom()
Description copied from interface: IMarginCapability
Returns a string value specifying the margin size for the component's bottom (compliant to CSS margin-bottom).

Specified by:
getMarginBottom in interface IMarginCapability
Returns:
margin-bottom

getMarginBottom

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


isMarginBottomSetted

public final boolean isMarginBottomSetted()
Returns true if the attribute "marginBottom" is set.

Returns:
true if the attribute is set.

setMarginBottom

public void setMarginBottom(String marginBottom)
Description copied from interface: IMarginCapability
Sets a string value specifying the margin size for the component's bottom (compliant to CSS margin-bottom).

Specified by:
setMarginBottom in interface IMarginCapability
Parameters:
marginBottom - margin-bottom

getMarginLeft

public String getMarginLeft()
Description copied from interface: IMarginCapability
Returns a string value specifying the margin size for the component's left (compliant to CSS margin-left).

Specified by:
getMarginLeft in interface IMarginCapability
Returns:
margin-left

getMarginLeft

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


isMarginLeftSetted

public final boolean isMarginLeftSetted()
Returns true if the attribute "marginLeft" is set.

Returns:
true if the attribute is set.

setMarginLeft

public void setMarginLeft(String marginLeft)
Description copied from interface: IMarginCapability
Sets a string value specifying the margin size for the component's left (compliant to CSS margin-left).

Specified by:
setMarginLeft in interface IMarginCapability
Parameters:
marginLeft - margin-left

getMarginRight

public String getMarginRight()
Description copied from interface: IMarginCapability
Returns a string value specifying the margin size for the component's right (compliant to CSS margin-right).

Specified by:
getMarginRight in interface IMarginCapability
Returns:
margin-right

getMarginRight

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


isMarginRightSetted

public final boolean isMarginRightSetted()
Returns true if the attribute "marginRight" is set.

Returns:
true if the attribute is set.

setMarginRight

public void setMarginRight(String marginRight)
Description copied from interface: IMarginCapability
Sets a string value specifying the margin size for the component's right (compliant to CSS margin-right).

Specified by:
setMarginRight in interface IMarginCapability
Parameters:
marginRight - margin-right

getMarginTop

public String getMarginTop()
Description copied from interface: IMarginCapability
Returns a string value specifying the margin size for the component's top (compliant to CSS margin-top).

Specified by:
getMarginTop in interface IMarginCapability
Returns:
margin-top

getMarginTop

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


isMarginTopSetted

public final boolean isMarginTopSetted()
Returns true if the attribute "marginTop" is set.

Returns:
true if the attribute is set.

setMarginTop

public void setMarginTop(String marginTop)
Description copied from interface: IMarginCapability
Sets a string value specifying the margin size for the component's top (compliant to CSS margin-top).

Specified by:
setMarginTop in interface IMarginCapability
Parameters:
marginTop - margin-top

getWidth

public String getWidth()
Description copied from interface: IWidthCapability
Returns a string value (as specified by CSS) for the width of the component.

Specified by:
getWidth in interface IWidthCapability
Returns:
width

getWidth

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


isWidthSetted

public final boolean isWidthSetted()
Returns true if the attribute "width" is set.

Returns:
true if the attribute is set.

setWidth

public void setWidth(String width)
Description copied from interface: IWidthCapability
Sets a string value (as specified by CSS) for the width of the component.

Specified by:
setWidth in interface IWidthCapability
Parameters:
width - width

getHeight

public String getHeight()
Description copied from interface: IHeightCapability
Returns a string value (as specified by CSS) for the height of the component.

Specified by:
getHeight in interface IHeightCapability
Returns:
height

getHeight

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


isHeightSetted

public final boolean isHeightSetted()
Returns true if the attribute "height" is set.

Returns:
true if the attribute is set.

setHeight

public void setHeight(String height)
Description copied from interface: IHeightCapability
Sets a string value (as specified by CSS) for the height of the component.

Specified by:
setHeight in interface IHeightCapability
Parameters:
height - height

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

getLookId

public String getLookId()
Description copied from interface: ILookAndFeelCapability
Returns a string value specifying the choosen look of the component.

Specified by:
getLookId in interface ILookAndFeelCapability
Returns:
lookId

getLookId

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


isLookIdSetted

public final boolean isLookIdSetted()
Returns true if the attribute "lookId" is set.

Returns:
true if the attribute is set.

setLookId

public void setLookId(String lookId)
Description copied from interface: ILookAndFeelCapability
Sets a string value specifying the choosen look of the component.

Specified by:
setLookId in interface ILookAndFeelCapability
Parameters:
lookId - lookId

getOrientation

public String getOrientation()
Description copied from interface: IOrientationCapability
Returns a string value specifying the orientation of the component.

Specified by:
getOrientation in interface IOrientationCapability
Returns:
horizontal|vertical

getOrientation

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


isOrientationSetted

public final boolean isOrientationSetted()
Returns true if the attribute "orientation" is set.

Returns:
true if the attribute is set.

setOrientation

public void setOrientation(String orientation)
Description copied from interface: IOrientationCapability
Sets a string value specifying the orientation of the component.

Specified by:
setOrientation in interface IOrientationCapability
Parameters:
orientation - horizontal|vertical

getBackgroundColor

public String getBackgroundColor()
Description copied from interface: IForegroundBackgroundColorCapability
Returns the receiver's background color.

Specified by:
getBackgroundColor in interface IForegroundBackgroundColorCapability
Returns:
the background color

getBackgroundColor

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


isBackgroundColorSetted

public final boolean isBackgroundColorSetted()
Returns true if the attribute "backgroundColor" is set.

Returns:
true if the attribute is set.

setBackgroundColor

public void setBackgroundColor(String backgroundColor)
Description copied from interface: IForegroundBackgroundColorCapability
Sets the receiver's background color to the color specified by the argument, or to the default system color for the control if the argument is null.

Specified by:
setBackgroundColor in interface IForegroundBackgroundColorCapability
Parameters:
backgroundColor - background color

getForegroundColor

public String getForegroundColor()
Description copied from interface: IForegroundBackgroundColorCapability
Returns the foreground color that the receiver will use to draw.

Specified by:
getForegroundColor in interface IForegroundBackgroundColorCapability
Returns:
the receiver's foreground color

getForegroundColor

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


isForegroundColorSetted

public final boolean isForegroundColorSetted()
Returns true if the attribute "foregroundColor" is set.

Returns:
true if the attribute is set.

setForegroundColor

public void setForegroundColor(String foregroundColor)
Description copied from interface: IForegroundBackgroundColorCapability
Sets the receiver's foreground color to the color specified by the argument, or to the default system color for the control if the argument is null.

Specified by:
setForegroundColor in interface IForegroundBackgroundColorCapability
Parameters:
foregroundColor - foreground color

getAlignment

public String getAlignment()
Description copied from interface: IAlignmentCapability
Returns a string that represents the alignement of the data in the component.

Specified by:
getAlignment in interface IAlignmentCapability
Returns:
right|left|center

getAlignment

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


isAlignmentSetted

public final boolean isAlignmentSetted()
Returns true if the attribute "alignment" is set.

Returns:
true if the attribute is set.

setAlignment

public void setAlignment(String alignment)
Description copied from interface: IAlignmentCapability
Sets a string that represents the alignement of the data in the component.

Specified by:
setAlignment in interface IAlignmentCapability
Parameters:
alignment - right|left|center

getCameliaFields

protected Set getCameliaFields()
Overrides:
getCameliaFields in class org.rcfaces.core.internal.component.CameliaBaseComponent


Copyright © 2006-2011 Vedana. All Rights Reserved.