| /* |
| * Copyright 2000-2014 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.ui.speedSearch; |
| |
| import com.intellij.openapi.actionSystem.DataKey; |
| import com.intellij.openapi.util.Key; |
| import com.intellij.openapi.util.TextRange; |
| import org.jetbrains.annotations.NotNull; |
| import org.jetbrains.annotations.Nullable; |
| |
| import javax.swing.*; |
| import java.beans.PropertyChangeEvent; |
| import java.beans.PropertyChangeListener; |
| |
| /** |
| * @author spLeaner |
| * @author Konstantin Bulenkov |
| */ |
| public abstract class SpeedSearchSupply { |
| /** |
| * Client property key to use in jcomponents for passing the actual search query to renderers |
| */ |
| public static final String SEARCH_QUERY_KEY = "SEARCH_QUERY"; |
| private static final Key SPEED_SEARCH_COMPONENT_MARKER = new Key("SPEED_SEARCH_COMPONENT_MARKER"); |
| public static final DataKey<String> SPEED_SEARCH_CURRENT_QUERY = DataKey.create("SPEED_SEARCH_CURRENT_QUERY"); |
| |
| @Nullable |
| public static SpeedSearchSupply getSupply(@NotNull final JComponent component) { |
| return getSupply(component, false); |
| } |
| |
| @Nullable |
| public static SpeedSearchSupply getSupply(@NotNull final JComponent component, boolean evenIfInactive) { |
| SpeedSearchSupply speedSearch = (SpeedSearchSupply)component.getClientProperty(SPEED_SEARCH_COMPONENT_MARKER); |
| |
| if (evenIfInactive) { |
| return speedSearch; |
| } |
| |
| return speedSearch != null && speedSearch.isPopupActive() ? speedSearch : null; |
| } |
| |
| @Nullable |
| public abstract Iterable<TextRange> matchingFragments(@NotNull final String text); |
| |
| /** |
| * Selects element according to search criteria changes |
| */ |
| public abstract void refreshSelection(); |
| |
| public abstract boolean isPopupActive(); |
| |
| @Nullable |
| public String getEnteredPrefix() { |
| return null; |
| } |
| |
| protected void installSupplyTo(final JComponent component) { |
| component.putClientProperty(SPEED_SEARCH_COMPONENT_MARKER, this); |
| addChangeListener(new PropertyChangeListener() { |
| @Override |
| public void propertyChange(PropertyChangeEvent evt) { |
| component.repaint(); |
| } |
| }); |
| } |
| |
| public abstract void addChangeListener(@NotNull PropertyChangeListener listener); |
| public abstract void removeChangeListener(@NotNull PropertyChangeListener listener); |
| } |