com.github.gwtbootstrap.client.ui.base

Class IconAnchor

java.lang.Object

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

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

com.google.gwt.user.client.ui.Panel

com.google.gwt.user.client.ui.ComplexPanel

com.github.gwtbootstrap.client.ui.base.ComplexWidget

com.github.gwtbootstrap.client.ui.base.IconAnchor

All Implemented Interfaces:

HasHref, HasIcon, HasStyle, IsResponsive, com.google.gwt.event.dom.client.HasClickHandlers, com.google.gwt.event.dom.client.HasMouseDownHandlers, 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.Focusable, com.google.gwt.user.client.ui.HasEnabled, com.google.gwt.user.client.ui.HasName, com.google.gwt.user.client.ui.HasText, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IndexedPanel, com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, Iterable<com.google.gwt.user.client.ui.Widget>

Direct Known Subclasses:

Button

public class IconAnchor
extends ComplexWidget
implements com.google.gwt.user.client.ui.HasText, HasIcon, HasHref, com.google.gwt.event.dom.client.HasClickHandlers, com.google.gwt.user.client.ui.HasEnabled, com.google.gwt.user.client.ui.Focusable, com.google.gwt.user.client.ui.HasName, com.google.gwt.event.dom.client.HasMouseDownHandlers

An Anchor with optional image and caret.

It uses a HTML <a> tag and can contain text and child widgets. But not both at the same time.

UiBinder Usage:

<b:IconAnchor icon="plane" href="www.twitter.com">Some Text</b:IconAnchor>

Here we add a second Icon:

 <b:IconAnchor icon="STAR" text="There is a widget so the text goes here">
     <b:Icon type="STAR" />
 </b:IconAnchor>
 

All parameter are optional. All setters can be used as parameters.

Since:

2.0.4.0

Author:

Dominik Mayer, ohashi keisuke

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

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.IndexedPanel

com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

Field Summary

Fields

Modifier and Type	Field and Description
protected Icon	icon

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
IconAnchor() Creates the widget and sets the href property to javascript:; in order to avoid problems when clicking on it.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.gwt.event.shared.HandlerRegistration	addClickHandler(com.google.gwt.event.dom.client.ClickHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addMouseDownHandler(com.google.gwt.event.dom.client.MouseDownHandler handler)
protected com.google.gwt.dom.client.AnchorElement	getAnchorElement()
String	getHref() Gets the URL of the website, the link is pointing to.
String	getName()
int	getTabIndex()
String	getTarget() Get target attribute value
String	getTargetHistoryToken() Gets the history token this link points to
String	getText()
boolean	isActive() Has the active css style name?
boolean	isEnabled()
protected void	onAttach()
void	onBrowserEvent(com.google.gwt.user.client.Event event)
void	setAccessKey(char key)
void	setActive(boolean active) Set active style name.
void	setBaseIcon(BaseIconType type) Sets the BaseType of the Icon.
void	setCaret(boolean visible) Shows or hides the caret.
void	setCustomIconStyle(String customIconStyle) Set custom icon style.
void	setEmptyHref() Sets the hrefproperty of this element to "javascript:;" in order to get another cursor (hand).
void	setEnabled(boolean enabled)
void	setFocus(boolean focused)
void	setHref(String href) Sets the href property of the anchor tag.
void	setIcon(IconType type) Sets the Type of the Icon.
void	setIconPosition(IconPosition position) Set icon position , left or right
void	setIconSize(IconSize size) Sets the size of the icon.
void	setName(String name)
void	setTabIndex(int index)
void	setTarget(String target) Set target attribute
void	setTargetHistoryToken(String targetHistoryToken) Sets the href property of the anchor tag to "#" + targetHistoryToken.
void	setText(String text)

Methods inherited from class com.github.gwtbootstrap.client.ui.base.ComplexWidget

add, addStyle, insert, removeStyle, setHideOn, setShowOn, setStyle

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

add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, insert, iterator, remove, remove

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

add, adopt, adopt, clear, disown, doAttachChildren, doDetachChildren, orphan, remove

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, 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

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Methods inherited from interface com.google.gwt.user.client.ui.HasWidgets

clear, iterator, remove

Field Detail

icon

protected Icon icon

Constructor Detail

IconAnchor

public IconAnchor()

Creates the widget and sets the href property to javascript:; in order to avoid problems when clicking on it.

Method Detail

setIconPosition

public void setIconPosition(IconPosition position)

Set icon position , left or right

Specified by:

setIconPosition in interface HasIcon

Parameters:

position - icon's position

setIcon

public void setIcon(IconType type)

Sets the Type of the Icon.

Specified by:

setIcon in interface HasIcon

setBaseIcon

public void setBaseIcon(BaseIconType type)

Sets the BaseType of the Icon.

Specified by:

setBaseIcon in interface HasIcon

setIconSize

public void setIconSize(IconSize size)

Sets the size of the icon.

Default is DEFAULT.

Specified by:

setIconSize in interface HasIcon

Parameters:

size - the new size.

setText

public void setText(String text)

Specified by:

setText in interface com.google.gwt.user.client.ui.HasText

getText

public String getText()

Specified by:

getText in interface com.google.gwt.user.client.ui.HasText

setHref

public void setHref(String href)

Sets the href property of the anchor tag.

Use it only to set links to another page. Links on the same page or GWT tokens should be set with #setTargetHistoryToken(String)

Specified by:

setHref in interface HasHref

Parameters:

href - the website URL

getHref

public String getHref()

Gets the URL of the website, the link is pointing to.

Specified by:

getHref in interface HasHref

Returns:

the URL

setCaret

public void setCaret(boolean visible)

Shows or hides the caret.

Parameters:

visible - true if the caret should be shown.

setTargetHistoryToken

public void setTargetHistoryToken(String targetHistoryToken)

Sets the href property of the anchor tag to "#" + targetHistoryToken.

Specified by:

setTargetHistoryToken in interface HasHref

Parameters:

targetHistoryToken - the history token

getTargetHistoryToken

public String getTargetHistoryToken()

Gets the history token this link points to

Specified by:

getTargetHistoryToken in interface HasHref

Returns:

the history token

setEmptyHref

public void setEmptyHref()

Sets the hrefproperty of this element to "javascript:;" in order to get another cursor (hand).

addClickHandler

public com.google.gwt.event.shared.HandlerRegistration addClickHandler(com.google.gwt.event.dom.client.ClickHandler handler)

Specified by:

addClickHandler in interface com.google.gwt.event.dom.client.HasClickHandlers

addMouseDownHandler

public com.google.gwt.event.shared.HandlerRegistration addMouseDownHandler(com.google.gwt.event.dom.client.MouseDownHandler handler)

Specified by:

addMouseDownHandler in interface com.google.gwt.event.dom.client.HasMouseDownHandlers

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface com.google.gwt.user.client.ui.HasEnabled

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface com.google.gwt.user.client.ui.HasEnabled

onBrowserEvent

public void onBrowserEvent(com.google.gwt.user.client.Event event)

Specified by:

onBrowserEvent in interface com.google.gwt.user.client.EventListener

Overrides:

onBrowserEvent in class com.google.gwt.user.client.ui.Widget

getTabIndex

public int getTabIndex()

Specified by:

getTabIndex in interface com.google.gwt.user.client.ui.Focusable

setAccessKey

public void setAccessKey(char key)

Specified by:

setAccessKey in interface com.google.gwt.user.client.ui.Focusable

setFocus

public void setFocus(boolean focused)

Specified by:

setFocus in interface com.google.gwt.user.client.ui.Focusable

setTabIndex

public void setTabIndex(int index)

Specified by:

setTabIndex in interface com.google.gwt.user.client.ui.Focusable

onAttach

protected void onAttach()

Overrides:

onAttach in class com.google.gwt.user.client.ui.Widget

setActive

public void setActive(boolean active)

Set active style name.

Parameters:

active - true : set active false : unset active

isActive

public boolean isActive()

Has the active css style name?

Returns:

true: has false : none.

setName

public void setName(String name)

Specified by:

setName in interface com.google.gwt.user.client.ui.HasName

getName

public String getName()

Specified by:

getName in interface com.google.gwt.user.client.ui.HasName

setTarget

public void setTarget(String target)

Set target attribute

Parameters:

target - target name

getTarget

public String getTarget()

Get target attribute value

Returns:

target attribute value

getAnchorElement

protected com.google.gwt.dom.client.AnchorElement getAnchorElement()

setCustomIconStyle

public void setCustomIconStyle(String customIconStyle)

Set custom icon style.

It sets css class name to <i> tag. You can set any icons style.

Specified by:

setCustomIconStyle in interface HasIcon