ListGridAction (BroadleafCommerce Open Admin Platform 5.2.0-RC2 API)

java.lang.Object
- org.broadleafcommerce.openadmin.web.form.component.ListGridAction

All Implemented Interfaces:

Cloneable
```
public class ListGridAction
extends Object
implements Cloneable
```
Buttons to display on the frontend for a list grid. These will be displayed at the top of the ListGrid that they are related to.

Author:

Andre Azzolini (aazzolini)

See Also:

ListGrid#addRowAction(ListGridAction)}, ListGrid#addToolbarAction(ListGridAction)}

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`actionId`
`protected String`	`actionTargetEntity`
`protected String`	`actionUrlOverride`
`static String`	`ADD`
`protected Boolean`	`allCapable`
`static String`	`ASSET_ADD`
`protected String`	`buttonClass`
`protected String`	`displayText`
`static String`	`EDIT`
`protected Boolean`	`forListGridReadOnly`
`static String`	`GEN_SKUS`
`protected String`	`iconClass`
`static String`	`MANUAL_FETCH`
`static String`	`MULTI_SELECT`
`static String`	`REMOVE`
`protected Boolean`	`requiresNonEmptyGrid`
`static String`	`SINGLE_SELECT`
`protected Boolean`	`singleActionOnly`
`static String`	`TREE_ADD`
`static String`	`TREE_JUMP_TO_CONTEXT`
`static String`	`UPDATE`
`protected String`	`urlPostfix`
`static String`	`VIEW`

Constructor Summary

Constructors
Constructor and Description

ListGridAction(String actionId)

Constructors
Constructor and Description
`ListGridAction(String actionId)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ListGridAction`	`clone()`
`String`	`getActionId()` Returns an Id that controllers can use to manipulate this action.
`String`	`getActionTargetEntity()` Returns a fully qualified ceiling entity that this listgrid action targets
`String`	`getActionUrlOverride()` Gets the manual override for the data-actionurl attribute on an action.
`Boolean`	`getAllCapable()`
`String`	`getButtonClass()`
`String`	`getDisplayText()`
`Boolean`	`getForListGridReadOnly()`
`String`	`getIconClass()`
`Boolean`	`getRequiresNonEmptyGrid()` If a list grid action should be disabled unless there are one or more rows in the grid, this property should be true
`Boolean`	`getSingleActionOnly()`
`String`	`getUrlPostfix()`
`void`	`setActionTargetEntity(String actionTargetEntity)` This is used to specify a target entityType for use in listgrid actions
`void`	`setActionUrlOverride(String actionUrlOverride)` This is a manual override for the data-actionurl attribute for an listgrid action.
`void`	`setAllCapable(Boolean allCapable)` Sets whether or not the given list grid action is capable of acting on rows even when none are selected
`void`	`setButtonClass(String buttonClass)` Main intent is for the button class to be used in a JQuery selector for giving this button a click action.
`void`	`setDisplayText(String displayText)`
`void`	`setForListGridReadOnly(Boolean forListGridReadOnly)`
`void`	`setIconClass(String iconClass)` Icon classes are displayed next to the `getDisplayText()`.
`void`	`setRequiresNonEmptyGrid(Boolean requiresNonEmptyGrid)`
`void`	`setSingleActionOnly(Boolean singleActionOnly)` Sets where or not this action can only be performed on a single item.
`void`	`setUrlPostfix(String urlPostfix)` This means different things depending on where this action is on the list grid.
`ListGridAction`	`withActionTargetEntity(String actionTargetEntity)`
`ListGridAction`	`withActionUrlOverride(String actionUrlOverride)`
`ListGridAction`	`withAllCapable(Boolean allCapable)`
`ListGridAction`	`withButtonClass(String buttonClass)`
`ListGridAction`	`withDisplayText(String displayText)`
`ListGridAction`	`withForListGridReadOnly(Boolean forListGridReadOnly)`
`ListGridAction`	`withIconClass(String iconClass)`
`ListGridAction`	`withRequiresNonEmptyGrid(Boolean requiresNonEmptyGrid)`
`ListGridAction`	`withSingleActionOnly(Boolean singleActionOnly)`
`ListGridAction`	`withUrlPostfix(String urlPostfix)`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ADD
```
public static final String ADD
```
    See Also:
    
    Constant Field Values
  - GEN_SKUS
```
public static final String GEN_SKUS
```
    See Also:
    
    Constant Field Values
  - REMOVE
```
public static final String REMOVE
```
    See Also:
    
    Constant Field Values
  - UPDATE
```
public static final String UPDATE
```
    See Also:
    
    Constant Field Values
  - MANUAL_FETCH
```
public static final String MANUAL_FETCH
```
    See Also:
    
    Constant Field Values
  - VIEW
```
public static final String VIEW
```
    See Also:
    
    Constant Field Values
  - EDIT
```
public static final String EDIT
```
    See Also:
    
    Constant Field Values
  - TREE_ADD
```
public static final String TREE_ADD
```
    See Also:
    
    Constant Field Values
  - TREE_JUMP_TO_CONTEXT
```
public static final String TREE_JUMP_TO_CONTEXT
```
    See Also:
    
    Constant Field Values
  - SINGLE_SELECT
```
public static final String SINGLE_SELECT
```
    See Also:
    
    Constant Field Values
  - MULTI_SELECT
```
public static final String MULTI_SELECT
```
    See Also:
    
    Constant Field Values
  - ASSET_ADD
```
public static final String ASSET_ADD
```
    See Also:
    
    Constant Field Values
  - buttonClass
```
protected String buttonClass
```
  - urlPostfix
```
protected String urlPostfix
```
  - iconClass
```
protected String iconClass
```
  - displayText
```
protected String displayText
```
  - actionId
```
protected String actionId
```
  - forListGridReadOnly
```
protected Boolean forListGridReadOnly
```
  - actionUrlOverride
```
protected String actionUrlOverride
```
  - allCapable
```
protected Boolean allCapable
```
  - singleActionOnly
```
protected Boolean singleActionOnly
```
  - actionTargetEntity
```
protected String actionTargetEntity
```
  - requiresNonEmptyGrid
```
protected Boolean requiresNonEmptyGrid
```
- Constructor Detail
  - ListGridAction
```
public ListGridAction(String actionId)
```
- Method Detail
  - withButtonClass
```
public ListGridAction withButtonClass(String buttonClass)
```
    See Also:
    
    #setButtonClass(String)}
  - withUrlPostfix
```
public ListGridAction withUrlPostfix(String urlPostfix)
```
    See Also:
    
    #setUrlPostfix(String)}
  - withIconClass
```
public ListGridAction withIconClass(String iconClass)
```
    See Also:
    
    #setIconClass(String)}
  - withRequiresNonEmptyGrid
```
public ListGridAction withRequiresNonEmptyGrid(Boolean requiresNonEmptyGrid)
```
    See Also:
    
    #setRequiresNonEmptyGrid(Boolean)}
  - withDisplayText
```
public ListGridAction withDisplayText(String displayText)
```
    See Also:
    
    #setDisplayText(String)}
  - withForListGridReadOnly
```
public ListGridAction withForListGridReadOnly(Boolean forListGridReadOnly)
```
  - withActionUrlOverride
```
public ListGridAction withActionUrlOverride(String actionUrlOverride)
```
    See Also:
    
    #setActionUrlOverride(String)}
  - withAllCapable
```
public ListGridAction withAllCapable(Boolean allCapable)
```
    See Also:
    
    #setAllCapable(Boolean)}
  - withSingleActionOnly
```
public ListGridAction withSingleActionOnly(Boolean singleActionOnly)
```
    See Also:
    
    #setSingleActionOnly(Boolean)}
  - withActionTargetEntity
```
public ListGridAction withActionTargetEntity(String actionTargetEntity)
```
    See Also:
    
    #setActionTargetEntity(String)}
  - getButtonClass
```
public String getButtonClass()
```
  - getForListGridReadOnly
```
public Boolean getForListGridReadOnly()
```
  - setButtonClass
```
public void setButtonClass(String buttonClass)
```
    Main intent is for the button class to be used in a JQuery selector for giving this button a click action. You could technically also apply additional styling to this anchor but is not usually recommended.
    An example JQuery selector would look like: $('body').on('click', 'button.some-class', function() { doSomeFunction() });
    
    Parameters:
    
    buttonClass -
  - getUrlPostfix
```
public String getUrlPostfix()
```
  - setUrlPostfix
```
public void setUrlPostfix(String urlPostfix)
```
    This means different things depending on where this action is on the list grid.
    - If this is a toolbar action: this postfix will be appended onto the end of ListGrid.getPath() and presented as a 'data-actionurl' attribute for the button
    - This postfix will also be presented as a 'data-urlpostfix' attribute on the button
    Parameters:
    
    urlPostfix -
  - getIconClass
```
public String getIconClass()
```
  - setIconClass
```
public void setIconClass(String iconClass)
```
    Icon classes are displayed next to the getDisplayText(). These can technically be whatever you like and you can use css selectors to style them accordingly. That said, Broadleaf uses the FontAwesome set of icons out of the box, and it is intended that iconClass is an icon from the FontAwesome framework. To see the icons that are included, check out http://fortawesome.github.com/Font-Awesome/#icons-new
    
    Parameters:
    
    iconClass -
  - getDisplayText
```
public String getDisplayText()
```
  - setDisplayText
```
public void setDisplayText(String displayText)
```
  - setForListGridReadOnly
```
public void setForListGridReadOnly(Boolean forListGridReadOnly)
```
  - getActionUrlOverride
```
public String getActionUrlOverride()
```
    Gets the manual override for the data-actionurl attribute on an action.
    
    Returns:
  - setActionUrlOverride
```
public void setActionUrlOverride(String actionUrlOverride)
```
    This is a manual override for the data-actionurl attribute for an listgrid action. The data-actionurl attribute on a button is normally automatically computed by appending the postfix URL to the path of the list grid
    
    Parameters:
    
    actionUrlOverride -
  - getActionId
```
public String getActionId()
```
    Returns an Id that controllers can use to manipulate this action. For example, if a Controller wanted to not show the "Add" button that the system shows by default, they could remove the action with an id of "ADD".
    
    Returns:
  - getAllCapable
```
public Boolean getAllCapable()
```
    Returns:
    
    whether or not the given list grid action is capable of acting on rows even when none are selected
  - setAllCapable
```
public void setAllCapable(Boolean allCapable)
```
    Sets whether or not the given list grid action is capable of acting on rows even when none are selected
    
    Parameters:
    
    allCapable -
  - getSingleActionOnly
```
public Boolean getSingleActionOnly()
```
    Returns:
    
    whether or not this action can be performed only on a single item, regardless of whether the list grid is multi-select capable or not.
  - setSingleActionOnly
```
public void setSingleActionOnly(Boolean singleActionOnly)
```
    Sets where or not this action can only be performed on a single item. This is used to override multi-select list grids for certain actions.
    
    Parameters:
    
    singleActionOnly -
  - getActionTargetEntity
```
public String getActionTargetEntity()
```
    Returns a fully qualified ceiling entity that this listgrid action targets
    
    Returns:
  - setActionTargetEntity
```
public void setActionTargetEntity(String actionTargetEntity)
```
    This is used to specify a target entityType for use in listgrid actions
    
    Parameters:
    
    actionTargetEntity -
  - getRequiresNonEmptyGrid
```
public Boolean getRequiresNonEmptyGrid()
```
    If a list grid action should be disabled unless there are one or more rows in the grid, this property should be true
    
    Returns:
  - setRequiresNonEmptyGrid
```
public void setRequiresNonEmptyGrid(Boolean requiresNonEmptyGrid)
```
  - clone
```
public ListGridAction clone()
```
    Overrides:
    
    clone in class Object

Class ListGridAction

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ADD

GEN_SKUS

REMOVE

UPDATE

MANUAL_FETCH

VIEW

EDIT

TREE_ADD

TREE_JUMP_TO_CONTEXT

SINGLE_SELECT

MULTI_SELECT

ASSET_ADD

buttonClass

urlPostfix

iconClass

displayText

actionId

forListGridReadOnly

actionUrlOverride

allCapable

singleActionOnly

actionTargetEntity

requiresNonEmptyGrid

Constructor Detail

ListGridAction

Method Detail

withButtonClass

withUrlPostfix

withIconClass

withRequiresNonEmptyGrid

withDisplayText

withForListGridReadOnly

withActionUrlOverride

withAllCapable

withSingleActionOnly

withActionTargetEntity

getButtonClass

getForListGridReadOnly

setButtonClass

getUrlPostfix

setUrlPostfix

getIconClass

setIconClass

getDisplayText

setDisplayText

setForListGridReadOnly

getActionUrlOverride

setActionUrlOverride

getActionId

getAllCapable

setAllCapable

getSingleActionOnly

setSingleActionOnly

getActionTargetEntity

setActionTargetEntity

getRequiresNonEmptyGrid

setRequiresNonEmptyGrid

clone