com.lf.commons.gui

Class HighlightingUtils

java.lang.Object

com.lf.commons.gui.HighlightingUtils

public class HighlightingUtils
extends java.lang.Object

Searching components for patterns and highlights the results (may be reset also).

Since:

1.6

Version:

$Revision: 1.7 $, $Date: 2012/12/28 11:44:25 $

Author:

Axel Schwolow

Constructor Summary

Constructors

Constructor and Description
HighlightingUtils() Constructor method for i18n purposes only.

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	getHighlightHTML(java.lang.String text) Convenience to highlight text using HTML tags.
static void	reset(java.awt.Component comp, java.lang.String pattern) Resets the component so that it does not highlight the results any longer.
static void	resetAllComponents(java.util.Vector<java.awt.Component> comps, java.lang.String pattern) Resets the set of GUI components highlighting search results.
static void	resetCheckBox(javax.swing.JCheckBox comp, java.lang.String pattern) Resets the component so that it does not highlight the results any longer.
static void	resetComboBox(javax.swing.JComboBox comp, java.lang.String pattern) Resets the component so that it does not highlight the results any longer.
static void	resetLabel(javax.swing.JLabel comp, java.lang.String pattern) Resets the component so that it does not highlight the results any longer.
static void	resetRadioButton(javax.swing.JRadioButton comp, java.lang.String pattern) Resets the component so that it does not highlight the results any longer.
static void	resetTabbedPane(javax.swing.JTabbedPane comp, java.lang.String pattern) Resets the component so that it does not highlight the results any longer.
static void	resetTable(javax.swing.JTable comp, java.lang.String pattern) Resets the component so that it does not highlight the results any longer.
static void	resetTextField(javax.swing.JTextField comp, java.lang.String pattern) Resets the component so that it does not highlight the results any longer.
static void	resetTitledBorder(java.awt.Component comp, java.lang.String pattern) Resets the component so that it does not highlight the results any longer.
static void	resetToggleButton(javax.swing.JToggleButton comp, java.lang.String pattern) Resets the component so that it does not highlight the results any longer.
static boolean	search(java.awt.Component comp, java.lang.String pattern) Searches an arbitrary component for the given pattern.
static void	searchAllComponents(java.util.Vector<java.awt.Component> comps, java.lang.String pattern) Searches the children of the given GUI component for pattern matches and highlights them.
static boolean	searchCheckBox(javax.swing.JCheckBox comp, java.lang.String pattern) Searches a component for the given pattern.
static boolean	searchComboBox(javax.swing.JComboBox comp, java.lang.String pattern) Searches a component for the given pattern.
static boolean	searchLabel(javax.swing.JLabel comp, java.lang.String pattern) Searches a component for the given pattern.
static boolean	searchRadioButton(javax.swing.JRadioButton comp, java.lang.String pattern) Searches a component for the given pattern.
static boolean	searchTabbedPane(javax.swing.JTabbedPane comp, java.lang.String pattern) Searches a component for the given pattern.
static boolean	searchTable(javax.swing.JTable comp, java.lang.String pattern) Searches a component for the given pattern.
static boolean	searchText(java.lang.String text, java.awt.Component comp, java.lang.String pattern) Searches a component's text for the given pattern (convenience for text components).
static boolean	searchTextField(javax.swing.JTextField comp, java.lang.String pattern) Searches a component for the given pattern.
static boolean	searchTitledBorder(java.awt.Component comp, java.lang.String pattern) Searches a component for the given pattern.
static boolean	searchToggleButton(javax.swing.JToggleButton comp, java.lang.String pattern) Searches a component for the given pattern.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HighlightingUtils

public HighlightingUtils()
                  throws java.lang.InstantiationException

Constructor method for i18n purposes only.

Can only be used if beans design time is set (e.g. by external tools like the I18NExtractor).

Throws:

java.lang.InstantiationException - Error indication

Since:

1.6

Method Detail

searchAllComponents

public static void searchAllComponents(java.util.Vector<java.awt.Component> comps,
                       java.lang.String pattern)

Searches the children of the given GUI component for pattern matches and highlights them.

If type is null, all components are collected.

Parameters:

comps - Container with components, non-matching components are removed

pattern - The search pattern

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6

See Also:

resetAllComponents(java.util.Vector, String)

resetAllComponents

public static void resetAllComponents(java.util.Vector<java.awt.Component> comps,
                      java.lang.String pattern)

Resets the set of GUI components highlighting search results.

The given container is not cleared here.

Parameters:

comps - Container with matching components to be reset

pattern - The search pattern

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6

See Also:

searchAllComponents(Vector, String)

search

public static boolean search(java.awt.Component comp,
             java.lang.String pattern)

Searches an arbitrary component for the given pattern.

This method should not be used since the performance of this method is not as well as when using the search method for the well-known component types. This method has to determine the component type by conditional branches and that slows the operation down.

Parameters:

comp - The component to be searched

pattern - The search pattern

Returns:

Matched pattern and activated highlighting?

Throws:

java.lang.IllegalArgumentException - If the component is not currently supported

Since:

1.6

searchText

public static boolean searchText(java.lang.String text,
                 java.awt.Component comp,
                 java.lang.String pattern)

Searches a component's text for the given pattern (convenience for text components).

Parameters:

text - The component text

comp - The component to be highlighted

pattern - The search pattern

Returns:

Matched pattern and activated highlighting?

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

searchCheckBox

public static boolean searchCheckBox(javax.swing.JCheckBox comp,
                     java.lang.String pattern)

Searches a component for the given pattern.

Parameters:

comp - The component to be searched

pattern - The search pattern

Returns:

Matched pattern and activated highlighting?

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

searchLabel

public static boolean searchLabel(javax.swing.JLabel comp,
                  java.lang.String pattern)

Searches a component for the given pattern.

Parameters:

comp - The component to be searched

pattern - The search pattern

Returns:

Matched pattern and activated highlighting?

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

searchRadioButton

public static boolean searchRadioButton(javax.swing.JRadioButton comp,
                        java.lang.String pattern)

Searches a component for the given pattern.

Parameters:

comp - The component to be searched

pattern - The search pattern

Returns:

Matched pattern and activated highlighting?

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

searchToggleButton

public static boolean searchToggleButton(javax.swing.JToggleButton comp,
                         java.lang.String pattern)

Searches a component for the given pattern.

Parameters:

comp - The component to be searched

pattern - The search pattern

Returns:

Matched pattern and activated highlighting?

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

searchTextField

public static boolean searchTextField(javax.swing.JTextField comp,
                      java.lang.String pattern)

Searches a component for the given pattern.

Parameters:

comp - The component to be searched

pattern - The search pattern

Returns:

Matched pattern and activated highlighting?

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

searchComboBox

public static boolean searchComboBox(javax.swing.JComboBox comp,
                     java.lang.String pattern)

Searches a component for the given pattern.

Parameters:

comp - The component to be searched

pattern - The search pattern

Returns:

Matched pattern and activated highlighting?

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

searchTable

public static boolean searchTable(javax.swing.JTable comp,
                  java.lang.String pattern)

Searches a component for the given pattern.

The cell renderers must be subclasses of HighlightingRenderer.

Parameters:

comp - The component to be searched

pattern - The search pattern

Returns:

Matched pattern and activated highlighting?

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

searchTabbedPane

public static boolean searchTabbedPane(javax.swing.JTabbedPane comp,
                       java.lang.String pattern)

Searches a component for the given pattern.

Parameters:

comp - The component to be searched

pattern - The search pattern

Returns:

Matched pattern and activated highlighting?

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

searchTitledBorder

public static boolean searchTitledBorder(java.awt.Component comp,
                         java.lang.String pattern)

Searches a component for the given pattern.

The TitledBorder isn't really a component but still helpful to be highlighted if the text matches.

Parameters:

comp - The component to be highlighted

pattern - The search pattern

Returns:

Matched pattern and activated highlighting?

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

reset

public static void reset(java.awt.Component comp,
         java.lang.String pattern)

Resets the component so that it does not highlight the results any longer.

Parameters:

comp - The component to be reset

pattern - The search pattern

Throws:

java.lang.IllegalArgumentException - If the component is not currently supported

java.lang.NullPointerException - If parameters are null

Since:

1.6

resetCheckBox

public static void resetCheckBox(javax.swing.JCheckBox comp,
                 java.lang.String pattern)

Resets the component so that it does not highlight the results any longer.

Parameters:

comp - The component to be reset

pattern - The search pattern

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

resetLabel

public static void resetLabel(javax.swing.JLabel comp,
              java.lang.String pattern)

Resets the component so that it does not highlight the results any longer.

Parameters:

comp - The component to be reset

pattern - The search pattern

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

resetRadioButton

public static void resetRadioButton(javax.swing.JRadioButton comp,
                    java.lang.String pattern)

Resets the component so that it does not highlight the results any longer.

Parameters:

comp - The component to be reset

pattern - The search pattern

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

resetToggleButton

public static void resetToggleButton(javax.swing.JToggleButton comp,
                     java.lang.String pattern)

Resets the component so that it does not highlight the results any longer.

Parameters:

comp - The component to be reset

pattern - The search pattern

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

resetTextField

public static void resetTextField(javax.swing.JTextField comp,
                  java.lang.String pattern)

Resets the component so that it does not highlight the results any longer.

Parameters:

comp - The component to be reset

pattern - The search pattern

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

resetComboBox

public static void resetComboBox(javax.swing.JComboBox comp,
                 java.lang.String pattern)

Resets the component so that it does not highlight the results any longer.

Parameters:

comp - The component to be reset

pattern - The search pattern

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

resetTable

public static void resetTable(javax.swing.JTable comp,
              java.lang.String pattern)

Resets the component so that it does not highlight the results any longer.

Parameters:

comp - The component to be reset

pattern - The search pattern

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

resetTabbedPane

public static void resetTabbedPane(javax.swing.JTabbedPane comp,
                   java.lang.String pattern)

Resets the component so that it does not highlight the results any longer.

Parameters:

comp - The component to be reset

pattern - The search pattern

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

resetTitledBorder

public static void resetTitledBorder(java.awt.Component comp,
                     java.lang.String pattern)

Resets the component so that it does not highlight the results any longer.

The TitledBorder isn't really a component but still helpful to be highlighted if the text matches.

Parameters:

comp - The component to be reset

pattern - The search pattern

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

getHighlightHTML

public static java.lang.String getHighlightHTML(java.lang.String text)

Convenience to highlight text using HTML tags.

Parameters:

text - The plain text, filtered for HTML tags before

Returns:

The HTML text

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6