|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Object | +--DataWidget
This is the basic class that represents a DataWidget.
This class exposes main functions to manipulate a DataWidget from a custom DataWidget renderer
or any API function called by the DreamFace Engine when a DataWidget needs to be displayed or
personalized.
Defined in dfDataWidget.js
| Field Summary | |
Object |
data
|
Object |
dataAsText
|
Object |
dataSource
|
Object |
dataSourceName
|
Object |
dataSourceParameters
|
Object |
directory
|
Object |
name
|
Object |
parameters
|
Object |
preferences
|
Object |
template
|
Object |
title
|
Object |
titleVisibility
|
Object |
type
|
Object |
widgetClass
|
| Constructor Summary | |
DataWidget( <Document> dataWidgetDefinition )
Construct a new DataWidget object. |
|
| Method Summary | |
void
|
addContent( <String> fragment )
Add an xHTML fragment (DIV, IFRAME, TABLE, ...) to the DataWidget's content. |
void
|
clearContent()
Clear the DataWidget's content. |
void
|
construct( <Document> dataWidgetDefinition )
Internal Function. |
void
|
executeDataSource()
Execute the DataSource associated with the DataWidget. |
Document
|
getData()
Return the Data resulting from the DataSource execution. |
String
|
getDataAsText()
Return the Data resulting from the DataSource execution as Text. |
String
|
getDataSourceName()
Return the DataSource name associated to the DataWidget instance. |
Document
|
getDataSourceParameters()
Return the DataSource parameters used by the DataWidget when executing the DataSource. |
String
|
getDirectory()
Return the directory attached to the DataWidget |
String
|
getDirectoryComponent()
Return the directory component (Flex or XForms) attached to the DataWidget |
String
|
getDirectoryComponentBinding()
Return the directory component (Flex or XForms) binding source |
int
|
getHeight()
Return the DataWidget height |
String
|
getName()
Return the name (i.e the identifier) of the DataWidget instance. |
String
|
getParameter(<String> paramName)
Return the parameter value of the DataWidget instance. |
Document
|
getParameters()
Return the parameters of the DataWidget instance. |
String
|
getParametersAsText()
Return the parameters of the DataWidget instance as Text. |
Document
|
getPreferences()
Return the preferences of the DataWidget instance. |
String
|
getPreferencesAsText()
Return the preferences of the DataWidget instance as Text. |
Document
|
getRenderer()
Retrieve the DataWidget JavaScript renderer associated to the template. |
Document
|
getTemplate()
Return the DataWidget template used to cratethe DataWidget instance. |
String
|
getTemplateName()
Return the name of the DataWidget template used to cratethe DataWidget instance. |
String
|
getTitle()
Return the title of the DataWidget instance. |
String
|
getTitleVisibility()
Return a String value ("true" or "false") that defines if the DataWidget's title bar is visible. |
Document
|
getWidgetClass()
Return the DataWidget class associated to the DataWidget instance. |
String
|
getWidgetClassName()
Return the name of the DataWidget class associated to the DataWidget instance. |
int
|
getWidth()
Return the DataWidget width |
void
|
loadData()
Retrieve Data according to a DataSource definition. |
Document
|
loadTemplate( <String> template )
Load the DataWidget template. |
void
|
redraw()
Clear the DataWidget and recall the renderer. |
void
|
refreshData( callbackFunction )
Retrieve Data according to a DataSource definition. |
void
|
reload()
Clear the DataWidget preferences and reload the DataWidget content (implies a reload of preferences). |
void
|
savePreferences(<String> callback)
Save preferences of the DataWidget. |
void
|
setData( <Document> data )
Set the Data to be displayed by the DataWidget. |
void
|
setDataAsText( <String> dataAsText )
Set the Data as Text to be displayed by the DataWidget. |
void
|
setDataSourceName( <String> dataSourceName )
Set the DataSource name. |
void
|
setDataSourceParameter( <String> paramName, <String> paramValue )
Set the value of one of the DataSource parameters used by the DataWidget when executing the DataSource. |
void
|
setDataSourceParameters( <Document> parameters )
Set the DataSource parameters used by the DataWidget when executing the DataSource. |
void
|
setDataSourceRequest( <String> request )
Set the DataSource Request. |
void
|
setDirectory( <String> directory )
Attach a directory to the DataWidget |
void
|
setDirectoryComponent( <String> component )
Attach a directory component (Flex or XForms) to the DataWidget |
void
|
setName( <String> name )
Set the DataWidget name. |
void
|
setPreference(<String> name, <String> value)
Set a DataWidget preference. |
void
|
setTemplate( <String> template )
Set the DataWidget template. |
void
|
setTitle( <String> title )
Set the DataWidget title. |
void
|
setTitleVisibility( <String> titleVisibility )
Define if the DataWidget title bar is visible. |
void
|
setWidgetClassName( <String> widgetClassName )
Set the DataWidget class name associated to the DataWidget instance. |
| Field Detail |
Object data
Object dataAsText
Object dataSource
Object dataSourceName
Object dataSourceParameters
Object directory
Object name
Object parameters
Object preferences
Object template
Object title
Object titleVisibility
Object type
Object widgetClass
| Constructor Detail |
DataWidget( <Document> dataWidgetDefinition )
dataWidgetDefinition - . The DataWidget Definition.
| Method Detail |
void addContent( <String> fragment )
fragment - . The XHTML fragment to be added.
void clearContent()
void construct( <Document> dataWidgetDefinition )
dataWidgetDefinition - . The DataWidget Definition.
void executeDataSource()
Document getData()
String getDataAsText()
String getDataSourceName()
Document getDataSourceParameters()
String getDirectory()
String getDirectoryComponent()
String getDirectoryComponentBinding()
int getHeight()
String getName()
String getParameter(<String> paramName)
paramName - . The parameter name.
Document getParameters()
String getParametersAsText()
Document getPreferences()
String getPreferencesAsText()
Document getRenderer()
Document getTemplate()
String getTemplateName()
String getTitle()
String getTitleVisibility()
Document getWidgetClass()
String getWidgetClassName()
int getWidth()
void loadData()
Document loadTemplate( <String> template )
template - . The DataWidget template name.
void redraw()
void refreshData( callbackFunction )
void reload()
void savePreferences(<String> callback)
callback - . A Callback function.
void setData( <Document> data )
data - . The document object related to the data.
void setDataAsText( <String> dataAsText )
dataAsText - . The text related to the data.
void setDataSourceName( <String> dataSourceName )
dataSourceName - . The DataSource name.
void setDataSourceParameter( <String> paramName, <String> paramValue )
paramName - . The DataSource parameter name.
paramValue - . The DataSource parameter value.
void setDataSourceParameters( <Document> parameters )
parameters - . The DataSource parameters document object.
void setDataSourceRequest( <String> request )
request - . The DataSource request (the request is added to the DataSource location+port).
void setDirectory( <String> directory )
directory - . The directory name.
void setDirectoryComponent( <String> component )
component - . The component's reference.
void setName( <String> name )
name - . The new name of the DataWidget instance.
void setPreference(<String> name, <String> value)
name - . The property name.
value - . The property value.
void setTemplate( <String> template )
template - . The DataWidget template name.
void setTitle( <String> title )
title - . The new title of the DataWidget instance.
void setTitleVisibility( <String> titleVisibility )
titleVisibility - . The new visibility status of the DataWidget title bar.
void setWidgetClassName( <String> widgetClassName )
widgetClassName - . The DataWidget class name.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||