|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
org.rcfaces.core.internal.component.CameliaGridComponent
org.rcfaces.core.component.AbstractGridComponent
org.rcfaces.core.component.KeyEntryComponent
org.rcfaces.core.component.ComboGridComponent
public class ComboGridComponent
The comboGrid Component has the same fonctionalities as the combo component but the popup is based on a dataGrid. The comboGrid can have multiple columns, be filtered, paged and some other datagrid capabilities
The comboGrid Component has the following capabilities :
The default comboGrid renderer is link to the f_comboGrid javascript class. f_comboGrid extends f_keyEntry, fa_dataGridPopup
Table of component style classes:
| Style Name | Description |
|---|---|
| f_comboGrid | Defines styles for the wrapper Table element |
| f_comboGrid_input | Defines styles for the Input Text |
| f_comboGrid_popup | Defines styles for the wrapper DIV elment of the pop-up. Contains fa_dataGridPopup styles |
| Field Summary | |
|---|---|
protected static Set |
CAMELIA_ATTRIBUTES
|
static String |
COMPONENT_TYPE
|
| Fields inherited from class org.rcfaces.core.internal.component.CameliaGridComponent |
|---|
engine |
| Fields inherited from class javax.faces.component.UIComponent |
|---|
bindings |
| Fields inherited from interface org.rcfaces.core.component.capability.IClientFullStateCapability |
|---|
DEFAULT_CLIENT_FULL_STATE, FALSE_CLIENT_FULL_STATE, NONE_CLIENT_FULL_STATE, ONEWAY_CLIENT_FULL_STATE, TRUE_CLIENT_FULL_STATE, TWOWAYS_CLIENT_FULL_STATE |
| Fields inherited from interface org.rcfaces.core.component.capability.IAdditionalInformationCardinalityCapability |
|---|
DEFAULT_CARDINALITY |
| Fields inherited from interface org.rcfaces.core.component.capability.ICardinality |
|---|
ONE_CARDINALITY, ONEMANY_CARDINALITY, OPTIONAL_CARDINALITY, ZEROMANY_CARDINALITY |
| 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 javax.faces.component.NamingContainer |
|---|
SEPARATOR_CHAR |
| Constructor Summary | |
|---|---|
ComboGridComponent()
|
|
ComboGridComponent(String componentId)
|
|
| Method Summary | |
|---|---|
void |
addAdditionalInformationListener(IAdditionalInformationListener listener)
Adds a listener to the component for the additional event |
int |
getAdditionalInformationCardinality()
Returns an int value indicating the cardinality (number of additional-informations allowed) for this component. |
int |
getAdditionalInformationCardinality(FacesContext facesContext)
See getAdditionalInformationCardinality() for more details |
Object |
getAdditionalInformationValues()
|
Object |
getAdditionalInformationValues(FacesContext facesContext)
|
int |
getAdditionalInformationValuesCount()
|
Class |
getAdditionalInformationValuesType(FacesContext facesContext)
Return the type of the property represented by the ValueExpression, relative to the specified FacesContext. |
protected Set |
getCameliaFields()
|
int |
getClientAdditionalInformationFullState()
Returns an integer value indicating whether the client should know about the component's full state even if only a part of the data is present (AJAX). |
int |
getClientAdditionalInformationFullState(FacesContext facesContext)
See getClientAdditionalInformationFullState() for more details |
org.rcfaces.core.internal.tools.CollectionTools.IComponentValueType |
getComponentValueType()
|
Object |
getFirstAdditionalInformationValue()
|
ComboColumnComponent |
getFirstSortedColumn()
|
String |
getGridLookId()
|
String |
getGridLookId(FacesContext facesContext)
|
String |
getGridStyleClass()
|
String |
getGridStyleClass(FacesContext facesContext)
|
String |
getManyResultsMessage()
|
String |
getManyResultsMessage(FacesContext facesContext)
See getManyResultsMessage() for more details |
String |
getMessage()
|
String |
getMessage(FacesContext facesContext)
See getMessage() for more details |
String |
getOneResultMessage()
|
String |
getOneResultMessage(FacesContext facesContext)
See getOneResultMessage() for more details |
UIComponent[] |
getOrderedChildren()
Returns a list of the columns' id which represents their order from left to right. |
String |
getPagerLookId()
|
String |
getPagerLookId(FacesContext facesContext)
|
String |
getPagerStyleClass()
|
String |
getPagerStyleClass(FacesContext facesContext)
|
int |
getPopupHeight()
|
int |
getPopupHeight(FacesContext facesContext)
|
String |
getPopupStyleClass()
|
String |
getPopupStyleClass(FacesContext facesContext)
|
int |
getPopupWidth()
|
int |
getPopupWidth(FacesContext facesContext)
|
String |
getRowStyleClass()
|
String |
getRowStyleClass(FacesContext facesContext)
See getRowStyleClass() for more details |
UIComponent[] |
getSortedChildren()
Returns a string value giving the ordered list of the sorted components. |
ComboColumnComponent[] |
getSortedColumns()
|
String |
getZeroResultMessage()
|
String |
getZeroResultMessage(FacesContext facesContext)
See getZeroResultMessage() for more details |
void |
hideAdditionalInformation(int index)
|
void |
hideAdditionalInformation(int[] indexes)
|
void |
hideAdditionalInformation(Object rowValue)
|
void |
hideAllAdditionalInformations()
|
boolean |
isAdditionalInformationCardinalitySetted()
Returns true if the attribute "additionalInformationCardinality" is set. |
boolean |
isAdditionalInformationValuesSetted()
Returns true if the attribute "additionalInformationValues" is set. |
boolean |
isClientAdditionalInformationFullStateSetted()
Returns true if the attribute "clientAdditionalInformationFullState" is set. |
boolean |
isGridLookIdSetted()
Returns true if the attribute "gridLookId" is set. |
boolean |
isGridStyleClassSetted()
Returns true if the attribute "gridStyleClass" is set. |
boolean |
isHeaderVisible()
Returns a boolean value indicating wether the header should be visible. |
boolean |
isHeaderVisible(FacesContext facesContext)
See isHeaderVisible() for more details |
boolean |
isHeaderVisibleSetted()
Returns true if the attribute "headerVisible" is set. |
boolean |
isManyResultsMessageSetted()
Returns true if the attribute "manyResultsMessage" is set. |
boolean |
isMessageSetted()
Returns true if the attribute "message" is set. |
boolean |
isOneResultMessageSetted()
Returns true if the attribute "oneResultMessage" is set. |
boolean |
isPaged()
Returns a boolean value specifying wether the results should be displayed by page (thus letting the user choose what page to display via the pager). |
boolean |
isPaged(FacesContext facesContext)
See isPaged() for more details |
boolean |
isPagedSetted()
|
boolean |
isPagerLookIdSetted()
Returns true if the attribute "pagerLookId" is set. |
boolean |
isPagerStyleClassSetted()
Returns true if the attribute "pagerStyleClass" is set. |
boolean |
isPopupHeightSetted()
Returns true if the attribute "popupHeight" is set. |
boolean |
isPopupStyleClassSetted()
Returns true if the attribute "popupStyleClass" is set. |
boolean |
isPopupWidthSetted()
Returns true if the attribute "popupWidth" is set. |
boolean |
isRowStyleClassSetted()
Returns true if the attribute "rowStyleClass" is set. |
boolean |
isSearchFieldVisible()
|
boolean |
isSearchFieldVisible(FacesContext facesContext)
|
boolean |
isSearchFieldVisibleSetted()
Returns true if the attribute "searchFieldVisible" is set. |
boolean |
isZeroResultMessageSetted()
Returns true if the attribute "zeroResultMessage" is set. |
FacesListener[] |
listAdditionalInformationListeners()
Returns a list of additional listener for the component |
IAdditionalInformationIterator |
listAdditionalInformations()
|
Object[] |
listAdditionalInformationValues()
|
IColumnIterator |
listColumns()
|
ISortedComponent[] |
listSortedComponents()
|
ISortedComponent[] |
listSortedComponents(FacesContext context)
|
void |
removeAdditionalInformationListener(IAdditionalInformationListener listener)
Removes a listener from the component for the additional event |
void |
setAdditionalInformationCardinality(int additionalInformationCardinality)
Sets an int value indicating the cardinality (number of additional-informations allowed) for this component. |
void |
setAdditionalInformationValues(Object additionalInformationValues)
|
void |
setClientAdditionalInformationFullState(int clientAdditionalInformationFullState)
Sets an integer value indicating whether the client should know about the component's full state even if only a part of the data is present (AJAX). |
void |
setClientAdditionalInformationFullState(String state)
|
void |
setGridLookId(String gridLookId)
|
void |
setGridStyleClass(String gridStyleClass)
|
void |
setHeaderVisible(boolean headerVisible)
Sets a boolean value indicating wether the header should be visible. |
void |
setManyResultsMessage(String manyResultsMessage)
|
void |
setMessage(String message)
|
void |
setOneResultMessage(String oneResultMessage)
|
void |
setOrderedChildren(UIComponent[] components)
Sets a list of the columns' id which represents their order from left to right. |
void |
setPaged(boolean paged)
Sets a boolean value specifying wether the results should be displayed by page (thus letting the user choose what page to display via the pager). |
void |
setPagerLookId(String pagerLookId)
|
void |
setPagerStyleClass(String pagerStyleClass)
|
void |
setPopupHeight(int popupHeight)
|
void |
setPopupStyleClass(String popupStyleClass)
|
void |
setPopupWidth(int popupWidth)
|
void |
setRowStyleClass(String rowStyleClass)
|
void |
setSearchFieldVisible(boolean searchFieldVisible)
|
void |
setSortedChildren(UIComponent[] components)
Set the ordered list of the sorted components |
void |
setSortedColumn(ComboColumnComponent comboColumn)
|
void |
setSortedColumns(ComboColumnComponent[] componentsColumns)
|
void |
setZeroResultMessage(String zeroResultMessage)
|
void |
showAdditionalInformation(int index)
|
void |
showAdditionalInformation(int[] indexes)
|
void |
showAdditionalInformation(Object rowValue)
|
void |
showAllAdditionalInformations()
|
| Methods inherited from class org.rcfaces.core.internal.component.CameliaGridComponent |
|---|
clearListeners, confirmListenerAppend, constructPhase, constructTemplate, decodePhase, encodeBegin, encodeChildren, encodeEnd, getAsyncRenderer, getCameliaValueAlias, getChildren, getChildrenListState, getDataModel, getDataModelValue, getFamily, getRendererType, getRowCount, getRowData, getTransientAttribute, getValue, getValue, getValueExpression, hasDefaultProperties, initializeComponent, initializePhase, isClientRendered, isRendered, isRowAvailable, isRowAvailable, isTemplateComponent, processDecodes, processEngineUpdates, processEngineValidators, processUpdates, processValidators, queueEvent, renderPhase, restoreState, saveState, setDefaultProperties, setRendered, setTransientAttribute, setValue, 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.component.capability.IFilterCapability |
|---|
getFilterProperties, setFilterProperties |
| Methods inherited from interface org.rcfaces.core.internal.capability.IGridComponent |
|---|
getDataModelValue, getFirst, getRowCount, getRowData, getRows, isRowAvailable, setFirst, setRowIndex |
| Methods inherited from interface org.rcfaces.core.internal.manager.IContainerManager |
|---|
getChildCount |
| Field Detail |
|---|
public static final String COMPONENT_TYPE
protected static final Set CAMELIA_ATTRIBUTES
| Constructor Detail |
|---|
public ComboGridComponent()
public ComboGridComponent(String componentId)
| Method Detail |
|---|
public UIComponent[] getSortedChildren()
ISortedChildrenCapability
getSortedChildren in interface ISortedChildrenCapabilitypublic void setSortedChildren(UIComponent[] components)
ISortedChildrenCapability
setSortedChildren in interface ISortedChildrenCapabilitypublic void setOrderedChildren(UIComponent[] components)
IOrderedChildrenCapability
setOrderedChildren in interface IOrderedChildrenCapabilitycomponents - ordered list of columns' idpublic UIComponent[] getOrderedChildren()
IOrderedChildrenCapability
getOrderedChildren in interface IOrderedChildrenCapabilitypublic org.rcfaces.core.internal.tools.CollectionTools.IComponentValueType getComponentValueType()
getComponentValueType in interface org.rcfaces.core.internal.tools.CollectionTools.IComponentValueTypeCapabilitypublic IColumnIterator listColumns()
listColumns in interface org.rcfaces.core.internal.capability.IGridComponentlistColumns in class KeyEntryComponentpublic IAdditionalInformationIterator listAdditionalInformations()
listAdditionalInformations in interface org.rcfaces.core.internal.capability.IAdditionalInformationComponentpublic void setClientAdditionalInformationFullState(String state)
public int getAdditionalInformationValuesCount()
getAdditionalInformationValuesCount in interface IAdditionalInformationProviderpublic Object getFirstAdditionalInformationValue()
getFirstAdditionalInformationValue in interface IAdditionalInformationProviderpublic Object getAdditionalInformationValues(FacesContext facesContext)
public Object[] listAdditionalInformationValues()
listAdditionalInformationValues in interface IAdditionalInformationProviderpublic ComboColumnComponent[] getSortedColumns()
public ComboColumnComponent getFirstSortedColumn()
public void setSortedColumn(ComboColumnComponent comboColumn)
public void setSortedColumns(ComboColumnComponent[] componentsColumns)
public ISortedComponent[] listSortedComponents()
public ISortedComponent[] listSortedComponents(FacesContext context)
public void showAdditionalInformation(Object rowValue)
showAdditionalInformation in interface org.rcfaces.core.internal.capability.IAdditionalInformationComponentpublic void showAdditionalInformation(int index)
showAdditionalInformation in interface org.rcfaces.core.internal.capability.IAdditionalInformationRangeComponentpublic void showAdditionalInformation(int[] indexes)
showAdditionalInformation in interface org.rcfaces.core.internal.capability.IAdditionalInformationRangeComponentpublic void showAllAdditionalInformations()
showAllAdditionalInformations in interface org.rcfaces.core.internal.capability.IAdditionalInformationComponentpublic void hideAdditionalInformation(Object rowValue)
hideAdditionalInformation in interface org.rcfaces.core.internal.capability.IAdditionalInformationComponentpublic void hideAdditionalInformation(int index)
hideAdditionalInformation in interface org.rcfaces.core.internal.capability.IAdditionalInformationRangeComponentpublic void hideAdditionalInformation(int[] indexes)
hideAdditionalInformation in interface org.rcfaces.core.internal.capability.IAdditionalInformationRangeComponentpublic void hideAllAdditionalInformations()
hideAllAdditionalInformations in interface org.rcfaces.core.internal.capability.IAdditionalInformationComponentpublic final void addAdditionalInformationListener(IAdditionalInformationListener listener)
IAdditionalInformationEventCapability
addAdditionalInformationListener in interface IAdditionalInformationEventCapabilitylistener - the selection listener to addpublic final void removeAdditionalInformationListener(IAdditionalInformationListener listener)
IAdditionalInformationEventCapability
removeAdditionalInformationListener in interface IAdditionalInformationEventCapabilitylistener - the selection listener to removepublic final FacesListener[] listAdditionalInformationListeners()
IAdditionalInformationEventCapability
listAdditionalInformationListeners in interface IAdditionalInformationEventCapabilitypublic Object getAdditionalInformationValues()
getAdditionalInformationValues in interface IAdditionalInformationProviderpublic final boolean isAdditionalInformationValuesSetted()
true if the attribute "additionalInformationValues" is set.
true if the attribute is set.public void setAdditionalInformationValues(Object additionalInformationValues)
setAdditionalInformationValues in interface IAdditionalInformationProviderpublic Class getAdditionalInformationValuesType(FacesContext facesContext)
ValueExpression, relative to the specified FacesContext.
getAdditionalInformationValuesType in interface IAdditionalInformationValuesCapabilitypublic int getClientAdditionalInformationFullState()
IClientAdditionalInformationFullStateCapability
getClientAdditionalInformationFullState in interface IClientAdditionalInformationFullStateCapabilityIClientFullStateCapability.NONE_CLIENT_FULL_STATE,
IClientFullStateCapability.ONEWAY_CLIENT_FULL_STATE,
IClientFullStateCapability.TWOWAYS_CLIENT_FULL_STATEpublic int getClientAdditionalInformationFullState(FacesContext facesContext)
getClientAdditionalInformationFullState() for more details
public final boolean isClientAdditionalInformationFullStateSetted()
true if the attribute "clientAdditionalInformationFullState" is set.
true if the attribute is set.public void setClientAdditionalInformationFullState(int clientAdditionalInformationFullState)
IClientAdditionalInformationFullStateCapability
setClientAdditionalInformationFullState in interface IClientAdditionalInformationFullStateCapabilityIClientFullStateCapability.NONE_CLIENT_FULL_STATE,
IClientFullStateCapability.ONEWAY_CLIENT_FULL_STATE,
IClientFullStateCapability.TWOWAYS_CLIENT_FULL_STATEpublic int getAdditionalInformationCardinality()
IAdditionalInformationCardinalityCapability
getAdditionalInformationCardinality in interface IAdditionalInformationCardinalityCapabilitypublic int getAdditionalInformationCardinality(FacesContext facesContext)
getAdditionalInformationCardinality() for more details
public final boolean isAdditionalInformationCardinalitySetted()
true if the attribute "additionalInformationCardinality" is set.
true if the attribute is set.public void setAdditionalInformationCardinality(int additionalInformationCardinality)
IAdditionalInformationCardinalityCapability
setAdditionalInformationCardinality in interface IAdditionalInformationCardinalityCapabilityadditionalInformationCardinality - 1:?,optional|2:*,zeroMany|3:1,one+|4:+,oneMany
default=zeroManypublic String getRowStyleClass()
getRowStyleClass in interface IRowStyleClassCapabilitypublic String getRowStyleClass(FacesContext facesContext)
getRowStyleClass() for more details
public final boolean isRowStyleClassSetted()
true if the attribute "rowStyleClass" is set.
true if the attribute is set.public void setRowStyleClass(String rowStyleClass)
setRowStyleClass in interface IRowStyleClassCapabilitypublic String getManyResultsMessage()
getManyResultsMessage in interface IPagerMessageCapabilitypublic String getManyResultsMessage(FacesContext facesContext)
getManyResultsMessage() for more details
public final boolean isManyResultsMessageSetted()
true if the attribute "manyResultsMessage" is set.
true if the attribute is set.public void setManyResultsMessage(String manyResultsMessage)
setManyResultsMessage in interface IPagerMessageCapabilitypublic String getMessage()
getMessage in interface IPagerMessageCapabilitypublic String getMessage(FacesContext facesContext)
getMessage() for more details
public final boolean isMessageSetted()
true if the attribute "message" is set.
true if the attribute is set.public void setMessage(String message)
setMessage in interface IPagerMessageCapabilitypublic String getOneResultMessage()
getOneResultMessage in interface IPagerMessageCapabilitypublic String getOneResultMessage(FacesContext facesContext)
getOneResultMessage() for more details
public final boolean isOneResultMessageSetted()
true if the attribute "oneResultMessage" is set.
true if the attribute is set.public void setOneResultMessage(String oneResultMessage)
setOneResultMessage in interface IPagerMessageCapabilitypublic String getZeroResultMessage()
getZeroResultMessage in interface IPagerMessageCapabilitypublic String getZeroResultMessage(FacesContext facesContext)
getZeroResultMessage() for more details
public final boolean isZeroResultMessageSetted()
true if the attribute "zeroResultMessage" is set.
true if the attribute is set.public void setZeroResultMessage(String zeroResultMessage)
setZeroResultMessage in interface IPagerMessageCapabilitypublic boolean isPaged()
IPagedCapability
isPaged in interface IPagedCapabilitypublic boolean isPaged(FacesContext facesContext)
isPaged() for more details
public boolean isPagedSetted()
isPagedSetted in interface IPagedCapabilitypublic void setPaged(boolean paged)
IPagedCapability
setPaged in interface IPagedCapabilitypaged - true if display by pagepublic boolean isHeaderVisible()
IHeaderVisibilityCapability
isHeaderVisible in interface IHeaderVisibilityCapabilitypublic boolean isHeaderVisible(FacesContext facesContext)
isHeaderVisible() for more details
public final boolean isHeaderVisibleSetted()
true if the attribute "headerVisible" is set.
true if the attribute is set.public void setHeaderVisible(boolean headerVisible)
IHeaderVisibilityCapability
setHeaderVisible in interface IHeaderVisibilityCapabilityheaderVisible - true if the header should be visiblepublic int getPopupWidth()
public int getPopupWidth(FacesContext facesContext)
public void setPopupWidth(int popupWidth)
public boolean isPopupWidthSetted()
true if the attribute "popupWidth" is set.
true if the attribute is set.public int getPopupHeight()
public int getPopupHeight(FacesContext facesContext)
public void setPopupHeight(int popupHeight)
public boolean isPopupHeightSetted()
true if the attribute "popupHeight" is set.
true if the attribute is set.public String getPagerStyleClass()
public String getPagerStyleClass(FacesContext facesContext)
public void setPagerStyleClass(String pagerStyleClass)
public boolean isPagerStyleClassSetted()
true if the attribute "pagerStyleClass" is set.
true if the attribute is set.public String getPagerLookId()
public String getPagerLookId(FacesContext facesContext)
public void setPagerLookId(String pagerLookId)
public boolean isPagerLookIdSetted()
true if the attribute "pagerLookId" is set.
true if the attribute is set.public String getPopupStyleClass()
public String getPopupStyleClass(FacesContext facesContext)
public void setPopupStyleClass(String popupStyleClass)
public boolean isPopupStyleClassSetted()
true if the attribute "popupStyleClass" is set.
true if the attribute is set.public String getGridStyleClass()
public String getGridStyleClass(FacesContext facesContext)
public void setGridStyleClass(String gridStyleClass)
public boolean isGridStyleClassSetted()
true if the attribute "gridStyleClass" is set.
true if the attribute is set.public String getGridLookId()
public String getGridLookId(FacesContext facesContext)
public void setGridLookId(String gridLookId)
public boolean isGridLookIdSetted()
true if the attribute "gridLookId" is set.
true if the attribute is set.public boolean isSearchFieldVisible()
public boolean isSearchFieldVisible(FacesContext facesContext)
public void setSearchFieldVisible(boolean searchFieldVisible)
public boolean isSearchFieldVisibleSetted()
true if the attribute "searchFieldVisible" is set.
true if the attribute is set.protected Set getCameliaFields()
getCameliaFields in class KeyEntryComponent
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||