android/src/com/android/tools/idea/editors/theme/ui/ResourceComponent.java

/*
 * Copyright (C) 2015 The Android Open Source Project
 *
 * 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.android.tools.idea.editors.theme.ui;

import com.android.tools.swing.ui.ClickableLabel;
import com.android.tools.swing.ui.SwatchComponent;
import com.intellij.openapi.ui.ValidationInfo;
import com.intellij.ui.JBColor;
import com.intellij.util.ui.JBUI;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import javax.swing.Action;
import javax.swing.BorderFactory;
import javax.swing.Box;
import javax.swing.BoxLayout;
import javax.swing.ComboBoxModel;
import javax.swing.DefaultComboBoxModel;
import javax.swing.JPanel;
import javax.swing.JPopupMenu;
import javax.swing.SwingUtilities;
import java.awt.BorderLayout;
import java.awt.Dimension;
import java.awt.Font;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.ItemListener;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.util.List;

/**
 * Component for displaying a color or a drawable resource with attribute name, type and value text.
 */
public class ResourceComponent extends JPanel {

  /**
   * Maximum number of swatch icons to be displayed by default. See {@link SwatchComponent} constructor for more details.
   */
  private static final short MAX_SWATCH_ICONS = 3;
  /**
   * ResourceComponent top + bottom margins
   */
  private static final int MARGIN = JBUI.scale(20);
  /**
   * Gap between the two rows of the component
   */
  private static final int ROW_GAP = JBUI.scale(8);

  private final SwatchComponent mySwatchComponent = new SwatchComponent(MAX_SWATCH_ICONS);
  private final ClickableLabel myNameLabel = new ClickableLabel();
  private final VariantsComboBox myVariantCombo = new VariantsComboBox();

  public ResourceComponent() {
    super(new BorderLayout(0, ROW_GAP));
    setBorder(BorderFactory.createEmptyBorder(MARGIN / 2, 0, MARGIN / 2, 0));

    Box topRowPanel = new Box(BoxLayout.LINE_AXIS);
    topRowPanel.add(myNameLabel);
    topRowPanel.add(Box.createHorizontalGlue());
    topRowPanel.add(myVariantCombo);
    add(topRowPanel, BorderLayout.CENTER);

    mySwatchComponent.setBackground(JBColor.WHITE);
    mySwatchComponent.setForeground(null);
    add(mySwatchComponent, BorderLayout.SOUTH);
  }

  @Override
  public Dimension getPreferredSize() {
    if (!isPreferredSizeSet()) {
      int firstRowHeight = Math.max(getFontMetrics(getFont()).getHeight(), myVariantCombo.getPreferredSize().height);
      int secondRowHeight = mySwatchComponent.getPreferredSize().height;

      return new Dimension(0, MARGIN + ROW_GAP + firstRowHeight + secondRowHeight);
    }

    return super.getPreferredSize();
  }

  public void setSwatchIcons(@NotNull List<SwatchComponent.SwatchIcon> icons) {
    mySwatchComponent.setSwatchIcons(icons);
  }

  public void setNameText(@NotNull String name) {
    myNameLabel.setText(name);
  }

  public void setVariantsModel(@Nullable ComboBoxModel comboBoxModel) {
    myVariantCombo.setModel(comboBoxModel != null ? comboBoxModel : new DefaultComboBoxModel());
  }

  public void addVariantItemListener(@NotNull ItemListener itemListener) {
    myVariantCombo.addItemListener(itemListener);
  }

  public void setValueText(@NotNull String value) {
    mySwatchComponent.setText(value);
  }

  @NotNull
  public String getValueText() {
    return mySwatchComponent.getText();
  }

  @Override
  public void setFont(final Font font) {
    super.setFont(font);
    // We need a null check here as this can be called from the setUI that's called from the constructor.
    if (mySwatchComponent != null) {
      mySwatchComponent.setFont(font);
    }
  }

  @Override
  public void setComponentPopupMenu(JPopupMenu popup) {
    super.setComponentPopupMenu(popup);
    myNameLabel.setComponentPopupMenu(popup);
    mySwatchComponent.setComponentPopupMenu(popup);
  }

  public void addActionListener(final ActionListener listener) {
    myNameLabel.addActionListener(listener);
    mySwatchComponent.addActionListener(listener);
    addMouseListener(new MouseAdapter() {
      @Override
      public void mouseReleased(MouseEvent e) {
        if (!contains(e.getPoint()) || !SwingUtilities.isLeftMouseButton(e)) {
          return;
        }
        listener.actionPerformed(new ActionEvent(e.getSource(), ActionEvent.ACTION_PERFORMED, null));
      }
    });
  }

  public void setVariantComboVisible(boolean isVisible) {
    myVariantCombo.setVisible(isVisible);
  }

  /**
   * Returns a {@link ValidationInfo} for the {@link SwatchComponent}.
   */
  @NotNull
  public ValidationInfo createSwatchValidationInfo(@NotNull String errorText) {
    return new ValidationInfo(errorText, mySwatchComponent);
  }

  public void addVariantComboAction(@NotNull Action action) {
    myVariantCombo.addAction(action);
  }
}