| Package | Description |
|---|---|
| com.vaadin.event | |
| com.vaadin.icons | |
| com.vaadin.server | |
| com.vaadin.ui | |
| com.vaadin.ui.declarative.converters | |
| com.vaadin.ui.dnd | |
| com.vaadin.ui.renderers | |
| com.vaadin.util |
| Modifier and Type | Method and Description |
|---|---|
Resource |
Action.getIcon()
Returns the action's icon.
|
| Modifier and Type | Method and Description |
|---|---|
void |
Action.setIcon(Resource icon)
Sets the icon.
|
| Constructor and Description |
|---|
Action(String caption,
Resource icon)
Constructs a new action with the given caption string and icon.
|
ShortcutAction(String caption,
Resource icon,
int kc,
int... m)
Creates a shortcut that reacts to the given
ShortcutAction.KeyCode and
(optionally) ShortcutAction.ModifierKeys. |
ShortcutListener(String caption,
Resource icon,
int keyCode,
int... modifierKeys) |
| Modifier and Type | Class and Description |
|---|---|
class |
VaadinIcons
FontIcon that represents the Vaadin Icons font. |
| Modifier and Type | Interface and Description |
|---|---|
interface |
ConnectorResource
A resource that is served through the Connector that is using the resource.
|
interface |
FontIcon
A font icon is a type of icon that is made by displaying one character from a
specially constructed font containing icons ("icon font").
|
| Modifier and Type | Class and Description |
|---|---|
class |
ClassResource
ClassResource is a named resource accessed with the class
loader. |
class |
ExternalResource
ExternalResource implements source for resources fetched from
location specified by URL:s. |
class |
FileResource
FileResources are files or directories on local filesystem. |
class |
FontAwesome
Deprecated.
Since 8.0 replaced with included Vaadin Icons
https://vaadin.com/icons (#7979). Will not be updated to include
new icons.
|
class |
GenericFontIcon
A generic implementation of
FontIcon interface. |
class |
StreamResource
StreamResource is a resource provided to the client directly by
the application. |
class |
ThemeResource
ThemeResource is a named theme dependant resource provided and
managed by a theme. |
| Modifier and Type | Method and Description |
|---|---|
Resource |
FileDownloader.getFileDownloadResource()
Gets the resource set for download.
|
Resource |
ResourceReference.getResource() |
Resource |
BrowserWindowOpener.getResource()
Returns the resource for this instance.
|
protected Resource |
AbstractClientConnector.getResource(String key)
Gets a resource defined using
AbstractClientConnector.setResource(String, Resource) with
the corresponding key. |
static Resource |
ResourceReference.getResource(URLReference reference) |
| Modifier and Type | Method and Description |
|---|---|
void |
Page.Styles.add(Resource resource)
Injects a CSS resource into the page.
|
void |
PaintTarget.addAttribute(String name,
Resource value)
Adds a resource attribute to component.
|
void |
JsonPaintTarget.addAttribute(String name,
Resource value) |
static ResourceReference |
ResourceReference.create(Resource resource,
ClientConnector connector,
String key) |
void |
Page.open(Resource resource,
String windowName,
boolean tryToOpenAsPopup)
Deprecated.
As of 7.0, only retained to maintain compatibility with
LegacyWindow.open methods. See documentation for
LegacyWindow.open(Resource, String, boolean) for
discussion about replacing API. |
void |
Page.open(Resource resource,
String windowName,
int width,
int height,
BorderStyle border)
Deprecated.
As of 7.0, only retained to maintain compatibility with
LegacyWindow.open methods. See documentation for
LegacyWindow.open(Resource, String, int, int, BorderStyle)
for discussion about replacing API. |
void |
GlobalResourceHandler.register(Resource resource,
ClientConnector ownerConnector)
Registers a resource to be served with a global URL.
|
void |
FileDownloader.setFileDownloadResource(Resource resource)
Sets the resource that is downloaded when the extended component is
clicked.
|
void |
BrowserWindowOpener.setResource(Resource resource)
Sets the provided
resource for this instance. |
protected void |
AbstractClientConnector.setResource(String key,
Resource resource)
Registers a resource with this connector using the given key.
|
| Constructor and Description |
|---|
BrowserWindowOpener(Resource resource)
Creates a window opener that will open window to the provided resource.
|
FileDownloader(Resource resource)
Creates a new file downloader for the given resource.
|
ResourceReference(Resource resource,
ClientConnector connector,
String key) |
| Modifier and Type | Method and Description |
|---|---|
Resource |
IconGenerator.apply(T item)
Gets an icon resource for the
item. |
Resource |
Tree.getIcon() |
Resource |
TabSheet.Tab.getIcon()
Gets the icon for the tab.
|
Resource |
TabSheet.TabSheetTabImpl.getIcon() |
Resource |
Notification.getIcon()
Gets the icon part of the notification message.
|
Resource |
MenuBar.MenuItem.getIcon()
Gets the objects icon.
|
Resource |
Composite.getIcon() |
Resource |
Component.getIcon()
Gets the icon resource of the component.
|
Resource |
AbstractComponent.getIcon() |
Resource |
Video.getPoster() |
Resource |
Link.getResource()
Returns the resource this link opens.
|
Resource |
Embedded.getSource()
Gets the resource contained in the embedded object.
|
Resource |
AbstractEmbedded.getSource()
Get the object source resource.
|
| Modifier and Type | Method and Description |
|---|---|
List<Resource> |
AbstractMedia.getSources() |
| Modifier and Type | Method and Description |
|---|---|
MenuBar.MenuItem |
MenuBar.addItem(String caption,
Resource icon,
MenuBar.Command command)
Add a new item to the menu bar.
|
MenuBar.MenuItem |
MenuBar.MenuItem.addItem(String caption,
Resource icon,
MenuBar.Command command)
Add a new item inside this item, thus creating a sub-menu.
|
MenuBar.MenuItem |
MenuBar.addItemBefore(String caption,
Resource icon,
MenuBar.Command command,
MenuBar.MenuItem itemToAddBefore)
Add an item before some item.
|
MenuBar.MenuItem |
MenuBar.MenuItem.addItemBefore(String caption,
Resource icon,
MenuBar.Command command,
MenuBar.MenuItem itemToAddBefore)
Add an item before some item.
|
void |
AbstractMedia.addSource(Resource source)
Adds an alternative media file to the sources list.
|
TabSheet.Tab |
TabSheet.addTab(Component c,
String caption,
Resource icon)
Adds a new tab into TabSheet.
|
TabSheet.Tab |
TabSheet.addTab(Component tabComponent,
String caption,
Resource icon,
int position)
Adds a new tab into TabSheet.
|
void |
LegacyWindow.open(Resource resource)
Deprecated.
As of 7.0, use getPage().setLocation instead
|
void |
LegacyWindow.open(Resource resource,
String windowName)
Deprecated.
As of 7.0, use getPage().open instead
|
void |
LegacyWindow.open(Resource resource,
String windowName,
boolean tryToOpenAsPopup)
Deprecated.
Opens the given resource in a window with the given name and optionally
tries to force the resource to open in a new window instead of a new tab.
|
void |
LegacyWindow.open(Resource resource,
String windowName,
int width,
int height,
BorderStyle border)
Deprecated.
As of 7.0, use getPage().open instead
|
void |
Tree.setIcon(Resource icon) |
void |
TabSheet.Tab.setIcon(Resource icon)
Sets the icon for the tab.
|
void |
TabSheet.TabSheetTabImpl.setIcon(Resource icon) |
void |
Notification.setIcon(Resource icon)
Sets the icon part of the notification message.
|
void |
MenuBar.MenuItem.setIcon(Resource icon)
Sets the icon.
|
void |
Composite.setIcon(Resource icon) |
void |
Component.setIcon(Resource icon)
Sets the icon of the component.
|
void |
AbstractComponent.setIcon(Resource icon)
Sets the component's icon.
|
void |
TabSheet.Tab.setIcon(Resource icon,
String iconAltText)
Sets the icon and alt text for the tab.
|
void |
TabSheet.TabSheetTabImpl.setIcon(Resource icon,
String iconAltText) |
void |
Button.setIcon(Resource icon,
String iconAltText)
Sets the component's icon and alt text.
|
void |
Video.setPoster(Resource poster)
Sets the poster image, which is shown in place of the video before the
user presses play.
|
void |
Link.setResource(Resource resource)
Sets the resource this link opens.
|
void |
Embedded.setSource(Resource source)
Sets the object source resource.
|
void |
AbstractMedia.setSource(Resource source)
Sets a single media file as the source of the media component.
|
void |
AbstractEmbedded.setSource(Resource source)
Sets the object source resource.
|
void |
AbstractMedia.setSources(Resource... sources)
Set multiple sources at once.
|
| Constructor and Description |
|---|
Audio(String caption,
Resource source) |
BrowserFrame(String caption,
Resource source)
Creates a new browser frame with the given caption and content.
|
Button(Resource icon)
Creates a new push button with the given icon.
|
Button(Resource icon,
Button.ClickListener listener)
Creates a new push button with a click listener.
|
Button(String caption,
Resource icon)
Creates a new push button with the given caption and icon.
|
Embedded(String caption,
Resource source)
Creates a new Embedded object whose contents is loaded from given
resource.
|
Flash(String caption,
Resource source)
Creates a new Flash component with the given caption and content.
|
Image(String caption,
Resource source)
Creates a new Image whose contents is loaded from given resource.
|
Link(String caption,
Resource resource)
Creates a new instance of Link.
|
Link(String caption,
Resource resource,
String targetName,
int width,
int height,
BorderStyle border)
Creates a new instance of Link that opens a new window.
|
MenuItem(String caption,
Resource icon,
MenuBar.Command command)
Constructs a new menu item that can optionally have an icon and a
command associated with it.
|
TabSheetTabImpl(String key,
String caption,
Resource icon) |
Video(String caption,
Resource source) |
| Modifier and Type | Method and Description |
|---|---|
Result<Resource> |
DesignResourceConverter.convertToModel(String value,
ValueContext context) |
| Modifier and Type | Method and Description |
|---|---|
String |
DesignResourceConverter.convertToPresentation(Resource value,
ValueContext context) |
| Modifier and Type | Method and Description |
|---|---|
void |
DragSourceExtension.setDragImage(Resource imageResource)
Set a custom drag image for the current drag source.
|
| Modifier and Type | Method and Description |
|---|---|
JsonValue |
ImageRenderer.encode(Resource resource) |
| Modifier and Type | Field and Description |
|---|---|
static Resource |
FileTypeResolver.DEFAULT_ICON
Default icon given if no icon is specified for a mime-type.
|
Copyright © 2021 Vaadin Ltd. All rights reserved.