org.rcfaces.core.component
Class DataColumnComponent

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIColumn
              extended by org.rcfaces.core.internal.component.CameliaValueColumnComponent
                  extended by org.rcfaces.core.component.DataColumnComponent
All Implemented Interfaces:
StateHolder, ValueHolder, IAlignmentCapability, IAutoFilterCapability, ICellImageCapability, ICellStyleClassCapability, ICellToolTipTextCapability, IDoubleClickEventCapability, IForegroundBackgroundColorCapability, IHiddenModeCapability, IImageCapability, IImageSizeCapability, IInitEventCapability, IMenuPopupIdCapability, IOrderCapability, IResizableCapability, ISelectionEventCapability, ISortComparatorCapability, ISortEventCapability, IStatesImageCapability, IStyleClassCapability, ITextCapability, ITextDirectionCapability, IToolTipCapability, IUserEventCapability, IVerticalAlignmentCapability, IVisibilityCapability, IWidthCapability, IWidthRangeCapability, org.rcfaces.core.internal.capability.ICellImageSettings, org.rcfaces.core.internal.capability.ICellStyleClassSettings, org.rcfaces.core.internal.capability.ICellToolTipTextSettings, org.rcfaces.core.internal.capability.IComponentLifeCycle, org.rcfaces.core.internal.capability.IConvertValueHolder, org.rcfaces.core.internal.capability.IImageAccessorsCapability, org.rcfaces.core.internal.capability.IRCFacesComponent, org.rcfaces.core.internal.manager.IContainerManager, org.rcfaces.core.internal.manager.ITransientAttributesManager

public class DataColumnComponent
extends org.rcfaces.core.internal.component.CameliaValueColumnComponent
implements IVisibilityCapability, IHiddenModeCapability, ITextCapability, ITextDirectionCapability, IToolTipCapability, IAlignmentCapability, IForegroundBackgroundColorCapability, ISortEventCapability, IStyleClassCapability, IOrderCapability, ISortComparatorCapability, IResizableCapability, IStatesImageCapability, IImageSizeCapability, IMenuPopupIdCapability, IWidthRangeCapability, IVerticalAlignmentCapability, IAutoFilterCapability, ICellImageCapability, ICellStyleClassCapability, ICellToolTipTextCapability, ISelectionEventCapability, IDoubleClickEventCapability, IUserEventCapability, IInitEventCapability, org.rcfaces.core.internal.capability.IImageAccessorsCapability, ValueHolder, org.rcfaces.core.internal.capability.ICellStyleClassSettings, org.rcfaces.core.internal.capability.ICellToolTipTextSettings, org.rcfaces.core.internal.capability.ICellImageSettings

Specify a column.


Field Summary
protected static Set CAMELIA_ATTRIBUTES
           
static String COMPONENT_TYPE
           
 
Fields inherited from class org.rcfaces.core.internal.component.CameliaValueColumnComponent
engine
 
Fields inherited from class javax.faces.component.UIColumn
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
 
Fields inherited from interface org.rcfaces.core.component.capability.ITextDirectionCapability
DEFAULT_TEXT_DIRECTION, LEFT_TO_RIGHT_TEXT_DIRECTION, RIGHT_LEFT_TEXT_DIRECTION
 
Fields inherited from interface org.rcfaces.core.component.capability.IAlignmentCapability
CENTER, LEFT, RIGHT
 
Fields inherited from interface org.rcfaces.core.component.capability.ISortEventCapability
SORT_ALPHA, SORT_ALPHA_IGNORE_CASE, SORT_DATE, SORT_INTEGER, SORT_NUMBER, SORT_SERVER, SORT_TIME
 
Constructor Summary
DataColumnComponent()
           
DataColumnComponent(String componentId)
           
 
Method Summary
 void addDoubleClickListener(IDoubleClickListener listener)
          Adds a listener to the component for the doubleClick event
 void addInitListener(IInitListener listener)
          Adds a listener to the component for the init event
 void addSelectionListener(ISelectionListener listener)
          Adds a listener to the component for the selection event
 void addSortListener(ISortListener listener)
          Adds a listener to the component for the sort event
 void addUserEventListener(IUserEventListener listener)
          Adds a listener to the component for the user event
 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
protected  Set getCameliaFields()
           
 String getCellDefaultToolTipText()
          Returns a string value containing the text that will appear when the pointer hover the component.
 String getCellDefaultToolTipText(FacesContext facesContext)
          See getCellDefaultToolTipText() for more details
 String getCellImageURL()
          Returns an url string pointing to the image.
 String getCellImageURL(FacesContext facesContext)
          See getCellImageURL() for more details
 String getCellStyleClass()
          Returns a space-separated list of CSS style class(es) to be applied when this cell is rendered.
 String getCellStyleClass(FacesContext facesContext)
          See getCellStyleClass() for more details
 String getCellToolTipText()
          Returns a string value containing the text that will appear when the pointer hover the component.
 String getCellToolTipText(FacesContext facesContext)
          See getCellToolTipText() for more details
 Converter getConverter()
           
 String getDefaultCellImageURL()
          Returns an url string pointing to the default image.
 String getDefaultCellImageURL(FacesContext facesContext)
          See getDefaultCellImageURL() for more details
 String getDefaultCellStyleClass()
          Returns a space-separated list of default CSS style class(es) to be applied when this cell is rendered.
 String getDefaultCellStyleClass(FacesContext facesContext)
          See getDefaultCellStyleClass() for more details
 String getDisabledImageURL()
          Returns an url string pointing to the image used for the disabled state.
 String getDisabledImageURL(FacesContext facesContext)
          See getDisabledImageURL() for more details
 String getForegroundColor()
          Returns the foreground color that the receiver will use to draw.
 String getForegroundColor(FacesContext facesContext)
          See getForegroundColor() for more details
 int getHiddenMode()
          Returns the hidden mode in client side.
 int getHiddenMode(FacesContext facesContext)
          See getHiddenMode() for more details
 String getHoverImageURL()
          Returns an url string pointing to the image used chen the pointer hover the component.
 String getHoverImageURL(FacesContext facesContext)
          See getHoverImageURL() for more details
 IContentAccessors getImageAccessors()
          Returns ImageAccessors associated to the url.
 IContentAccessors getImageAccessors(FacesContext facesContext)
           
 int getImageHeight()
          Returns an int value specifying the height (in pixels) to use for the image shown.
 int getImageHeight(FacesContext facesContext)
          See getImageHeight() for more details
 String getImageURL()
          Returns the URL of the image.
 String getImageURL(FacesContext facesContext)
          See getImageURL() for more details
 int getImageWidth()
          Returns an int value specifying the width (in pixels) to use for the image shown.
 int getImageWidth(FacesContext facesContext)
          See getImageWidth() for more details
 Object getLocalValue()
           
 int getMaxWidth()
          Returns an int value specifying the maximum width in pixels (if resizeable).
 int getMaxWidth(FacesContext facesContext)
          See getMaxWidth() for more details
 String getMenuPopupId()
           
 String getMenuPopupId(FacesContext facesContext)
          See getMenuPopupId() for more details
 int getMinWidth()
          Returns an int value specifying the minimum width in pixels (if resizeable).
 int getMinWidth(FacesContext facesContext)
          See getMinWidth() for more details
 String getSelectedImageURL()
          Returns an url string pointing to the image used when the component is selected.
 String getSelectedImageURL(FacesContext facesContext)
          See getSelectedImageURL() for more details
 Comparator getSortComparator()
          Returns the sort Comparator object associated with the component
 Comparator getSortComparator(FacesContext facesContext)
          See getSortComparator() for more details
 String getStyleClass()
          Returns the style class of the component.
 String getStyleClass(FacesContext facesContext)
          See getStyleClass() for more details
 String getText()
          Returns a string value specifying the text shown.
 String getText(FacesContext facesContext)
          See getText() for more details
 int getTextDirection()
           
 int getTextDirection(FacesContext facesContext)
          See getTextDirection() for more details
 String getToolTipText()
          Returns the receiver's tool tip text, or null if it has not been set.
 String getToolTipText(FacesContext facesContext)
          See getToolTipText() for more details
 Object getValue()
           
 Object getValue(FacesContext context)
           
 String getVerticalAlignment()
          Returns vertical alignment.
 String getVerticalAlignment(FacesContext facesContext)
          See getVerticalAlignment() 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
 boolean isAlignmentSetted()
          Returns true if the attribute "alignment" is set.
 boolean isAscending()
          Returns a boolean value that indicates the sorting direction for the component.
 boolean isAscending(FacesContext facesContext)
          See isAscending() for more details
 boolean isAscendingSetted()
          Returns true if the attribute "ascending" is set.
 boolean isAutoFilter()
          Returns a boolean value indicating if the component should apply filter automatically.
 boolean isAutoFilter(FacesContext facesContext)
          See isAutoFilter() for more details
 boolean isAutoFilterSetted()
          Returns true if the attribute "autoFilter" is set.
 boolean isBackgroundColorSetted()
          Returns true if the attribute "backgroundColor" is set.
 boolean isCellDefaultToolTipTextSetted()
          Returns true if the attribute "cellDefaultToolTipText" is set.
 boolean isCellImageURLSetted()
          Returns true if the attribute "cellImageURL" is set.
 boolean isCellStyleClassSetted()
          Returns true if the attribute "cellStyleClass" is set.
 boolean isCellToolTipTextSetted()
          Returns true if the attribute "cellToolTipText" is set.
 boolean isDefaultCellImageURLSetted()
          Returns true if the attribute "defaultCellImageURL" is set.
 boolean isDefaultCellStyleClassSetted()
          Returns true if the attribute "defaultCellStyleClass" is set.
 boolean isDisabledImageURLSetted()
          Returns true if the attribute "disabledImageURL" is set.
 boolean isForegroundColorSetted()
          Returns true if the attribute "foregroundColor" is set.
 boolean isHiddenModeSetted()
          Returns true if the attribute "hiddenMode" is set.
 boolean isHoverImageURLSetted()
          Returns true if the attribute "hoverImageURL" is set.
 boolean isImageHeightSetted()
          Returns true if the attribute "imageHeight" is set.
 boolean isImageURLSetted()
          Returns true if the attribute "imageURL" is set.
 boolean isImageWidthSetted()
          Returns true if the attribute "imageWidth" is set.
 boolean isMaxWidthSetted()
          Returns true if the attribute "maxWidth" is set.
 boolean isMenuPopupIdSetted()
          Returns true if the attribute "menuPopupId" is set.
 boolean isMinWidthSetted()
          Returns true if the attribute "minWidth" is set.
 boolean isResizable()
          Returns a boolean value indicating wether the component can be resized by the user.
 boolean isResizable(FacesContext facesContext)
          See isResizable() for more details
 boolean isResizableSetted()
          Returns true if the attribute "resizable" is set.
 boolean isSelectedImageURLSetted()
          Returns true if the attribute "selectedImageURL" is set.
 boolean isSortComparatorSetted()
          Returns true if the attribute "sortComparator" is set.
 boolean isStyleClassSetted()
          Returns true if the attribute "styleClass" is set.
 boolean isTextDirectionSetted()
          Returns true if the attribute "textDirection" is set.
 boolean isTextSetted()
          Returns true if the attribute "text" is set.
 boolean isToolTipTextSetted()
          Returns true if the attribute "toolTipText" is set.
 boolean isVerticalAlignmentSetted()
          Returns true if the attribute "verticalAlignment" 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.
 FacesListener[] listDoubleClickListeners()
          Returns a list of doubleClick listener for the component
 FacesListener[] listInitListeners()
          Returns a list of init listener for the component
 FacesListener[] listSelectionListeners()
          Returns a list of selection listener for the component
 FacesListener[] listSortListeners()
          Returns a list of sort listener for the component
 FacesListener[] listUserEventListeners()
          Returns a list of user listener for the component
 void removeDoubleClickListener(IDoubleClickListener listener)
          Removes a listener from the component for the doubleClick event
 void removeInitListener(IInitListener listener)
          Removes a listener from the component for the init event
 void removeSelectionListener(ISelectionListener listener)
          Removes a listener from the component for the selection event
 void removeSortListener(ISortListener listener)
          Removes a listener from the component for the sort event
 void removeUserEventListener(IUserEventListener listener)
          Removes a listener from the component for the user event
 void setAlignment(String alignment)
          Sets a string that represents the alignement of the data in the component.
 void setAscending(boolean ascending)
          Sets a boolean value that indicates the sorting direction for the component.
 void setAscending(String order)
           
 void setAutoFilter(boolean autoFilter)
          Sets a boolean value indicating if the component should apply filter automatically.
 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 setCellDefaultToolTipText(String cellDefaultToolTipText)
          Sets a string value containing the text that will appear when the pointer hover the component.
 void setCellImageURL(String cellImageURL)
          Sets an url string pointing to the image.
 void setCellStyleClass(String cellStyleClass)
          Sets a space-separated list of CSS style class(es) to be applied when this cell is rendered.
 void setCellToolTipText(String cellToolTipText)
          Sets a string value containing the text that will appear when the pointer hover the component.
 void setConverter(Converter converter)
           
 void setConverter(FacesContext facesContext, String converterId)
           
 void setConverter(String converterId)
           
 void setDefaultCellImageURL(String defaultCellImageURL)
          Sets an url string pointing to the default image.
 void setDefaultCellStyleClass(String defaultCellStyleClass)
          Sets a space-separated list of default CSS style class(es) to be applied when this cell is rendered.
 void setDisabledImageURL(String disabledImageURL)
          Sets an url string pointing to the image used for the disabled state.
 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 setHiddenMode(int hiddenMode)
          Set the hidden mode in client side.
 void setHiddenMode(String hiddenMode)
           
 void setHoverImageURL(String hoverImageURL)
          Sets an url string pointing to the image used chen the pointer hover the component.
 void setImageHeight(int imageHeight)
          Sets an int value specifying the height (in pixels) to use for the image shown.
 void setImageURL(String imageURL)
          Specify the URL of the image.
 void setImageWidth(int imageWidth)
          Sets an int value specifying the width (in pixels) to use for the image shown.
 void setMaxWidth(int maxWidth)
          Sets an int value specifying the maximum width in pixels (if resizeable).
 void setMenuPopupId(String menuPopupId)
           
 void setMinWidth(int minWidth)
          Sets an int value specifying the minimum width in pixels (if resizeable).
 void setResizable(boolean resizable)
          Sets a boolean value indicating wether the component can be resized by the user.
 void setSelectedImageURL(String selectedImageURL)
          Sets an url string pointing to the image used when the component is selected.
 void setSortComparator(Comparator sortComparator)
          Associates a sort Comparator object to the component.
 void setStyleClass(String styleClass)
          Specify the style class of the component.
 void setText(String text)
          Sets a string value specifying the text to be shown.
 void setTextDirection(int textDirection)
           
 void setToolTipText(String toolTipText)
          Sets the receiver's tool tip text to the argument, which may be null indicating that no tool tip text should be shown.
 void setValue(Object value)
           
 void setVerticalAlignment(String verticalAlignment)
          Specifies vertical alignment.
 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.
 
Methods inherited from class org.rcfaces.core.internal.component.CameliaValueColumnComponent
clearListeners, confirmListenerAppend, constructPhase, constructTemplate, decodePhase, encodeBegin, encodeChildren, encodeEnd, getAsyncRenderer, getCameliaValueAlias, getChildren, getChildrenListState, getConverter, 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.UIColumn
getFooter, getHeader, setFooter, setHeader
 
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

DataColumnComponent

public DataColumnComponent()

DataColumnComponent

public DataColumnComponent(String componentId)
Method Detail

setConverter

public void setConverter(Converter converter)
Specified by:
setConverter in interface ValueHolder

getValue

public Object getValue()
Specified by:
getValue in interface ValueHolder

getLocalValue

public Object getLocalValue()
Specified by:
getLocalValue in interface ValueHolder

getConverter

public Converter getConverter()
Specified by:
getConverter in interface ValueHolder

setValue

public void setValue(Object value)
Specified by:
setValue in interface ValueHolder

getImageAccessors

public IContentAccessors getImageAccessors(FacesContext facesContext)
Specified by:
getImageAccessors in interface org.rcfaces.core.internal.capability.IImageAccessorsCapability

setConverter

public void setConverter(String converterId)

setConverter

public void setConverter(FacesContext facesContext,
                         String converterId)

getVisibleState

public Boolean getVisibleState(FacesContext facesContext)

getValue

public Object getValue(FacesContext context)

setHiddenMode

public void setHiddenMode(String hiddenMode)

setAscending

public void setAscending(String order)

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

getText

public String getText()
Description copied from interface: ITextCapability
Returns a string value specifying the text shown.

Specified by:
getText in interface ITextCapability
Returns:
text

getText

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


isTextSetted

public final boolean isTextSetted()
Returns true if the attribute "text" is set.

Returns:
true if the attribute is set.

setText

public void setText(String text)
Description copied from interface: ITextCapability
Sets a string value specifying the text to be shown.

Specified by:
setText in interface ITextCapability
Parameters:
text - text

getTextDirection

public int getTextDirection()
Specified by:
getTextDirection in interface ITextDirectionCapability

getTextDirection

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


isTextDirectionSetted

public final boolean isTextDirectionSetted()
Returns true if the attribute "textDirection" is set.

Returns:
true if the attribute is set.

setTextDirection

public void setTextDirection(int textDirection)
Specified by:
setTextDirection in interface ITextDirectionCapability

getToolTipText

public String getToolTipText()
Description copied from interface: IToolTipCapability
Returns the receiver's tool tip text, or null if it has not been set.

Specified by:
getToolTipText in interface IToolTipCapability
Returns:
the receiver's tool tip text

getToolTipText

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


isToolTipTextSetted

public final boolean isToolTipTextSetted()
Returns true if the attribute "toolTipText" is set.

Returns:
true if the attribute is set.

setToolTipText

public void setToolTipText(String toolTipText)
Description copied from interface: IToolTipCapability
Sets the receiver's tool tip text to the argument, which may be null indicating that no tool tip text should be shown.

Specified by:
setToolTipText in interface IToolTipCapability
Parameters:
toolTipText - the new tool tip text (or null)

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

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

addSortListener

public final void addSortListener(ISortListener listener)
Description copied from interface: ISortEventCapability
Adds a listener to the component for the sort event

Specified by:
addSortListener in interface ISortEventCapability
Parameters:
listener - the sort listener to add

removeSortListener

public final void removeSortListener(ISortListener listener)
Description copied from interface: ISortEventCapability
Removes a listener from the component for the sort event

Specified by:
removeSortListener in interface ISortEventCapability
Parameters:
listener - the sort listener to remove

listSortListeners

public final FacesListener[] listSortListeners()
Description copied from interface: ISortEventCapability
Returns a list of sort listener for the component

Specified by:
listSortListeners in interface ISortEventCapability
Returns:
sort listeners' list

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

isAscending

public boolean isAscending()
Description copied from interface: IOrderCapability
Returns a boolean value that indicates the sorting direction for the component.

Specified by:
isAscending in interface IOrderCapability
Returns:
true if ascending, false if descending

isAscending

public boolean isAscending(FacesContext facesContext)
See isAscending() for more details


isAscendingSetted

public final boolean isAscendingSetted()
Returns true if the attribute "ascending" is set.

Returns:
true if the attribute is set.

setAscending

public void setAscending(boolean ascending)
Description copied from interface: IOrderCapability
Sets a boolean value that indicates the sorting direction for the component.

Specified by:
setAscending in interface IOrderCapability
Parameters:
ascending - true if ascending, false if descending

getSortComparator

public Comparator getSortComparator()
Description copied from interface: ISortComparatorCapability
Returns the sort Comparator object associated with the component

Specified by:
getSortComparator in interface ISortComparatorCapability
Returns:
the sort Comparator object

getSortComparator

public Comparator getSortComparator(FacesContext facesContext)
See getSortComparator() for more details


isSortComparatorSetted

public final boolean isSortComparatorSetted()
Returns true if the attribute "sortComparator" is set.

Returns:
true if the attribute is set.

setSortComparator

public void setSortComparator(Comparator sortComparator)
Description copied from interface: ISortComparatorCapability
Associates a sort Comparator object to the component.

Specified by:
setSortComparator in interface ISortComparatorCapability
Parameters:
sortComparator - the sort Comparator object

isResizable

public boolean isResizable()
Description copied from interface: IResizableCapability
Returns a boolean value indicating wether the component can be resized by the user.

Specified by:
isResizable in interface IResizableCapability
Returns:
resizeable boolean property

isResizable

public boolean isResizable(FacesContext facesContext)
See isResizable() for more details


isResizableSetted

public final boolean isResizableSetted()
Returns true if the attribute "resizable" is set.

Returns:
true if the attribute is set.

setResizable

public void setResizable(boolean resizable)
Description copied from interface: IResizableCapability
Sets a boolean value indicating wether the component can be resized by the user.

Specified by:
setResizable in interface IResizableCapability
Parameters:
resizable - resizeable boolean property

getDisabledImageURL

public String getDisabledImageURL()
Description copied from interface: IStatesImageCapability
Returns an url string pointing to the image used for the disabled state.

Specified by:
getDisabledImageURL in interface IStatesImageCapability
Returns:
url

getDisabledImageURL

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


isDisabledImageURLSetted

public final boolean isDisabledImageURLSetted()
Returns true if the attribute "disabledImageURL" is set.

Returns:
true if the attribute is set.

setDisabledImageURL

public void setDisabledImageURL(String disabledImageURL)
Description copied from interface: IStatesImageCapability
Sets an url string pointing to the image used for the disabled state.

Specified by:
setDisabledImageURL in interface IStatesImageCapability
Parameters:
disabledImageURL - url

getHoverImageURL

public String getHoverImageURL()
Description copied from interface: IStatesImageCapability
Returns an url string pointing to the image used chen the pointer hover the component.

Specified by:
getHoverImageURL in interface IStatesImageCapability
Returns:
url

getHoverImageURL

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


isHoverImageURLSetted

public final boolean isHoverImageURLSetted()
Returns true if the attribute "hoverImageURL" is set.

Returns:
true if the attribute is set.

setHoverImageURL

public void setHoverImageURL(String hoverImageURL)
Description copied from interface: IStatesImageCapability
Sets an url string pointing to the image used chen the pointer hover the component.

Specified by:
setHoverImageURL in interface IStatesImageCapability
Parameters:
hoverImageURL - url

getSelectedImageURL

public String getSelectedImageURL()
Description copied from interface: IStatesImageCapability
Returns an url string pointing to the image used when the component is selected.

Specified by:
getSelectedImageURL in interface IStatesImageCapability
Returns:
url

getSelectedImageURL

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


isSelectedImageURLSetted

public final boolean isSelectedImageURLSetted()
Returns true if the attribute "selectedImageURL" is set.

Returns:
true if the attribute is set.

setSelectedImageURL

public void setSelectedImageURL(String selectedImageURL)
Description copied from interface: IStatesImageCapability
Sets an url string pointing to the image used when the component is selected.

Specified by:
setSelectedImageURL in interface IStatesImageCapability
Parameters:
selectedImageURL - url

getImageURL

public String getImageURL()
Description copied from interface: IImageCapability
Returns the URL of the image.

Specified by:
getImageURL in interface IImageCapability

getImageURL

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


isImageURLSetted

public final boolean isImageURLSetted()
Returns true if the attribute "imageURL" is set.

Returns:
true if the attribute is set.

setImageURL

public void setImageURL(String imageURL)
Description copied from interface: IImageCapability
Specify the URL of the image.

Specified by:
setImageURL in interface IImageCapability

getImageAccessors

public IContentAccessors getImageAccessors()
Description copied from interface: IImageCapability
Returns ImageAccessors associated to the url. (or java.awt.Image binding)

Specified by:
getImageAccessors in interface IImageCapability
Returns:
IImageAccessors object.

getImageHeight

public int getImageHeight()
Description copied from interface: IImageSizeCapability
Returns an int value specifying the height (in pixels) to use for the image shown.

Specified by:
getImageHeight in interface IImageSizeCapability
Returns:
image height in pixels

getImageHeight

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


isImageHeightSetted

public final boolean isImageHeightSetted()
Returns true if the attribute "imageHeight" is set.

Returns:
true if the attribute is set.

setImageHeight

public void setImageHeight(int imageHeight)
Description copied from interface: IImageSizeCapability
Sets an int value specifying the height (in pixels) to use for the image shown.

Specified by:
setImageHeight in interface IImageSizeCapability
Parameters:
imageHeight - image height in pixels

getImageWidth

public int getImageWidth()
Description copied from interface: IImageSizeCapability
Returns an int value specifying the width (in pixels) to use for the image shown.

Specified by:
getImageWidth in interface IImageSizeCapability
Returns:
image width in pixels

getImageWidth

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


isImageWidthSetted

public final boolean isImageWidthSetted()
Returns true if the attribute "imageWidth" is set.

Returns:
true if the attribute is set.

setImageWidth

public void setImageWidth(int imageWidth)
Description copied from interface: IImageSizeCapability
Sets an int value specifying the width (in pixels) to use for the image shown.

Specified by:
setImageWidth in interface IImageSizeCapability
Parameters:
imageWidth - image width in pixels

getMenuPopupId

public String getMenuPopupId()
Specified by:
getMenuPopupId in interface IMenuPopupIdCapability

getMenuPopupId

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


isMenuPopupIdSetted

public final boolean isMenuPopupIdSetted()
Returns true if the attribute "menuPopupId" is set.

Returns:
true if the attribute is set.

setMenuPopupId

public void setMenuPopupId(String menuPopupId)
Specified by:
setMenuPopupId in interface IMenuPopupIdCapability

getMaxWidth

public int getMaxWidth()
Description copied from interface: IWidthRangeCapability
Returns an int value specifying the maximum width in pixels (if resizeable).

Specified by:
getMaxWidth in interface IWidthRangeCapability
Returns:
max width

getMaxWidth

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


isMaxWidthSetted

public final boolean isMaxWidthSetted()
Returns true if the attribute "maxWidth" is set.

Returns:
true if the attribute is set.

setMaxWidth

public void setMaxWidth(int maxWidth)
Description copied from interface: IWidthRangeCapability
Sets an int value specifying the maximum width in pixels (if resizeable).

Specified by:
setMaxWidth in interface IWidthRangeCapability
Parameters:
maxWidth - max width

getMinWidth

public int getMinWidth()
Description copied from interface: IWidthRangeCapability
Returns an int value specifying the minimum width in pixels (if resizeable).

Specified by:
getMinWidth in interface IWidthRangeCapability
Returns:
min width

getMinWidth

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


isMinWidthSetted

public final boolean isMinWidthSetted()
Returns true if the attribute "minWidth" is set.

Returns:
true if the attribute is set.

setMinWidth

public void setMinWidth(int minWidth)
Description copied from interface: IWidthRangeCapability
Sets an int value specifying the minimum width in pixels (if resizeable).

Specified by:
setMinWidth in interface IWidthRangeCapability
Parameters:
minWidth - min width

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

getVerticalAlignment

public String getVerticalAlignment()
Description copied from interface: IVerticalAlignmentCapability
Returns vertical alignment.

Specified by:
getVerticalAlignment in interface IVerticalAlignmentCapability
Returns:
vertical alignment

getVerticalAlignment

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


isVerticalAlignmentSetted

public final boolean isVerticalAlignmentSetted()
Returns true if the attribute "verticalAlignment" is set.

Returns:
true if the attribute is set.

setVerticalAlignment

public void setVerticalAlignment(String verticalAlignment)
Description copied from interface: IVerticalAlignmentCapability
Specifies vertical alignment.

Specified by:
setVerticalAlignment in interface IVerticalAlignmentCapability
Parameters:
verticalAlignment - vertical alignment

isAutoFilter

public boolean isAutoFilter()
Description copied from interface: IAutoFilterCapability
Returns a boolean value indicating if the component should apply filter automatically.

Specified by:
isAutoFilter in interface IAutoFilterCapability
Returns:
true if the component should apply filter

isAutoFilter

public boolean isAutoFilter(FacesContext facesContext)
See isAutoFilter() for more details


isAutoFilterSetted

public final boolean isAutoFilterSetted()
Returns true if the attribute "autoFilter" is set.

Returns:
true if the attribute is set.

setAutoFilter

public void setAutoFilter(boolean autoFilter)
Description copied from interface: IAutoFilterCapability
Sets a boolean value indicating if the component should apply filter automatically.

Specified by:
setAutoFilter in interface IAutoFilterCapability
Parameters:
autoFilter - true if the component should apply filter

getCellImageURL

public String getCellImageURL()
Description copied from interface: ICellImageCapability
Returns an url string pointing to the image.

Specified by:
getCellImageURL in interface ICellImageCapability
Returns:
image url

getCellImageURL

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


isCellImageURLSetted

public final boolean isCellImageURLSetted()
Returns true if the attribute "cellImageURL" is set.

Specified by:
isCellImageURLSetted in interface org.rcfaces.core.internal.capability.ICellImageSettings
Returns:
true if the attribute is set.

setCellImageURL

public void setCellImageURL(String cellImageURL)
Description copied from interface: ICellImageCapability
Sets an url string pointing to the image.

Specified by:
setCellImageURL in interface ICellImageCapability
Parameters:
cellImageURL - image url for the cell

getDefaultCellImageURL

public String getDefaultCellImageURL()
Description copied from interface: ICellImageCapability
Returns an url string pointing to the default image.

Specified by:
getDefaultCellImageURL in interface ICellImageCapability
Returns:
image url

getDefaultCellImageURL

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


isDefaultCellImageURLSetted

public final boolean isDefaultCellImageURLSetted()
Returns true if the attribute "defaultCellImageURL" is set.

Specified by:
isDefaultCellImageURLSetted in interface org.rcfaces.core.internal.capability.ICellImageSettings
Returns:
true if the attribute is set.

setDefaultCellImageURL

public void setDefaultCellImageURL(String defaultCellImageURL)
Description copied from interface: ICellImageCapability
Sets an url string pointing to the default image.

Specified by:
setDefaultCellImageURL in interface ICellImageCapability
Parameters:
defaultCellImageURL - image url

getCellStyleClass

public String getCellStyleClass()
Description copied from interface: ICellStyleClassCapability
Returns a space-separated list of CSS style class(es) to be applied when this cell is rendered. This value will be passed through as the "class" attribute on generated markup.

Specified by:
getCellStyleClass in interface ICellStyleClassCapability
Returns:
list of CSS style classes

getCellStyleClass

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


isCellStyleClassSetted

public final boolean isCellStyleClassSetted()
Returns true if the attribute "cellStyleClass" is set.

Specified by:
isCellStyleClassSetted in interface org.rcfaces.core.internal.capability.ICellStyleClassSettings
Returns:
true if the attribute is set.

setCellStyleClass

public void setCellStyleClass(String cellStyleClass)
Description copied from interface: ICellStyleClassCapability
Sets a space-separated list of CSS style class(es) to be applied when this cell is rendered. This value will be passed through as the "class" attribute on generated markup.

Specified by:
setCellStyleClass in interface ICellStyleClassCapability
Parameters:
cellStyleClass - list of CSS style classes

getDefaultCellStyleClass

public String getDefaultCellStyleClass()
Description copied from interface: ICellStyleClassCapability
Returns a space-separated list of default CSS style class(es) to be applied when this cell is rendered. This value will be passed through as the "class" attribute on generated markup.

Specified by:
getDefaultCellStyleClass in interface ICellStyleClassCapability
Returns:
list of default CSS style classes

getDefaultCellStyleClass

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


isDefaultCellStyleClassSetted

public final boolean isDefaultCellStyleClassSetted()
Returns true if the attribute "defaultCellStyleClass" is set.

Returns:
true if the attribute is set.

setDefaultCellStyleClass

public void setDefaultCellStyleClass(String defaultCellStyleClass)
Description copied from interface: ICellStyleClassCapability
Sets a space-separated list of default CSS style class(es) to be applied when this cell is rendered. This value will be passed through as the "class" attribute on generated markup.

Specified by:
setDefaultCellStyleClass in interface ICellStyleClassCapability
Parameters:
defaultCellStyleClass - list of default CSS style classes

getCellDefaultToolTipText

public String getCellDefaultToolTipText()
Description copied from interface: ICellToolTipTextCapability
Returns a string value containing the text that will appear when the pointer hover the component.

Specified by:
getCellDefaultToolTipText in interface ICellToolTipTextCapability
Returns:
default tool tip text

getCellDefaultToolTipText

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


isCellDefaultToolTipTextSetted

public final boolean isCellDefaultToolTipTextSetted()
Returns true if the attribute "cellDefaultToolTipText" is set.

Returns:
true if the attribute is set.

setCellDefaultToolTipText

public void setCellDefaultToolTipText(String cellDefaultToolTipText)
Description copied from interface: ICellToolTipTextCapability
Sets a string value containing the text that will appear when the pointer hover the component.

Specified by:
setCellDefaultToolTipText in interface ICellToolTipTextCapability
Parameters:
cellDefaultToolTipText - default tool tip text

getCellToolTipText

public String getCellToolTipText()
Description copied from interface: ICellToolTipTextCapability
Returns a string value containing the text that will appear when the pointer hover the component.

Specified by:
getCellToolTipText in interface ICellToolTipTextCapability
Returns:
tool tip text

getCellToolTipText

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


isCellToolTipTextSetted

public final boolean isCellToolTipTextSetted()
Returns true if the attribute "cellToolTipText" is set.

Specified by:
isCellToolTipTextSetted in interface org.rcfaces.core.internal.capability.ICellToolTipTextSettings
Returns:
true if the attribute is set.

setCellToolTipText

public void setCellToolTipText(String cellToolTipText)
Description copied from interface: ICellToolTipTextCapability
Sets a string value containing the text that will appear when the pointer hover the component.

Specified by:
setCellToolTipText in interface ICellToolTipTextCapability
Parameters:
cellToolTipText - tool tip text

addSelectionListener

public final void addSelectionListener(ISelectionListener listener)
Description copied from interface: ISelectionEventCapability
Adds a listener to the component for the selection event

Specified by:
addSelectionListener in interface ISelectionEventCapability
Parameters:
listener - the selection listener to add

removeSelectionListener

public final void removeSelectionListener(ISelectionListener listener)
Description copied from interface: ISelectionEventCapability
Removes a listener from the component for the selection event

Specified by:
removeSelectionListener in interface ISelectionEventCapability
Parameters:
listener - the selection listener to remove

listSelectionListeners

public final FacesListener[] listSelectionListeners()
Description copied from interface: ISelectionEventCapability
Returns a list of selection listener for the component

Specified by:
listSelectionListeners in interface ISelectionEventCapability
Returns:
selection listeners' list

addDoubleClickListener

public final void addDoubleClickListener(IDoubleClickListener listener)
Description copied from interface: IDoubleClickEventCapability
Adds a listener to the component for the doubleClick event

Specified by:
addDoubleClickListener in interface IDoubleClickEventCapability
Parameters:
listener - the doubleClick listener to add

removeDoubleClickListener

public final void removeDoubleClickListener(IDoubleClickListener listener)
Description copied from interface: IDoubleClickEventCapability
Removes a listener from the component for the doubleClick event

Specified by:
removeDoubleClickListener in interface IDoubleClickEventCapability
Parameters:
listener - the doubleClick listener to remove

listDoubleClickListeners

public final FacesListener[] listDoubleClickListeners()
Description copied from interface: IDoubleClickEventCapability
Returns a list of doubleClick listener for the component

Specified by:
listDoubleClickListeners in interface IDoubleClickEventCapability
Returns:
doubleClick listeners' list

addUserEventListener

public final void addUserEventListener(IUserEventListener listener)
Description copied from interface: IUserEventCapability
Adds a listener to the component for the user event

Specified by:
addUserEventListener in interface IUserEventCapability
Parameters:
listener - the user listener to add

removeUserEventListener

public final void removeUserEventListener(IUserEventListener listener)
Description copied from interface: IUserEventCapability
Removes a listener from the component for the user event

Specified by:
removeUserEventListener in interface IUserEventCapability
Parameters:
listener - the user listener to remove

listUserEventListeners

public final FacesListener[] listUserEventListeners()
Description copied from interface: IUserEventCapability
Returns a list of user listener for the component

Specified by:
listUserEventListeners in interface IUserEventCapability
Returns:
user listeners' list

addInitListener

public final void addInitListener(IInitListener listener)
Description copied from interface: IInitEventCapability
Adds a listener to the component for the init event

Specified by:
addInitListener in interface IInitEventCapability
Parameters:
listener - the init listener to add

removeInitListener

public final void removeInitListener(IInitListener listener)
Description copied from interface: IInitEventCapability
Removes a listener from the component for the init event

Specified by:
removeInitListener in interface IInitEventCapability
Parameters:
listener - the init listener to remove

listInitListeners

public final FacesListener[] listInitListeners()
Description copied from interface: IInitEventCapability
Returns a list of init listener for the component

Specified by:
listInitListeners in interface IInitEventCapability
Returns:
init listeners' list

getCameliaFields

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


Copyright © 2006-2011 Vedana. All Rights Reserved.