gwt.material.design.client.ui.MaterialTooltip Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gwt-material Show documentation
Show all versions of gwt-material Show documentation
A Material Design look and feel for GWT Applications
/*
* #%L
* GwtMaterial
* %%
* Copyright (C) 2015 - 2017 GwtMaterialDesign
* %%
* 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.
* #L%
*/
package gwt.material.design.client.ui;
import com.google.gwt.dom.client.Element;
import com.google.gwt.event.logical.shared.AttachEvent;
import com.google.gwt.user.client.ui.*;
import gwt.material.design.client.base.HasId;
import gwt.material.design.client.base.HasPosition;
import gwt.material.design.client.base.HasReload;
import gwt.material.design.client.base.JsLoader;
import gwt.material.design.client.base.helper.EventHelper;
import gwt.material.design.client.constants.Position;
import gwt.material.design.client.js.JsTooltipOptions;
import java.util.Iterator;
import java.util.NoSuchElementException;
import static gwt.material.design.client.js.JsMaterialElement.$;
/**
* Basic implementation for the Material Design tooltip.
* UiBinder Example
*
* {@code
*
* ...
*
* }
*
*
* @author kevzlou7979
* @author Ben Dol
* @see Material Tooltip
* @see Material Design Specification
*/
public class MaterialTooltip implements JsLoader, IsWidget, HasWidgets, HasOneWidget, HasId, HasText, HasPosition, HasReload {
private String id;
private String html;
private Widget widget;
private JsTooltipOptions options = JsTooltipOptions.create();
/**
* Creates the empty Tooltip
*/
public MaterialTooltip() {
}
/**
* Creates the tooltip around this widget
*
* @param w widget for the tooltip
*/
public MaterialTooltip(final Widget w) {
setWidget(w);
}
/**
* Creates the tooltip around this widget with given title
*
* @param w widget for the tooltip
* @param text text for the tooltip
*/
public MaterialTooltip(final Widget w, final String text) {
setWidget(w);
setText(text);
}
@Override
public void load() {
$(widget.getElement()).tooltip(options);
}
@Override
public void unload() {
command("remove");
}
@Override
public void reload() {
unload();
load();
}
/**
* Force the Tooltip to be destroyed
*
* @deprecated use {@link #unload()}
*/
@Deprecated
public void remove() {
unload();
}
@Override
public void clear() {
widget = null;
}
@Override
public Iterator iterator() {
// Simple iterator for the widget
return new Iterator() {
boolean hasElement = widget != null;
Widget returned = null;
@Override
public boolean hasNext() {
return hasElement;
}
@Override
public Widget next() {
if (!hasElement || (widget == null)) {
throw new NoSuchElementException();
}
hasElement = false;
return (returned = widget);
}
@Override
public void remove() {
if (returned != null) {
MaterialTooltip.this.remove(returned);
}
}
};
}
@Override
public boolean remove(final Widget w) {
// Validate.
if (widget != w) {
return false;
}
// Logical detach.
clear();
return true;
}
@Override
public Widget asWidget() {
return widget;
}
@Override
public String toString() {
return asWidget().toString();
}
protected void command(String command) {
if (widget != null) {
$(widget.getElement()).tooltip(command);
}
}
@Override
public void setWidget(final Widget widget) {
// Validate
if (widget == this.widget) {
return;
}
// Remove old child
if (this.widget != null) {
remove(this.widget);
}
// Logical attach, but don't physical attach; done by jquery.
this.widget = widget;
if (this.widget == null) {
return;
}
setAttribute("data-delay", String.valueOf(options.delay));
if (options.position != null) {
setAttribute("data-position", options.position);
}
if (options.tooltip != null) {
setAttribute("data-tooltip", options.tooltip);
}
if (this.widget.isAttached()) {
reload();
} else {
// Smart detect the attachment and detachment of widget to update the tooltip
widget.addAttachHandler(event -> {
if (event.isAttached()) {
// If its attached - reload the tooltip
reload();
} else {
// If it was detached - unload the tooltip
unload();
}
});
}
}
@Override
public void add(final Widget child) {
if (getWidget() != null) {
throw new IllegalStateException("Can only contain one child widget");
}
setWidget(child);
}
@Override
public void setWidget(final IsWidget w) {
setWidget(w.asWidget());
}
@Override
public Widget getWidget() {
return widget;
}
@Override
public void setId(final String id) {
this.id = id;
if (widget != null) {
widget.getElement().setId(id);
}
}
@Override
public String getId() {
return (widget == null) ? id : widget.getElement().getId();
}
@Override
public void setPosition(final Position position) {
options.position = position.getCssName();
setAttribute("data-position", position.getCssName());
}
@Override
public Position getPosition() {
return options.position != null ? Position.fromStyleName(options.position) : null;
}
public void setDelayMs(final int delayMs) {
options.delay = delayMs;
setAttribute("data-delay", String.valueOf(delayMs));
}
public int getDelayMs() {
return options.delay;
}
/**
* Gets the tooltip's display string
*
* @return String tooltip display string
*/
@Override
public String getText() {
return options.tooltip;
}
/**
* Sets the tooltip's display string
*
* @param text String display string
*/
@Override
public void setText(final String text) {
options.tooltip = text;
setAttribute("data-tooltip", text);
}
/**
* @deprecated Use {@link #getHtml}
*/
@Deprecated
public String getTooltipHTML() {
return getHtml();
}
/**
* @deprecated Use {@link #setHtml}
*/
@Deprecated
public void setTooltipHTML(String html) {
setHtml(html);
}
/**
* Get the html of the tooltip.
*/
public String getHtml() {
return html;
}
/**
* Set the html as value inside the tooltip.
*/
public void setHtml(String html) {
this.html = html;
Element element = widget.getElement();
if (widget.isAttached()) {
$("#" + element.getAttribute("data-tooltip-id"))
.find("span")
.html(html != null ? html : "");
} else {
widget.addAttachHandler(event ->
$("#" + element.getAttribute("data-tooltip-id"))
.find("span")
.html(html != null ? html : ""));
}
}
public void setAttribute(String attr, String value) {
if (widget != null) {
AttachEvent.Handler handler = event -> {
widget.getElement().setAttribute(attr, value);
};
if (widget.isAttached()) {
handler.onAttachOrDetach(null);
} else {
EventHelper.onAttachOnce(widget, handler);
}
}
}
} © 2015 - 2024 Weber Informatics LLC | Privacy Policy