Package name.matthewgreet.strutscommons.action

Interface BrowserTabAware2

All Known Implementing Classes:

AbstractActionSupport, AbstractFormDrivenActionSupport, AbstractJsonServerAction, AbstractViewActionSupport

public interface BrowserTabAware2

Interface for Struts 2 actions that accept a browser tab id.

Method Summary

Modifier and Type	Method	Description
default void	copyAttributesFromOldTabToNewTab(BrowserTabSession oldBrowserTabSession, BrowserTabSession newBrowserTabSession, Set<String> attributeIgnores, Set<String> attributeFailures)	May be overridden to manually copy or clone tab-specific attributes from the page of an old tab to a new tab whenever the user opens a hyperlink in a new browser tab.
BrowserTabSession	getBrowserTabSession()	Returns browser tab specific session.
default void	handleAttributeFailures(BrowserTabSession oldBrowserTabSession, BrowserTabSession newBrowserTabSession, Set<String> attributeFailures)	May be overridden to handle attributes that failed manual or automatic copying or cloning.
void	setBrowserTabSession(BrowserTabSession value)	Sets browser tab specific session.

Method Details

copyAttributesFromOldTabToNewTab

default void copyAttributesFromOldTabToNewTab(BrowserTabSession oldBrowserTabSession,
 BrowserTabSession newBrowserTabSession,
 Set<String> attributeIgnores,
 Set<String> attributeFailures)

May be overridden to manually copy or clone tab-specific attributes from the page of an old tab to a new tab whenever the user opens a hyperlink in a new browser tab. Any attributes not copied and their names not added to attributeIgnores will be automatically copied or cloned later.

Parameters:

oldBrowserTabSession - Session used by old tab.

newBrowserTabSession - Session used by new tab.

attributeIgnores - Add names of attributes that should not be automatically copied or cloned.

attributeFailures - Add names of attributes where manual copying or cloning failed.

handleAttributeFailures

default void handleAttributeFailures(BrowserTabSession oldBrowserTabSession,
 BrowserTabSession newBrowserTabSession,
 Set<String> attributeFailures)

May be overridden to handle attributes that failed manual or automatic copying or cloning.

Parameters:

oldBrowserTabSession - Session used by old tab.

newBrowserTabSession - Session used by new tab.

attributeFailures - Names of attributes where copying or cloning failed.

getBrowserTabSession

BrowserTabSession getBrowserTabSession()

Returns browser tab specific session.

setBrowserTabSession

void setBrowserTabSession(BrowserTabSession value)

Sets browser tab specific session.