We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.component.page.
Package com.vaadin.flow.component.page
Interface WebStorage
All Superinterfaces:
Wrapper for similarly named Browser API. WebStorage may be handy to save some data that you want to be stored on the client side, instead of e.g. database on the server. An example could be certain UI settings that the same users might want to have set differently based on their device.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfaceThis callback is notified after the value has been retrieved from the client side.
static enum -
Method Summary
Static MethodsModifier and TypeMethodDescriptionstatic voidclear()Clears all values from the Storage.localStorage
static voidclear(WebStorage.Storage storage) Clears the given storage.
static voidclear(UI ui, WebStorage.Storage storage) Clears the given storage.
static voidgetItem(WebStorage.Storage storage, String key, WebStorage.Callback callback) Asynchronously gets an item from the given storage
static voidgetItem(UI ui, WebStorage.Storage storage, String key, WebStorage.Callback callback) Asynchronously gets an item from the given storage
static voidgetItem(String key, WebStorage.Callback callback) Asynchronously gets an item from the Storage.localStorage
static voidremoveItem(WebStorage.Storage storage, String key) Removes the value associated by the given key from the provided storage type
static voidremoveItem(UI ui, WebStorage.Storage storage, String key) Removes the value associated by the given key from the provided storage type
static voidremoveItem(String key) Removes the value associated by the given key from the Storage.localStorage
static voidsetItem(WebStorage.Storage storage, String key, String value) Sets given key-value pair to given storage type
static voidsetItem(UI ui, WebStorage.Storage storage, String key, String value) Sets given key-value pair to given storage type
static voidSets given key-value pair to Storage.localStorage
-
Method Details
-
setItem
Sets given key-value pair to Storage.localStorage
Parameters:
key- the keyvalue- the value -
setItem
Sets given key-value pair to given storage type
Parameters:
storage- the storage typekey- the keyvalue- the value -
setItem
Sets given key-value pair to given storage type
Parameters:
ui- the UI for which the storage is related tostorage- the storage typekey- the keyvalue- the value -
removeItem
Removes the value associated by the given key from the Storage.localStorage
Parameters:
key- the key to be deleted -
removeItem
Removes the value associated by the given key from the provided storage type
Parameters:
storage- the storage type from which the value will be removedkey- the key to be deleted -
removeItem
Removes the value associated by the given key from the provided storage type
Parameters:
ui- the UI for which the storage is related tostorage- the storage type from which the value will be removedkey- the key to be deleted -
clear
static void clear()Clears all values from the Storage.localStorage
-
clear
Clears the given storage.
Parameters:
storage- the storage -
clear
Clears the given storage.
Parameters:
ui- the UI for which the storage is related tostorage- the storage -
getItem
Asynchronously gets an item from the Storage.localStorage
Parameters:
key- the key for which the value will be fetchedcallback- the callback that gets the value once transferred from the client side -
getItem
Asynchronously gets an item from the given storage
Parameters:
storage- the storagekey- the key for which the value will be fetchedcallback- the callback that gets the value once transferred from the client side -
getItem
Asynchronously gets an item from the given storage
Parameters:
ui- the UI for which the storage is related tostorage- the storagekey- the key for which the value will be fetchedcallback- the callback that gets the value once transferred from the client side
-