class sap.ui.ux3.Feeder

Control sample: sap.ui.ux3.Feeder
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/ux3/Feeder
Application Component: CA-UI5-CTR

This feed control flavor represents a lean common feed, or a comment feed, with a text commit function. The control can be used stand alone or in a multiple way, and generally would be integrated directly into a UIArea.


Constructor

Constructor for a new Feeder.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.

new sap.ui.ux3.Feeder(sId?, mSettings?)
Param Type Default Value Description
sId? string

id for the new control, generated automatically if no id is given

mSettings? object

initial settings for the new control


Properties

Name Type Default Value Description
placeholderText string

This property could be used for costum placeholder. If it is not set, the default text is used.

Visibility: public
text string

The text for the Feeder. @References are supported.

Visibility: public
thumbnailSrc sap.ui.core.URI

URL to the thumb nail image This property is optional if the feeder is a sub-control of a feed or a feedChunk control. In this case the value of the feed or feddChunk control is used if it's not set. So it must be only set once on the feed or feedChunk control.

Visibility: public
type sap.ui.ux3.FeederType Large

Type and size of the Feeder

Visibility: public

Events Overview

Event Description
submit

Event is fired when the entered text is submitted

submit

Event is fired when the entered text is submitted

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
text string

The text that is submitted


Methods Overview

Method Description
attachSubmit

Attaches event handler fnFunction to the submit event of this sap.ui.ux3.Feeder.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.ux3.Feeder itself.

Event is fired when the entered text is submitted

detachSubmit

Detaches event handler fnFunction from the submit event of this sap.ui.ux3.Feeder.

The passed function and listener object must match the ones used for event registration.

sap.ui.ux3.Feeder.extend

Creates a new subclass of class sap.ui.ux3.Feeder with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.Control.extend.

fireSubmit

Fires event submit to attached listeners.

sap.ui.ux3.Feeder.getMetadata

Returns a metadata object for class sap.ui.ux3.Feeder.

getPlaceholderText

Gets current value of property placeholderText.

This property could be used for costum placeholder. If it is not set, the default text is used.

getText

Gets current value of property text.

The text for the Feeder. @References are supported.

getThumbnailSrc

Gets current value of property thumbnailSrc.

URL to the thumb nail image This property is optional if the feeder is a sub-control of a feed or a feedChunk control. In this case the value of the feed or feddChunk control is used if it's not set. So it must be only set once on the feed or feedChunk control.

getType

Gets current value of property type.

Type and size of the Feeder

Default value is Large.

setPlaceholderText

Sets a new value for property placeholderText.

This property could be used for costum placeholder. If it is not set, the default text is used.

When called with a value of null or undefined, the default value of the property will be restored.

setText

Sets a new value for property text.

The text for the Feeder. @References are supported.

When called with a value of null or undefined, the default value of the property will be restored.

setThumbnailSrc

Sets a new value for property thumbnailSrc.

URL to the thumb nail image This property is optional if the feeder is a sub-control of a feed or a feedChunk control. In this case the value of the feed or feddChunk control is used if it's not set. So it must be only set once on the feed or feedChunk control.

When called with a value of null or undefined, the default value of the property will be restored.

setType

Sets a new value for property type.

Type and size of the Feeder

When called with a value of null or undefined, the default value of the property will be restored.

Default value is Large.

attachSubmit

Attaches event handler fnFunction to the submit event of this sap.ui.ux3.Feeder.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.ux3.Feeder itself.

Event is fired when the entered text is submitted

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.ux3.Feeder itself

detachSubmit

Detaches event handler fnFunction from the submit event of this sap.ui.ux3.Feeder.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

sap.ui.ux3.Feeder.extend

Creates a new subclass of class sap.ui.ux3.Feeder with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.Control.extend.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

fireSubmit

Fires event submit to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

text string

The text that is submitted

sap.ui.ux3.Feeder.getMetadata

Returns a metadata object for class sap.ui.ux3.Feeder.

getPlaceholderText

Gets current value of property placeholderText.

This property could be used for costum placeholder. If it is not set, the default text is used.

getText

Gets current value of property text.

The text for the Feeder. @References are supported.

getThumbnailSrc

Gets current value of property thumbnailSrc.

URL to the thumb nail image This property is optional if the feeder is a sub-control of a feed or a feedChunk control. In this case the value of the feed or feddChunk control is used if it's not set. So it must be only set once on the feed or feedChunk control.

getType

Gets current value of property type.

Type and size of the Feeder

Default value is Large.

setPlaceholderText

Sets a new value for property placeholderText.

This property could be used for costum placeholder. If it is not set, the default text is used.

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
sPlaceholderText string

New value for property placeholderText

setText

Sets a new value for property text.

The text for the Feeder. @References are supported.

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
sText string

New value for property text

setThumbnailSrc

Sets a new value for property thumbnailSrc.

URL to the thumb nail image This property is optional if the feeder is a sub-control of a feed or a feedChunk control. In this case the value of the feed or feddChunk control is used if it's not set. So it must be only set once on the feed or feedChunk control.

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
sThumbnailSrc sap.ui.core.URI

New value for property thumbnailSrc

setType

Sets a new value for property type.

Type and size of the Feeder

When called with a value of null or undefined, the default value of the property will be restored.

Default value is Large.

Param Type DefaultValue Description
sType sap.ui.ux3.FeederType Large

New value for property type