org.rcfaces.core.component.capability
Interface IClientDataCapability

All Known Implementing Classes:

AbstractBasicComponent, AbstractCalendarComponent, AbstractCommandComponent, AbstractConverterCommandComponent, AbstractDataComponent, AbstractGridComponent, AbstractInputComponent, AbstractItemComponent, AbstractMenuComponent, AbstractMessageComponent, AbstractMessagesComponent, AbstractOutputComponent, AbstractSelectManyComponent, BoxComponent, ButtonComponent, CalendarComponent, CardBoxComponent, CardComponent, CheckButtonComponent, ClientFacesMessage, ComboComponent, ComboGridComponent, ComponentsGridComponent, ComponentsListComponent, CustomButtonComponent, DataGridComponent, DateChooserComponent, DateEntryComponent, DateItemComponent, ExpandableItemComponent, ExpandBarComponent, ExternalBoxComponent, FieldSetComponent, HelpButtonComponent, HiddenValueComponent, HyperLinkComponent, ImageButtonComponent, ImageCheckButtonComponent, ImageComboComponent, ImageComponent, ImagePagerButtonComponent, ImageRadioButtonComponent, ImageResetButtonComponent, ImageSubmitButtonComponent, ItemsListComponent, ItemsToolFolderComponent, KeyEntryComponent, KeyLabelComponent, ListComponent, MenuBarComponent, MenuCheckItemComponent, MenuItemComponent, MenuRadioItemComponent, MessageComponent, MessageFieldSetComponent, MessagesComponent, NumberEntryComponent, PagerComponent, PasswordEntryComponent, ProgressBarComponent, RadioButtonComponent, ResetButtonComponent, SelectItemComponent, ServiceComponent, SpinnerComponent, StyledMessageComponent, StyledTextComponent, SubmitButtonComponent, SuggestTextEntryComponent, TabbedPaneComponent, TabComponent, TabNamingContainerComponent, TextAreaComponent, TextComponent, TextEditorComboComponent, TextEditorComponent, TextEditorImageButtonComponent, TextEditorToolFolderComponent, TextEntryComponent, TimeEntryComponent, ToolBarComponent, ToolFolderComponent, ToolItemComponent, TreeComponent, TreeNodeComponent, UIImageItemComponent, ViewErrorListenerComponent

public interface IClientDataCapability

A tag used to associate data to a view.

Version:

$Revision: 1.18 $ $Date: 2011/06/16 09:29:40 $

Author:

Olivier Oeuillot (latest modification by $Author: jbmeslin $)

Method Summary

String	getClientData(String name) Retrieves the data associated to a variable
int	getClientDataCount() Returns the number of variable associated to the component.
Map	getClientDataMap() Returns a map containing the couples variable-data
String[]	listClientDataKeys() Returns the list of variable associated to the component.
String	removeClientData(String name) Removes the variable name and the data associated to it
String	setClientData(String name, String data) Associates data to variable name.

Method Detail

setClientData

String setClientData(String name,
                     String data)

Associates data to variable name.

Parameters:

name - the variable to associate data to

data - the data to associate to the variable

Returns:

the data previously associated with the variable (empty if none)

removeClientData

String removeClientData(String name)

Removes the variable name and the data associated to it

Parameters:

name - the variable to associate data to

Returns:

the data that was associated to the variable

getClientData

String getClientData(String name)

Retrieves the data associated to a variable

Parameters:

name - the variable to associate data to

Returns:

the data associated to the variable

listClientDataKeys

String[] listClientDataKeys()

Returns the list of variable associated to the component.

Returns:

a list of variables

getClientDataCount

int getClientDataCount()

Returns the number of variable associated to the component.

Returns:

number of variable

getClientDataMap

Map getClientDataMap()

Returns a map containing the couples variable-data

Returns:

a map