org.broadleafcommerce.openadmin.web.form.component

Class ListGridAction

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	actionUrlOverride
static String	ADD
protected Boolean	allCapable
protected String	buttonClass
protected String	displayText
protected Boolean	forListGridReadOnly
static String	GEN_SKUS
protected String	iconClass
static String	REMOVE
static String	REORDER
protected Boolean	singleActionOnly
static String	UPDATE
protected String	urlPostfix
static String	VIEW

Constructor Summary

Constructors

Constructor and Description
ListGridAction(String actionId)

Method Summary

Methods

Modifier and Type	Method and Description
ListGridAction	clone()
String	getActionId() Returns an Id that controllers can use to manipulate this action.
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	getSingleActionOnly()
String	getUrlPostfix()
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	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	withActionUrlOverride(String actionUrlOverride)
ListGridAction	withAllCapable(Boolean allCapable)
ListGridAction	withButtonClass(String buttonClass)
ListGridAction	withDisplayText(String displayText)
ListGridAction	withForListGridReadOnly(Boolean forListGridReadOnly)
ListGridAction	withIconClass(String iconClass)
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

REORDER

public static final String REORDER

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

VIEW

public static final String VIEW

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

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)}

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)}

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 -

clone

public ListGridAction clone()

Overrides:

clone in class Object