org.rstudio.studio.client.common.sourcemarkers.SourceMarkerItemCodec.java Source code

Java tutorial

Introduction

Here is the source code for org.rstudio.studio.client.common.sourcemarkers.SourceMarkerItemCodec.java

Source

/*
 * SourceMarkerItemCodec.java
 *
 * Copyright (C) 2009-12 by RStudio, Inc.
 *
 * Unless you have received this program directly from RStudio pursuant
 * to the terms of a commercial license agreement with RStudio, then
 * this program is licensed to you under the terms of version 3 of the
 * GNU Affero General Public License. This program is distributed WITHOUT
 * ANY EXPRESS OR IMPLIED WARRANTY, INCLUDING THOSE OF NON-INFRINGEMENT,
 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Please refer to the
 * AGPL (http://www.gnu.org/licenses/agpl-3.0.txt) for more details.
 *
 */
package org.rstudio.studio.client.common.sourcemarkers;

import com.google.gwt.dom.client.*;

import org.rstudio.core.client.CodeNavigationTarget;
import org.rstudio.core.client.FilePosition;
import org.rstudio.core.client.StringUtil;
import org.rstudio.core.client.theme.res.ThemeResources;
import org.rstudio.core.client.widget.FontSizer;
import org.rstudio.core.client.widget.HeaderBreaksItemCodec;

public class SourceMarkerItemCodec
        extends HeaderBreaksItemCodec<SourceMarker, CodeNavigationTarget, CodeNavigationTarget> {
    public SourceMarkerItemCodec(SourceMarkerListResources resources, boolean showFileHeaders) {
        resources_ = resources;
        showFileHeaders_ = showFileHeaders;
    }

    public boolean getShowFileHandlers() {
        return showFileHeaders_;
    }

    public void setShowFileHeaders(boolean show) {
        showFileHeaders_ = show;
    }

    public void setFileHeaderBasePath(String basePath) {
        fileHeaderBasePath_ = basePath;
    }

    @Override
    public TableRowElement getRowForItem(SourceMarker entry) {
        TableRowElement tr = Document.get().createTRElement();
        tr.addClassName(ThemeResources.INSTANCE.themeStyles().fixedWidthFont());
        FontSizer.applyNormalFontSize(tr);

        tr.setAttribute(DATA_PATH, entry.getPath());
        tr.setAttribute(DATA_LINE, entry.getLine() + "");
        tr.setAttribute(DATA_COLUMN, entry.getColumn() + "");
        tr.setAttribute(LOG_PATH, entry.getLogPath());
        tr.setAttribute(LOG_LINE, entry.getLogLine() + "");

        TableCellElement tdIcon = Document.get().createTDElement();
        tdIcon.setClassName(resources_.styles().iconCell());
        DivElement iconDiv = Document.get().createDivElement();
        iconDiv.setClassName(
                entry.getType() == SourceMarker.ERROR ? resources_.styles().errorIcon()
                        : entry.getType() == SourceMarker.WARNING ? resources_.styles().warningIcon()
                                : entry.getType() == SourceMarker.BOX ? resources_.styles().boxIcon()
                                        : entry.getType() == SourceMarker.INFO ? resources_.styles().infoIcon()
                                                : entry.getType() == SourceMarker.STYLE
                                                        ? resources_.styles().styleIcon()
                                                        : "");
        tdIcon.appendChild(iconDiv);
        if (entry.getType() == SourceMarker.USAGE)
            tdIcon.addClassName(resources_.styles().noIcon());
        tr.appendChild(tdIcon);

        TableCellElement tdLine = Document.get().createTDElement();
        tdLine.setClassName(resources_.styles().lineCell());
        if (entry.getLine() >= 0)
            tdLine.setInnerText("Line " + entry.getLine());
        tr.appendChild(tdLine);

        TableCellElement tdMsg = Document.get().createTDElement();
        tdMsg.setClassName(resources_.styles().messageCell());
        tdMsg.setInnerHTML(entry.getMessage());
        tr.appendChild(tdMsg);

        TableCellElement tdDiscButton = maybeCreateDisclosureButton(entry);
        if (tdDiscButton != null)
            tr.appendChild(tdDiscButton);

        return tr;

    }

    protected TableCellElement maybeCreateDisclosureButton(SourceMarker entry) {
        if (entry.getLogLine() != -1) {
            TableCellElement td = Document.get().createTDElement();
            td.setClassName(resources_.styles().disclosure());
            td.setVAlign("middle");

            DivElement div = Document.get().createDivElement();
            div.setTitle("View error or warning within the log file");
            div.setClassName(resources_.styles().disclosure());
            div.addClassName(ThemeResources.INSTANCE.themeStyles().handCursor());

            td.appendChild(div);
            return td;
        } else {
            return null;
        }
    }

    @Override
    protected boolean needsBreak(TableRowElement prevRow, TableRowElement row) {
        if (!showFileHeaders_)
            return false;

        if (prevRow == null)
            return true;

        String a = StringUtil.notNull(row.getAttribute(DATA_PATH));
        String b = StringUtil.notNull(prevRow.getAttribute(DATA_PATH));
        return !a.equals(b);
    }

    @Override
    protected int addBreak(TableRowElement row) {
        TableRowElement headerRow = Document.get().createTRElement();
        headerRow.setClassName(resources_.styles().headerRow());

        TableCellElement cell = Document.get().createTDElement();
        cell.setColSpan(3);

        String path = row.getAttribute(DATA_PATH);
        if (!StringUtil.isNullOrEmpty(fileHeaderBasePath_)) {
            if (path.startsWith(fileHeaderBasePath_))
                path = path.substring(fileHeaderBasePath_.length());
        }
        cell.setInnerText(path);

        headerRow.appendChild(cell);

        row.getParentElement().insertBefore(headerRow, row);

        return 1;
    }

    @Override
    public CodeNavigationTarget getOutputForRow(TableRowElement row) {
        String path = row.getAttribute(DATA_PATH);
        int line = Integer.parseInt(row.getAttribute(DATA_LINE));
        if (line < 0) // If we couldn't figure out the line
            line = 1;
        int column = Integer.parseInt(row.getAttribute(DATA_COLUMN));
        if (column < 0) // If we couldn't figure out the column
            column = 1;

        return new CodeNavigationTarget(path, FilePosition.create(line, column));
    }

    @Override
    public CodeNavigationTarget getOutputForRow2(TableRowElement row) {
        String path = row.getAttribute(LOG_PATH);
        int line = Integer.parseInt(row.getAttribute(LOG_LINE));
        if (line < 0) // If we couldn't figure out the line
            line = 1;
        return new CodeNavigationTarget(path, FilePosition.create(line, 1));
    }

    @Override
    public boolean isValueRow(TableRowElement row) {
        return row.hasAttribute(DATA_LINE);
    }

    @Override
    public boolean hasNonValueRows() {
        return showFileHeaders_;
    }

    private final SourceMarkerListResources resources_;
    private boolean showFileHeaders_;
    private String fileHeaderBasePath_ = null;

    private static final String DATA_PATH = "data-path";
    private static final String DATA_LINE = "data-line";
    private static final String DATA_COLUMN = "data-column";
    private static final String LOG_PATH = "log-path";
    private static final String LOG_LINE = "log-line";
}