TooltipDecorator.java

/**
 *  Copyright 2012 Universitat Pompeu Fabra.
 *
 *  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 org.onexus.website.api.widgets.tableviewer.decorators.tooltip;

import com.google.common.base.Strings;
import org.apache.commons.lang3.StringUtils;
import org.apache.wicket.markup.html.WebMarkupContainer;
import org.apache.wicket.markup.html.basic.Label;
import org.apache.wicket.model.IModel;
import org.onexus.collection.api.Collection;
import org.onexus.collection.api.Field;
import org.onexus.collection.api.IEntity;
import org.onexus.resource.api.ParameterKey;
import org.onexus.resource.api.Parameters;
import org.onexus.website.api.widgets.tableviewer.decorators.IDecorator;

import java.util.Collections;
import java.util.List;
import java.util.Map;

public class TooltipDecorator implements IDecorator {

    private Field field;
    private Parameters parameters;

    public TooltipDecorator(Field field, Parameters parameters) {
        super();
        this.field = field;
        this.parameters = parameters;
    }

    @Override
    public void populateCell(WebMarkupContainer cellContainer, String componentId, IModel<IEntity> entity) {
        String value = getFormatValue(entity.getObject());


        int length = 15;
        if (parameters.containsKey(TooltipDecoratorParameters.LENGTH)) {
            length = Integer.valueOf(parameters.get(TooltipDecoratorParameters.LENGTH));
        }

        String tooltip = value;
        // Abbreviate only if value is longer than max length
        if (value != null && value.length() > length) {
            tooltip = abbreviate(value, length) +
                    "<i class=\"" + parameters.get(TooltipDecoratorParameters.ICON) +
                    "\" data-placement=\"" + parameters.get(TooltipDecoratorParameters.PLACEMENT) +
                    "\" rel=\"tooltip\" title=\"" + value +
                    "\" style=\"opacity: " + parameters.get(TooltipDecoratorParameters.OPACITY) +
                    "\"></i>";
        }

        cellContainer.add(new Label(componentId, tooltip).setEscapeModelStrings(false).setVisible(value != null));
    }

    @Override
    public String getFormatValue(IEntity entity) {
        if (entity == null) {
            return null;
        }

        Object value = entity.get(field.getId());
        if (value == null) {
            return null;
        }

        return String.valueOf(value);
    }


    @Override
    public String getColor(IEntity entity) {
        return "#000000";
    }

    @Override
    public String getTemplate() {
        return null;
    }

    @Override
    public void setTemplate(String template) {

    }

    @Override
    public List<String> getExtraFields(Collection collection) {
        return Collections.EMPTY_LIST;
    }

    @Override
    public void detach() {
    }

    private static String abbreviate(String value, int length) {

        if (Strings.isNullOrEmpty(value)) {
            return value;
        }

        // The real string position
        int i = 0;

        // The apparent position without HTML tags
        int h = 0;

        // Maximum position
        int max = value.length();

        boolean insideTag = false;

        while (i < max) {

            char c = value.charAt(i);

            if (c == '<') {
                // Skip the tag
                while (++i < max && value.charAt(i)!='>') {}
                insideTag = !insideTag;
            } else {
                h++;
            }

            if (!insideTag && h >= length) {
                break;
            }

            i++;
        }

        if (i == max) {
            return value;
        }

        return value.substring(0, i) + "...";
    }
}