com.github.gwtbootstrap.client.ui

Class Icon

java.lang.Object

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

com.google.gwt.user.client.ui.Widget

com.github.gwtbootstrap.client.ui.Icon

All Implemented Interfaces:

HasAlignment, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsWidget

public class Icon
extends com.google.gwt.user.client.ui.Widget
implements HasAlignment

Widget with a black or white icon.

The icons are provided by Glyphicons and Font Awesome.

UiBinder Usage:

 <b:Icon type="PLANE" />
 
 

Since:

2.0.4.0

Author:

Carlos Alexandro Becker, Dominik Mayer, Sven Jacobs

See Also:

IconStack, Bootstrap documentation, Font Awesome page

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 inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
Icon() Creates a widget but doesn't set an icon yet.
Icon(IconType type) Creates a black icon of given type.

Method Summary

Methods

Modifier and Type	Method and Description
BaseIconType	getBaseIconType() Get the base icon type
IconType	getIconType() Get the icon type
void	setAlignment(Alignment alignment) Pulls icon left or right.
void	setBaseType(BaseIconType type) Sets the base icon type.
void	setBorder(boolean border) Does this icon have a border?
void	setFlip(IconFlip iconFlip) Sets (horizontal or vertical) flip of icon.
void	setIcon(IconType type) Sets the base icon type.
void	setIconSize(IconSize size) Sets the icon size.
void	setLight(boolean light) Sets whether this icon is a "light" (white) icon.
void	setMuted(boolean muted) A muted icon is a grayed out icon.
void	setRotate(IconRotate iconRotate) Sets rotation of icon.
void	setSize(IconSize size) Sets the icon size.
void	setSpin(boolean spin) If true icon will spin.
void	setStackBase(boolean stackBase) Is the icon the base (bottom) icon of a IconStack? Only relevant if icon is a child element of IconStack.
void	setType(IconType type) Sets the icon type.

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, setParent, sinkEvents

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, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

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

Constructor Detail

Icon

public Icon()

Creates a widget but doesn't set an icon yet.

(This is probably not what you want to do most of the time.)

Icon

@UiConstructor
public Icon(IconType type)

Creates a black icon of given type.

Parameters:

type - the icon type

Method Detail

setType

public void setType(IconType type)

Sets the icon type.

Parameters:

type - the icon type

setBaseType

public void setBaseType(BaseIconType type)

Sets the base icon type.

Parameters:

type - the icon type

setIconSize

public void setIconSize(IconSize size)

Sets the icon size.

Parameters:

size - the icon size

setSize

public void setSize(IconSize size)

Sets the icon size.

Parameters:

size - the icon size

getIconType

public IconType getIconType()

Get the icon type

Returns:

icon type, or null, if the Icon is no instance of IconType

getBaseIconType

public BaseIconType getBaseIconType()

Get the base icon type

Returns:

base icon type

setIcon

public void setIcon(IconType type)

Sets the base icon type.

Parameters:

type - the base icon type

setLight

public void setLight(boolean light)

Sets whether this icon is a "light" (white) icon.

Parameters:

light - White icon if true

Since:

2.3.2.0

setMuted

public void setMuted(boolean muted)

A muted icon is a grayed out icon.

Parameters:

muted - Is this icon muted (grayed out)?

Since:

2.3.2.0

setBorder

public void setBorder(boolean border)

Does this icon have a border?

Parameters:

border - True if icon has a border

Since:

2.3.2.0

setStackBase

public void setStackBase(boolean stackBase)

Is the icon the base (bottom) icon of a IconStack? Only relevant if icon is a child element of IconStack.

Parameters:

stackBase - Is this icon the base (bottom icon) of an icon stack?

Since:

2.3.2.0

See Also:

IconStack

setSpin

public void setSpin(boolean spin)

If true icon will spin.

Note: Uses CSS3 animations which aren't supported in IE7 - IE9.

Parameters:

spin - true if icon should spin

Since:

2.3.2.0

setAlignment

public void setAlignment(Alignment alignment)

Pulls icon left or right.

Specified by:

setAlignment in interface HasAlignment

Parameters:

alignment - Alignment of icon

Since:

2.3.2.0

setRotate

public void setRotate(IconRotate iconRotate)

Sets rotation of icon.

Parameters:

iconRotate - Rotation of icon

Since:

2.3.2.0

See Also:

IconRotate

setFlip

public void setFlip(IconFlip iconFlip)

Sets (horizontal or vertical) flip of icon.

Parameters:

iconFlip - Flip of icon

Since:

2.3.2.0

See Also:

IconFlip