TooltipBehavior.java

/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (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.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is part of dcm4che, an implementation of DICOM(TM) in
 * Java(TM), hosted at https://github.com/dcm4che.
 *
 * The Initial Developer of the Original Code is
 * Agfa Healthcare.
 * Portions created by the Initial Developer are Copyright (C) 2012
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 * See @authors listed below
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

package org.dcm4chee.wizard.common.behavior;

import org.apache.wicket.Application;
import org.apache.wicket.Component;
import org.apache.wicket.Localizer;
import org.apache.wicket.behavior.Behavior;
import org.apache.wicket.markup.ComponentTag;
import org.apache.wicket.model.AbstractReadOnlyModel;
import org.apache.wicket.model.IModel;
import org.dcm4chee.wizard.common.component.ExtendedForm;

/**
 * @author Franz Willer <franz.willer@gmail.com>
 */
public class TooltipBehavior extends Behavior {

    private static final long serialVersionUID = 1L;

    private static final String POSTFIX = ".tooltip";
    private String prefix, id;

    private transient Localizer localizer;

    private IModel<?> substitutionModel;
    private AbstractReadOnlyModel<Boolean> showTooltipModel;

    private boolean generateComponentTreePrefix;

    /*
     * Create a TooltipBehaviour with given prefix. <p> Format of resource key:
     * <prefix><component id>.tooltip
     */
    public TooltipBehavior(String prefix) {
        this.prefix = prefix;
    }

    /*
     * Create a TooltipBehaviour with given prefix and a fixed id. <p> Format of
     * resource key: <prefix><id>.tooltip
     */
    public TooltipBehavior(String prefix, String id) {
        this.prefix = prefix;
        this.id = id;
    }

    public TooltipBehavior(String prefix, String id, IModel<?> substitutionModel) {
        this(prefix, id);
        this.substitutionModel = substitutionModel;
    }

    public TooltipBehavior(String prefix, String id, AbstractReadOnlyModel<Boolean> showTooltipModel) {
        this(prefix, id);
        this.showTooltipModel = showTooltipModel;
    }

    public TooltipBehavior setGenerateComponentTreePrefix() {
        this.generateComponentTreePrefix = true;
        return this;
    }

    public void onComponentTag(Component component, ComponentTag tag) {
        String currentTitle = tag.getAttribute("title");
        tag.put("title",
                currentTitle != null ? (currentTitle + " ") : ""
                        + getLocalizer().getStringIgnoreSettings(getResourceKey(component), component,
                                substitutionModel, ""));
    }

    String getResourceKey(Component component) {
        if (generateComponentTreePrefix)
            prefix = generateComponentTreePrefix(component);
        StringBuilder sb = new StringBuilder();
        if (prefix != null)
            sb.append(prefix);
        sb.append(id == null ? component.getId() : id);
        sb.append(this.showTooltipModel == null ? "" : "." + (this.showTooltipModel.getObject() ? "hide" : "show"));
        sb.append(POSTFIX);
        return sb.toString();
    }

    private String generateComponentTreePrefix(Component component) {
        generateComponentTreePrefix = false;
        StringBuilder sb = new StringBuilder("");
        Component parent = component.getParent();
        while ((parent != null) && !parent.equals("") && !(parent instanceof ExtendedForm)) {
            sb.insert(0, ".");
            sb.insert(0, parent.getId());
            parent = parent.getParent();
        }
        if ((prefix != null) && (!prefix.equals("")))
            sb.insert(0, prefix);
        return sb.toString();
    }

    public Localizer getLocalizer() {
        if (localizer == null)
            localizer = Application.get().getResourceSettings().getLocalizer();
        return localizer;
    }

    public String getPrefix() {
        return prefix;
    }

    public TooltipBehavior newWithSubstitution(IModel<?> model) {
        return new TooltipBehavior(prefix, id, model);
    }

    public String getTooltip(Component component) {
        return getLocalizer().getStringIgnoreSettings(getResourceKey(component), component, substitutionModel, "");
    }
}