HTMLComposer.java

/*
 * Copyright 2000-2012 JetBrains s.r.o.
 *
 * 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.intellij.codeInspection;

import com.intellij.codeInspection.reference.RefElement;
import com.intellij.openapi.util.Key;
import com.intellij.util.ui.UIUtil;
import org.jetbrains.annotations.NonNls;

public abstract class HTMLComposer {
  public abstract void appendElementReference(StringBuffer buf, RefElement refElement, String linkText, @NonNls String frameName);

  public abstract void appendElementReference(StringBuffer buf, String url, String linkText, @NonNls String frameName);

  public abstract void appendElementInReferences(StringBuffer buf, RefElement refElement);

  public abstract void appendElementOutReferences(StringBuffer buf, RefElement refElement);

  public abstract void appendElementReference(StringBuffer buf, RefElement refElement);

  public abstract void appendListItem(StringBuffer buf, RefElement refElement);

  public static void appendHeading(@NonNls StringBuffer buf, String name){
    buf.append("<p class=\"problem-description-group\">")
       .append(name)
       .append("</p>");
  }

  public abstract void appendElementReference(StringBuffer buf, RefElement refElement, boolean isPackageIncluded);

  public abstract String composeNumereables(int n, String statement, String singleEnding, String multipleEnding);

  public abstract void startList(@NonNls StringBuffer buf);

  public abstract void doneList(@NonNls StringBuffer buf);

  public abstract void startListItem(@NonNls StringBuffer buf);

  /**
   * Use css for indentations
   */
  @Deprecated
  public static void appendAfterHeaderIndention(@NonNls StringBuffer buf) {
    buf.append("     ");
  }

  public abstract void appendNoProblems(StringBuffer buf);

  public abstract <T> T getExtension(Key<T> key);
}