Enables column resizing for the sap.m.Table
. This plugin can be added to the control via its dependents
aggregation and there must only be 1 instance of the plugin per control.
Constructor for a new ColumnResizer plugin.
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.m.plugins.ColumnResizer(sId?, mSettings?)
Param | Type | Default Value | Description |
---|---|---|---|
sId? | string | ID for the new |
|
mSettings? | object | Initial settings for the |
Event | Description |
---|---|
columnResize |
This event is fired when the column is resized. Listeners may prevent the default action of this event by calling the |
This event is fired when the column is resized.
Listeners may prevent the default action of this event by calling the preventDefault
method on the event object.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
column | sap.ui.core.Element |
The column being resized. |
width | sap.ui.core.CSSSize |
The new width of the column. |
Method | Description |
---|---|
attachColumnResize |
Attaches event handler When called, the context of the event handler (its This event is fired when the column is resized. |
detachColumnResize |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
sap.m.plugins.ColumnResizer.extend |
Creates a new subclass of class sap.m.plugins.ColumnResizer with name
|
fireColumnResize |
Fires event columnResize to attached listeners. Listeners may prevent the default action of this event by calling the |
sap.m.plugins.ColumnResizer.getMetadata |
Returns a metadata object for class sap.m.plugins.ColumnResizer. |
startResizing |
Displays the resize handle for the provided column |
Attaches event handler fnFunction
to the columnResize event of this sap.m.plugins.ColumnResizer
.
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.m.plugins.ColumnResizer
itself.
This event is fired when the column is resized.
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 |
Detaches event handler fnFunction
from the columnResize event of this sap.m.plugins.ColumnResizer
.
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 |
Creates a new subclass of class sap.m.plugins.ColumnResizer 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.Element.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 |
Fires event columnResize to attached listeners.
Listeners may prevent the default action of this event by calling the preventDefault
method on the event object. The return value of this method indicates whether the default action should be executed.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
column | sap.ui.core.Element |
The column being resized. |
|
width | sap.ui.core.CSSSize |
The new width of the column. |
Returns a metadata object for class sap.m.plugins.ColumnResizer.
Displays the resize handle for the provided column DOM
reference.
Param | Type | DefaultValue | Description |
---|---|---|---|
oDomRef | HTMLElement |
column DOM reference |