File

projects/congarevenuecloud/ecommerce/src/lib/modules/catalog/classes/batch-action.model.ts

Description

Batch Action model describes a batch action object. Batch actions are actions that can be taken on several selected items.

Index

Methods

Constructor

constructor(displayLabel: string, iconName: string, actionMethod: Function)

Creates a new batch action object with the given parameters.

Parameters :
Name Type Optional Description
displayLabel string No

The string value to show on the display label.

iconName string No

The Open Iconic icon name shown on with the display label.

actionMethod Function No

The method that is fired when this action is triggered.

Methods

Public getActionMethod
getActionMethod()

Gets the action method for this batch action.

Returns : Function
Public getDisplayName
getDisplayName()

Gets the display name for this batch action.

Returns : string
Public getIconName
getIconName()

Gets the Open Iconic icon name for this batch action.

Returns : string
Public getTooltipText
getTooltipText()

Gets the tooltip text for this batch action.

Returns : string
Public getTranslationKey
getTranslationKey()
Returns : string
Public isDisabled
isDisabled()

Gets the disabled state of this batch action.

Returns : boolean
Public isVisible
isVisible()

Gets the visible state of this batch action.

Returns : boolean
Public setDisabled
setDisabled(disabled: boolean)

Setter for the disabled state of this batch action.

Parameters :
Name Type Optional Description
disabled boolean No

Disabled state of this batch action.

Returns : void
Public setTooltipText
setTooltipText(text: string)

Sets the tooltip text on this batch action when it is disabled.

Parameters :
Name Type Optional Description
text string No

Text to display on the tooltip.

Returns : void
Public setVisible
setVisible(visible: boolean)

Setter for the visible state of this batch action.

Parameters :
Name Type Optional Description
visible boolean No

Visible state of this batch action.

Returns : void

results matching ""

    No results matching ""