/*
* Copyright 2012 GWT-Bootstrap
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.github.gwtbootstrap.client.ui.base;
import com.github.gwtbootstrap.client.ui.Icon;
import com.github.gwtbootstrap.client.ui.constants.BaseIconType;
import com.github.gwtbootstrap.client.ui.constants.Constants;
import com.github.gwtbootstrap.client.ui.constants.IconPosition;
import com.github.gwtbootstrap.client.ui.constants.IconSize;
import com.github.gwtbootstrap.client.ui.constants.IconType;
import com.google.gwt.dom.client.AnchorElement;
import com.google.gwt.dom.client.Node;
import com.google.gwt.dom.client.Text;
import com.google.gwt.event.dom.client.ClickEvent;
import com.google.gwt.event.dom.client.ClickHandler;
import com.google.gwt.event.dom.client.HasClickHandlers;
import com.google.gwt.event.dom.client.HasMouseDownHandlers;
import com.google.gwt.event.dom.client.MouseDownEvent;
import com.google.gwt.event.dom.client.MouseDownHandler;
import com.google.gwt.event.shared.HandlerRegistration;
import com.google.gwt.user.client.DOM;
import com.google.gwt.user.client.Event;
import com.google.gwt.user.client.ui.Focusable;
import com.google.gwt.user.client.ui.HasEnabled;
import com.google.gwt.user.client.ui.HasName;
import com.google.gwt.user.client.ui.HasText;
import com.google.gwt.user.client.ui.impl.FocusImpl;
/**
* An Anchor with optional image and caret.
*
* <p>
* It uses a HTML {@code <a>} tag and can contain text and child widgets. But
* not both at the same time.
* </p>
*
* <p>
* <h3>UiBinder Usage:</h3>
* {@code <b:IconAnchor icon="plane" href="www.twitter.com">Some Text</b:IconAnchor>}
* </p>
*
* <p>
* Here we add a second Icon:
*
* <pre>
* {@code <b:IconAnchor icon="STAR" text="There is a widget so the text goes here">
* <b:Icon type="STAR" />
* </b:IconAnchor>}
* </pre>
*
* All parameter are optional. All setters can be used as parameters.
* </p>
*
* @since 2.0.4.0
*
* @author Dominik Mayer
* @author ohashi keisuke
*/
public class IconAnchor extends ComplexWidget implements HasText, HasIcon, HasHref, HasClickHandlers, HasEnabled,
Focusable, HasName, HasMouseDownHandlers {
private static final FocusImpl impl = FocusImpl.getFocusImplForWidget();
protected Icon icon = new Icon();
private TextNode text = new TextNode("");
private Caret caret = new Caret();
private IconPosition iconPosition;
/**
* Creates the widget and sets the {@code href} property to
* {@code javascript:;} in order to avoid problems when clicking on it.
*/
public IconAnchor() {
super("a");
setIconPosition(IconPosition.LEFT);
setEmptyHref();
}
/**
* {@inheritDoc}
*/
@Override
public void setIconPosition(IconPosition position) {
this.iconPosition = position;
icon.removeFromParent();
text.removeFromParent();
if(IconPosition.RIGHT == position) {
this.insert(text , 0);
this.insert(icon , 1);
return;
} else if(IconPosition.LEFT == position){
this.insert(icon, 0);
this.insert(text, 1);
return;
}
}
/**
* {@inheritDoc}
*/
@Override
public void setIcon(IconType type) {
setBaseIcon(type);
}
/**
* {@inheritDoc}
*/
@Override
public void setBaseIcon(BaseIconType type) {
this.icon.setBaseType(type);
}
/**
* {@inheritDoc}
*/
@Override
public void setIconSize(IconSize size) {
icon.setIconSize(size);
}
/**
* {@inheritDoc}
*/
public void setText(String text) {
if ( !this.getElement().isOrHasChild( this.text.getElement() ) ) {
Node toRemove = null;
for ( int i = 0; i < this.getElement().getChildCount(); i++) {
Node n = this.getElement().getChildNodes().getItem( i );
if ( n.getNodeType() == 3 /*TEXT_NODE*/ ) {
Text t = n.<Text>cast();
if ( t.getNodeValue().equals( this.text.getText() ) || t.getNodeValue().equals( text ) ) {
toRemove = t;
}
}
}
if ( toRemove != null ) {
this.getElement().removeChild(toRemove);
}
this.getElement().appendChild( this.text.getElement() );
}
this.text.removeFromParent();
this.text = new TextNode(" " + text + " ");
setIconPosition(iconPosition);
}
/**
* {@inheritDoc}
*/
public String getText() {
return text.getText();
}
/**
* {@inheritDoc}
*/
public void setHref(String href) {
getElement().setAttribute("href", href);
}
/**
* {@inheritDoc}
*/
public String getHref() {
return getElement().getAttribute("href");
}
/**
* Shows or hides the caret.
*
* @param visible
* <code>true</code> if the caret should be shown.
*/
public void setCaret(boolean visible) {
if (visible)
super.add(caret);
else
super.remove(caret);
}
/**
* {@inheritDoc}
*/
public void setTargetHistoryToken(String targetHistoryToken) {
setHref("#" + targetHistoryToken);
}
/**
* {@inheritDoc}
*/
public String getTargetHistoryToken() {
String[] hrefs = getHref().split("#");
return hrefs[1];
}
/**
* Sets the <code>href</code>property of this element to "javascript:;" in
* order to get another cursor (hand).
*/
public void setEmptyHref() {
setHref(Constants.EMPTY_HREF);
}
/**
* {@inheritDoc}
*/
@Override
public HandlerRegistration addClickHandler(ClickHandler handler) {
return addDomHandler(handler, ClickEvent.getType());
}
/**
* {@inheritDoc}
*/
@Override
public HandlerRegistration addMouseDownHandler(MouseDownHandler handler) {
return addDomHandler(handler, MouseDownEvent.getType());
}
/**
* {@inheritDoc}
*/
@Override
public boolean isEnabled() {
return !DOM.getElementPropertyBoolean(getElement(), "disabled");
}
/**
* {@inheritDoc}
*/
@Override
public void setEnabled(boolean enabled) {
DOM.setElementPropertyBoolean(getElement(), "disabled", !enabled);
}
/**
* {@inheritDoc}
*/
@Override
public void onBrowserEvent(Event event) {
switch (DOM.eventGetType(event)) {
case Event.ONCLICK:
if (isEnabled()) {
super.onBrowserEvent(event);
}
break;
default:
super.onBrowserEvent(event);
break;
}
}
@Override
public int getTabIndex() {
return impl.getTabIndex(getElement());
}
@Override
public void setAccessKey(char key) {
DOM.setElementProperty(getElement(), "accessKey", Character.toString(key));
}
@Override
public void setFocus(boolean focused) {
if (focused) {
impl.focus(getElement());
} else {
impl.blur(getElement());
}
}
@Override
public void setTabIndex(int index) {
impl.setTabIndex(getElement(), index);
}
@Override
protected void onAttach() {
super.onAttach();
// Accessibility: setting tab index to be 0 by default, ensuring element
// appears in tab sequence. We must ensure that the element doesn't already
// have a tabIndex set. This is not a problem for normal widgets, but when
// a widget is used to wrap an existing static element, it can already have
// a tabIndex.
int tabIndex = getTabIndex();
if (-1 == tabIndex) {
setTabIndex(0);
}
}
/**
* Set active style name.
* @param active <code>true</code> : set active <code>false</code> : unset active
*/
public void setActive(boolean active) {
setStyleName(Constants.ACTIVE, active);
}
/**
* Has the active css style name?
* @return <code>true</code>: has <code>false</code> : none.
*/
public boolean isActive() {
return getStyleName().contains(Constants.ACTIVE);
}
/**
* {@inheritDoc}
*/
@Override
public void setName(String name) {
getAnchorElement().setName(name);
}
/**
* {@inheritDoc}
*/
@Override
public String getName() {
return getAnchorElement().getName();
}
/**
* Set target attribute
* @param target target name
*/
public void setTarget(String target) {
getAnchorElement().setTarget(target);
}
/**
* Get target attribute value
* @return target attribute value
*/
public String getTarget() {
return getAnchorElement().getTarget();
}
protected AnchorElement getAnchorElement() {
return AnchorElement.as(getElement());
}
/**
* {@inheritDoc}
*/
@Override
public void setCustomIconStyle(String customIconStyle) {
icon.addStyleName(customIconStyle);
}
}