jb.gwt_main_modules.base_widgets.client.js_api

Class SelectionApiPublisher

java.lang.Object

jb.gwt_main_modules.base_widgets.client.js_api.SelectionApiPublisher

public class SelectionApiPublisher
extends java.lang.Object

Methods for dealing with the user's current selection (get/set/changes), cart based selections, and saved selection management.

All methods are located in a sub object at window.MBAPI.selection

(window.MBAPI.selection.saveScratchBasket(theWidgetId, theTabId, theName, theDescription, theFromDate, theToDate, theDownloadLimit, theIsPublic, thePosAction) for example)

Constructor Summary

Constructors

Constructor and Description
SelectionApiPublisher()

Method Summary

Modifier and Type	Method and Description
static void	addCurrentSelectionToScratchBasket() Add the current selection's contents into our current scratch basket
static void	addToSavedSelection(java.lang.String theResolverString, int theSavedSelectionId, jb.gwt_main_modules.base_widgets.client.DefaultCallback theCallback) Add items defined by the resolver string to the save selection
static void	addToSavedSelectionBundle(int theSelectionBundle, jb.gwt_main_modules.base_widgets.client.DefaultCallback theCallback)
static java.util.List<java.lang.Integer>	asIntegerList(com.google.gwt.core.client.JsArrayInteger theArray) Returns a List of Integer type for the specified JsArrayInteger.
static void	changeSelection(com.google.gwt.core.client.JsArrayInteger theAssetIdsToAdd, com.google.gwt.core.client.JsArrayInteger theAssetIdsToRemove, boolean theKeepCurrentSelection, jb.gwt_main_modules.base_widgets.client.DefaultCallback theCallback) Changes the current selection by selecting the assets to add and deselecting the assets to remove.
static void	clearCurrentCart() Remove the current tabs assets
static void	clearCurrentSelection(jb.gwt_main_modules.base_widgets.client.DefaultCallback theCallback) Clear all assets in the current selection
static void	createSelection(java.lang.String theName, java.lang.String theDescription, boolean thePublic, java.lang.String theResolverString, jb.gwt_main_modules.base_widgets.client.DefaultCallback theCallback) Create a new selection with whatever is in the current selection.
static void	deleteSavedSelection(int theSelectionId, jb.gwt_main_modules.base_widgets.client.DefaultCallback theCallback) remove a saved selection
static void	doFetchAssetIds(java.lang.String theResolverUrl, int thePage, int thePageSize, com.google.gwt.core.client.JavaScriptObject theCallback) This is not a JavaScript callable method
static void	doGetCurrentPage(com.google.gwt.core.client.JavaScriptObject theCallback) Internal method for calling server and doing get the current page.
static void	doGetNextPage(com.google.gwt.core.client.JavaScriptObject theCallback) Internal method for calling server and doing get the next page.
static void	doGetPreviousPage(com.google.gwt.core.client.JavaScriptObject theCallback) Internal method for calling server and doing get the previous page.
static void	fetchAssetIds(java.lang.String theResolverUrl, int thePage, int thePageSize, jb.gwt_main_modules.base_widgets.client.DefaultCallback theCallback) Fetch list of asset ids from the url with page and offset
static void	getCurrentPage(jb.gwt_main_modules.base_widgets.client.events.selectionchangelistener.SelectionRetrievalCallback theCallback) Gets the current page of selections.
static int	getCurrentSelectionCount() Get the current count of assets in the selection
static float	getCurrentSelectionSize() Gets the current size of assets in the selection.
static void	getNextPage(jb.gwt_main_modules.base_widgets.client.events.selectionchangelistener.SelectionRetrievalCallback theCallback) Gets the next page of selections.
static void	getPreviousPage(jb.gwt_main_modules.base_widgets.client.events.selectionchangelistener.SelectionRetrievalCallback theCallback) Gets the previous page of selections.
static java.lang.String	getScratchBasketResolverString() Get the resolver string for the scratch basket displayed on the current workspace
static int	getScratchBasketSize() Get the number of assets in our current scratch basket
static void	getSelectionIdFromName(java.lang.String theName, com.google.gwt.core.client.JavaScriptObject theCallback) Get a selection id from a selection name
static jb.gwt_main_modules.base_widgets.client.events.selectionchangelistener.SelectionManager	getSelectionManager() Gets the selection manager.
static void	initializeScratchBasketAPI(jb.gwt_main_modules.scratchbasket.client.ScratchBasketController theInstance)
static void	loadCurrentScratchBasket() Swap the current scratch basket into the main view
static void	removeCurrentSelectionFromScratchBasket() Remove the current selection's contents from our current scratch basket
static void	removeFromSavedSelection(int theSavedSelectionId, jb.gwt_main_modules.base_widgets.client.DefaultCallback theCallback) Remove assets in the current selection from the selection passed in
static void	removeFromSavedSelectionBundle(int theSelectionBundle, jb.gwt_main_modules.base_widgets.client.DefaultCallback theCallback)
static void	saveScratchBasket(java.lang.String theWidgetId, java.lang.String theTabId, java.lang.String theName, java.lang.String theDescription, java.lang.String theFromDate, java.lang.String theToDate, int theDownloadLimit, boolean theIsPublic, com.google.gwt.core.client.JavaScriptObject thePosAction) Saves the current Scratch Basket with the specified Scratch Basket parameters, as either a public or private selection.
static void	selectAllAssets(jb.gwt_main_modules.base_widgets.client.DefaultCallback theCallback) Select all assets on the current view page
static void	selectAsset(int theAssetId) Select the asset (show the gray badge container
static void	setupAPI() Initialize the selection API namespace object.
static void	setupJavascriptAPIs() Setup javascript APIs.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SelectionApiPublisher

public SelectionApiPublisher()

Method Detail

getSelectionManager

public static jb.gwt_main_modules.base_widgets.client.events.selectionchangelistener.SelectionManager getSelectionManager()

Gets the selection manager.

Returns:

the selection manager

setupJavascriptAPIs

public static void setupJavascriptAPIs()

Setup javascript APIs.

setupAPI

public static void setupAPI()

Initialize the selection API namespace object.

initializeScratchBasketAPI

public static void initializeScratchBasketAPI(jb.gwt_main_modules.scratchbasket.client.ScratchBasketController theInstance)

saveScratchBasket

public static void saveScratchBasket(java.lang.String theWidgetId,
                                     java.lang.String theTabId,
                                     java.lang.String theName,
                                     java.lang.String theDescription,
                                     java.lang.String theFromDate,
                                     java.lang.String theToDate,
                                     int theDownloadLimit,
                                     boolean theIsPublic,
                                     com.google.gwt.core.client.JavaScriptObject thePosAction)

Saves the current Scratch Basket with the specified Scratch Basket parameters, as either a public or private selection. It exposes no UI (does not display the Save Selection dialog). This is intended to be used in a Scratch Basket Direct Download javascript which is supplied these parameters: theWidgetId, theTabId, theName (theDefaultName).

Parameters:

theWidgetId - the widget id of the Scratch Basket

theTabId - the tab id of the Scratch Basket

theName - the name of the selection

theDescription - the description of the selection

theFromDate - the from date in yyyy-MM-dd format

theToDate - the to date in yyyy-MM-dd format

theDownloadLimit - number of times selection can be downloaded

theIsPublic - true if selection should be saved as public (for group), otherwise selection is saved as private

thePosAction - the on success action

getSelectionIdFromName

public static void getSelectionIdFromName(java.lang.String theName,
                                          com.google.gwt.core.client.JavaScriptObject theCallback)

Get a selection id from a selection name

Parameters:

theName - the selection's name

theCallback - passed back the selection id

createSelection

public static void createSelection(java.lang.String theName,
                                   java.lang.String theDescription,
                                   boolean thePublic,
                                   java.lang.String theResolverString,
                                   jb.gwt_main_modules.base_widgets.client.DefaultCallback theCallback)

Create a new selection with whatever is in the current selection.

Parameters:

theName - name of the new selection

theDescription - description of the new selection

thePublic - is the new selection public

theResolverString - the resolver string defining some assets

theCallback - the callback to inform when we're done

addToSavedSelection

public static void addToSavedSelection(java.lang.String theResolverString,
                                       int theSavedSelectionId,
                                       jb.gwt_main_modules.base_widgets.client.DefaultCallback theCallback)

Add items defined by the resolver string to the save selection

Parameters:

theResolverString - the resolver string defining some assets

theSavedSelectionId - the selection id

theCallback - the callback to inform when we're done

removeFromSavedSelection

public static void removeFromSavedSelection(int theSavedSelectionId,
                                            jb.gwt_main_modules.base_widgets.client.DefaultCallback theCallback)

Remove assets in the current selection from the selection passed in

Parameters:

theSavedSelectionId - Selection id to remove from

theCallback - once removal is done, function to inform

removeFromSavedSelectionBundle

public static void removeFromSavedSelectionBundle(int theSelectionBundle,
                                                  jb.gwt_main_modules.base_widgets.client.DefaultCallback theCallback)

addToSavedSelectionBundle

public static void addToSavedSelectionBundle(int theSelectionBundle,
                                             jb.gwt_main_modules.base_widgets.client.DefaultCallback theCallback)

deleteSavedSelection

public static void deleteSavedSelection(int theSelectionId,
                                        jb.gwt_main_modules.base_widgets.client.DefaultCallback theCallback)

remove a saved selection

Parameters:

theSelectionId - id of the selection

theCallback - function to inform when the operation is successful

getCurrentSelectionCount

public static int getCurrentSelectionCount()

Get the current count of assets in the selection

Returns:

the selection count

getCurrentSelectionSize

public static float getCurrentSelectionSize()

Gets the current size of assets in the selection.

Returns:

the selection size

selectAllAssets

public static void selectAllAssets(jb.gwt_main_modules.base_widgets.client.DefaultCallback theCallback)

Select all assets on the current view page

Parameters:

theCallback -

clearCurrentSelection

public static void clearCurrentSelection(jb.gwt_main_modules.base_widgets.client.DefaultCallback theCallback)

Clear all assets in the current selection

Parameters:

theCallback -

asIntegerList

public static java.util.List<java.lang.Integer> asIntegerList(com.google.gwt.core.client.JsArrayInteger theArray)

Returns a List of Integer type for the specified JsArrayInteger.

Parameters:

theArray - The JsArrayInteger

Returns:

the List of Integer

changeSelection

public static void changeSelection(com.google.gwt.core.client.JsArrayInteger theAssetIdsToAdd,
                                   com.google.gwt.core.client.JsArrayInteger theAssetIdsToRemove,
                                   boolean theKeepCurrentSelection,
                                   jb.gwt_main_modules.base_widgets.client.DefaultCallback theCallback)

Changes the current selection by selecting the assets to add and deselecting the assets to remove.

Parameters:

theAssetIdsToAdd - the asset ids to select (must be on the current page in the view widget).

theAssetIdsToRemove - the asset ids to remove (must be on the current page in the view widget).

theKeepCurrentSelection - specifies whether to keep or to clear the current selection before applying the adds/removes

theCallback - the callback to call on success.

selectAsset

public static void selectAsset(int theAssetId)

Select the asset (show the gray badge container

Parameters:

theAssetId - the asset id to select (must be on the current page in the view widget).

getScratchBasketResolverString

public static java.lang.String getScratchBasketResolverString()

Get the resolver string for the scratch basket displayed on the current workspace

Returns:

resolver url for the active scratch basket

loadCurrentScratchBasket

public static void loadCurrentScratchBasket()

Swap the current scratch basket into the main view

addCurrentSelectionToScratchBasket

public static void addCurrentSelectionToScratchBasket()

Add the current selection's contents into our current scratch basket

removeCurrentSelectionFromScratchBasket

public static void removeCurrentSelectionFromScratchBasket()

Remove the current selection's contents from our current scratch basket

clearCurrentCart

public static void clearCurrentCart()

Remove the current tabs assets

getScratchBasketSize

public static int getScratchBasketSize()

Get the number of assets in our current scratch basket

fetchAssetIds

public static void fetchAssetIds(java.lang.String theResolverUrl,
                                 int thePage,
                                 int thePageSize,
                                 jb.gwt_main_modules.base_widgets.client.DefaultCallback theCallback)

Fetch list of asset ids from the url with page and offset

Parameters:

theResolverUrl - the resolver url that describes the assets to fetch

thePage - the page number

thePageSize - the size of the page

theCallback - a callback to give an array of record ids back to

doFetchAssetIds

public static void doFetchAssetIds(java.lang.String theResolverUrl,
                                   int thePage,
                                   int thePageSize,
                                   com.google.gwt.core.client.JavaScriptObject theCallback)

This is not a JavaScript callable method

Parameters:

theResolverUrl -

thePage -

thePageSize -

theCallback -

doGetCurrentPage

public static void doGetCurrentPage(com.google.gwt.core.client.JavaScriptObject theCallback)

Internal method for calling server and doing get the current page.

Parameters:

theCallback - the callback

doGetNextPage

public static void doGetNextPage(com.google.gwt.core.client.JavaScriptObject theCallback)

Internal method for calling server and doing get the next page.

Parameters:

theCallback - the callback

doGetPreviousPage

public static void doGetPreviousPage(com.google.gwt.core.client.JavaScriptObject theCallback)

Internal method for calling server and doing get the previous page.

Parameters:

theCallback - the callback

getCurrentPage

public static void getCurrentPage(jb.gwt_main_modules.base_widgets.client.events.selectionchangelistener.SelectionRetrievalCallback theCallback)

Gets the current page of selections.

Parameters:

theCallback - the callback

getNextPage

public static void getNextPage(jb.gwt_main_modules.base_widgets.client.events.selectionchangelistener.SelectionRetrievalCallback theCallback)

Gets the next page of selections.

Parameters:

theCallback - the callback

getPreviousPage

public static void getPreviousPage(jb.gwt_main_modules.base_widgets.client.events.selectionchangelistener.SelectionRetrievalCallback theCallback)

Gets the previous page of selections.

Parameters:

theCallback - the callback