platform-api/src/com/intellij/util/ui/AnimatedIcon.java

   1 /*
   2  * Copyright 2000-2007 JetBrains s.r.o.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package com.intellij.util.ui;
  18
  19 import com.intellij.openapi.Disposable;
  20
  21 import javax.swing.*;
  22 import java.awt.*;
  23
  24 public abstract class AnimatedIcon extends JComponent implements Disposable {
  25
  26   private Icon[] myIcons;
  27   private Dimension myPrefSize = new Dimension();
  28
  29   private int myCurrentIconIndex;
  30
  31   private Icon myPassiveIcon;
  32
  33   private Icon myEmptyPassiveIcon;
  34   private boolean myPaintPassive = true;
  35
  36   private boolean myRunning = true;
  37
  38   protected Animator myAnimator;
  39
  40   private final String myName;
  41
  42   private boolean myLastPaintWasRunning;
  43
  44   protected AnimatedIcon(final String name) {
  45     myName = name;
  46   }
  47
  48   protected final void init(Icon[] icons, Icon passiveIcon, int cycleLength, final int interCycleGap, final int maxRepeatCount) {
  49     myIcons = icons;
  50     myPassiveIcon = passiveIcon;
  51
  52     myPrefSize = new Dimension();
  53     for (Icon each : icons) {
  54       myPrefSize.width = Math.max(each.getIconWidth(), myPrefSize.width);
  55       myPrefSize.height = Math.max(each.getIconHeight(), myPrefSize.height);
  56     }
  57
  58     myPrefSize.width = Math.max(passiveIcon.getIconWidth(), myPrefSize.width);
  59     myPrefSize.height = Math.max(passiveIcon.getIconHeight(), myPrefSize.height);
  60
  61     UIUtil.removeQuaquaVisualMarginsIn(this);
  62
  63     myAnimator = new Animator(myName, icons.length, cycleLength, true, interCycleGap, maxRepeatCount) {
  64       public void paintNow(final float frame, final float totalFrames, final float cycle) {
  65         myCurrentIconIndex = (int)frame;
  66         paintImmediately(0, 0, getWidth(), getHeight());
  67       }
  68
  69       protected void onAnimationMaxCycleReached() throws InterruptedException {
  70         AnimatedIcon.this.onAnimationMaxCycleReached();
  71       }
  72
  73       public boolean isAnimated() {
  74         return AnimatedIcon.this.isAnimated();
  75       }
  76     };
  77
  78
  79     if (icons.length > 0) {
  80       myEmptyPassiveIcon = new EmptyIcon(icons[0]);
  81     } else {
  82       myEmptyPassiveIcon = new EmptyIcon(0);
  83     }
  84
  85     setOpaque(true);
  86   }
  87
  88   public void setPaintPassiveIcon(boolean paintPassive) {
  89     myPaintPassive = paintPassive;
  90   }
  91
  92   protected void onAnimationMaxCycleReached() throws InterruptedException {
  93
  94   }
  95
  96   private boolean ensureAnimation(boolean running) {
  97     boolean changes = myAnimator.isRunning() != running;
  98
  99     if (running) {
 100       setOpaque(true);
 101       myAnimator.resume();
 102     } else {
 103       setOpaque(myPaintPassive);
 104       myAnimator.suspend();
 105     }
 106
 107     return changes;
 108   }
 109
 110   public void addNotify() {
 111     super.addNotify();
 112     if (myRunning) {
 113       ensureAnimation(true);
 114     }
 115   }
 116
 117   public void removeNotify() {
 118     super.removeNotify();
 119     ensureAnimation(false);
 120   }
 121
 122   public void resume() {
 123     myRunning = true;
 124     ensureAnimation(true);
 125   }
 126
 127   public void suspend() {
 128     myRunning = false;
 129     if (ensureAnimation(false)) {
 130       repaint();
 131     }
 132   }
 133
 134   public void dispose() {
 135     myAnimator.dispose();
 136   }
 137
 138   public Dimension getPreferredSize() {
 139     final Insets insets = getInsets();
 140     return new Dimension(myPrefSize.width + insets.left + insets.right, myPrefSize.height + insets.top + insets.bottom);
 141   }
 142
 143   public Dimension getMinimumSize() {
 144     return getPreferredSize();
 145   }
 146
 147   public Dimension getMaximumSize() {
 148     return getPreferredSize();
 149   }
 150
 151   protected void paintComponent(Graphics g) {
 152     if (isOpaque() && (myAnimator.isRunning() || myPaintPassive || (myLastPaintWasRunning && !myAnimator.isRunning()))) {
 153       g.setColor(UIUtil.getBgFillColor(this));
 154       g.fillRect(0, 0, getWidth(), getHeight());
 155     }
 156
 157     Icon icon;
 158
 159     if (myAnimator.isRunning()) {
 160       icon = myIcons[myCurrentIconIndex];
 161     } else {
 162       icon = getPassiveIcon();
 163     }
 164
 165     final Dimension size = getSize();
 166     int x = (size.width - icon.getIconWidth()) / 2;
 167     int y = (size.height - icon.getIconHeight()) / 2;
 168
 169     icon.paintIcon(this, g, x, y);
 170
 171     myLastPaintWasRunning = myAnimator.isRunning();
 172   }
 173
 174   protected Icon getPassiveIcon() {
 175     return myPaintPassive ? myPassiveIcon : myEmptyPassiveIcon;
 176   }
 177
 178
 179   public boolean isAnimated() {
 180     return true;
 181   }
 182 }