Package com.vaadin.client.ui

Class Icon

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.vaadin.client.ui.Icon

All Implemented Interfaces:

com.google.gwt.user.client.ui.HasVisibility

Direct Known Subclasses:

FontIcon, ImageIcon

public abstract class Icon
extends com.google.gwt.user.client.ui.UIObject

An abstract representation of an icon.

Since:

7.2

Author:

Vaadin Ltd

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields

Modifier and Type	Field	Description
static String	CLASSNAME

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor	Description
Icon()

Method Summary

Modifier and Type	Method	Description
abstract String	getUri()	Gets the current URI for this icon.
abstract void	setAlternateText(String alternateText)	Sets the alternate text for the icon.
abstract void	setUri(String uri)	Sets the URI for the icon.

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, sinkEvents, toString, unsinkEvents

Methods inherited from class java.lang.Object

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

Field Detail

CLASSNAME

public static final String CLASSNAME

See Also:

Constant Field Values

Constructor Detail

Icon

public Icon()

Method Detail

setUri

public abstract void setUri(String uri)

Sets the URI for the icon. The URI should be run trough ApplicationConnection.translateVaadinUri(String) before setting.

This might be a URL referencing a image (e.g ImageIcon) or a custom URI (e.g FontIcon).

Parameters:

uri - the URI for this icon

getUri

public abstract String getUri()

Gets the current URI for this icon.

Returns:

URI in use

setAlternateText

public abstract void setAlternateText(String alternateText)

Sets the alternate text for the icon.

Parameters:

alternateText - with the alternate text.