org.pushingpixels.lafwidget.LafWidget Maven / Gradle / Ivy
Show all versions of laf-widget Show documentation
/*
* Copyright (c) 2005-2010 Laf-Widget Kirill Grouchnikov. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of Laf-Widget Kirill Grouchnikov nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.lafwidget;
import java.util.Locale;
import javax.swing.JComponent;
import javax.swing.JPasswordField;
import javax.swing.UIManager;
import org.pushingpixels.lafwidget.preview.DefaultPreviewPainter;
import org.pushingpixels.lafwidget.preview.PreviewPainter;
import org.pushingpixels.lafwidget.tabbed.DefaultTabPreviewPainter;
import org.pushingpixels.lafwidget.tabbed.TabHoverPreviewWidget;
import org.pushingpixels.lafwidget.tabbed.TabOverviewDialogWidget;
import org.pushingpixels.lafwidget.tabbed.TabPreviewPainter;
import org.pushingpixels.lafwidget.text.LockBorderWidget;
import org.pushingpixels.lafwidget.text.PasswordStrengthChecker;
/**
* Interface for LAF widgets (behavioural traits).
*
* @author Kirill Grouchnikov
*/
public interface LafWidget {
/**
*
* Client property name for specifying that the {@link LockBorderWidget}
* should put a lock icon. This property can be set either on a single
* component or globally on {@link UIManager}. The value in both cases
* should be either {@link Boolean#TRUE} or {@link Boolean#FALSE}.
*
*
* @since 3.2
*/
public final static String HAS_LOCK_ICON = "lafwidgets.hasLockIcon";
/**
*
* Client property name for specifying the preview painter for tabbed pane.
* This property can be set on a single tabbed pane. The value should be an
* instance of {@link TabPreviewPainter}. Default implementation of this
* {@link DefaultTabPreviewPainter}. Tabbed panes that have associated
* preview painters, have two widgets installed:
*
*
* - Tab overview dialog from {@link TabOverviewDialogWidget}.
* - Tab hover preview from {@link TabHoverPreviewWidget}.
*
*
*
* Here is an example of tabbed pane with default tab preview painter
* installed:
*
*
*
* JTabbedPane jtp = new JTabbedPane();
* jtp.putClientProperty(LafWidget.TABBED_PANE_PREVIEW_PAINTER,
* new DefaultTabPreviewPainter());
*
*/
public final static String TABBED_PANE_PREVIEW_PAINTER = "lafwidgets.tabbedpanePreviewPainter";
/**
*
* Client property name for specifying the preview painter for a component.
* This property can be set either on a component or globally on
* {@link UIManager}. The value in both cases should be an instance of
* {@link PreviewPainter}. Default implementation is available in the
* {@link DefaultPreviewPainter}.
*
*
*
* Here is an example of a scroll pane with default preview painter
* installed on the internal component:
*
*
*
* JPanel myPanel = new JPanel();
* myPanel.putClientProperty(LafWidget.PANE_PREVIEW_PAINTER,
* new DefaultPreviewPainter());
* JScrollPane jsp = new JScrollPane(myPanel);
*
*/
public final static String COMPONENT_PREVIEW_PAINTER = "lafwidgets.componentPreviewPainter";
/**
*
* Client property name for specifying password strength checker for a
* password field. The value should be an instance of
* {@link PasswordStrengthChecker}, otherwise will be ignored. This property
* must be set on a specific {@link JPasswordField}. Here is an example:
*
*
*
* JPasswordField jpf = new JPasswordField("password", 10);
* jpf.putClientProperty(LafWidget.PASSWORD_STRENGTH_CHECKER,
* new PasswordStrengthChecker() {
* public PasswordStrength getStrength(char[] password) {
* if (password == null)
* return PasswordStrength.WEAK;
* int length = password.length;
* if (length < 3)
* return PasswordStrength.WEAK;
* if (length < 6)
* return PasswordStrength.MEDIUM;
* return PasswordStrength.STRONG;
* }
*
* public String getDescription(PasswordStrength strength) {
* if (strength == PasswordStrength.WEAK)
* return "<html>This password is <b>way</b> too weak</html>";
* if (strength == PasswordStrength.MEDIUM)
* return "<html>Come on, you can do<br> a little better than that</html>";
* if (strength == PasswordStrength.STRONG)
* return "OK";
* return null;
* }
* });
*
*/
public final static String PASSWORD_STRENGTH_CHECKER = "lafwidgets.passwordStrengthChecker";
/**
*
* Client property name for specifying that the text component contents
* should be selected on focus gain. This property can be set either on a
* single text component or globally on {@link UIManager}. The value in both
* cases should be either {@link Boolean#TRUE} or {@link Boolean#FALSE}.
*
*
*
* Here is an example of globally set property (all text components that
* don't specify {@link Boolean#FALSE} as a client property will have the
* "select all on focus gain" behaviour):
*
*
*
* UIManager.put(LafWidget.TEXT_SELECT_ON_FOCUS, Boolean.TRUE);
*
*/
public final static String TEXT_SELECT_ON_FOCUS = "lafwidgets.textSelectAllOnFocus";
/**
*
* Client property name for specifying that the text component contents
* should flip selection on ESCAPE key press. This property can be set on a
* single text component. The value should be either {@link Boolean#TRUE} or
* {@link Boolean#FALSE}.
*
*
*
* Here is an example of this property set on this specific text field:
*
*
*
* myTextField.put(LafWidget.TEXT_FLIP_SELECT_ON_ESCAPE, Boolean.TRUE);
*
*/
public final static String TEXT_FLIP_SELECT_ON_ESCAPE = "lafwidgets.textFlipSelectOnEscape";
/**
*
* Client property name for specifying that the text component should have
* the edit context menu (with Cut / Copy / Paste / ... menu items). This
* property can be set either on a single text component or globally on
* {@link UIManager}. The value in both cases should be either
* {@link Boolean#TRUE} or {@link Boolean#FALSE}.
*
*
*
* Here is an example of globally set property (all text components that
* don't specify {@link Boolean#FALSE} as a client property will have the
* the edit context menu):
*
*
*
* UIManager.put(LafWidget.TEXT_EDIT_CONTEXT_MENU, Boolean.TRUE);
*
*/
public final static String TEXT_EDIT_CONTEXT_MENU = "lafwidgets.textEditContextMenu";
/**
* Client property name for specifying that the tree component should have
* automatic drag and drop support. This property can be set either on a
* single tree or globally on {@link UIManager}. The value in both cases
* should be either {@link Boolean#TRUE} or {@link Boolean#FALSE}.
*
* Here is an example of globally set property (all trees that don't specify
* {@link Boolean#FALSE} as a client property will have the automatic drag
* and drop support):
*
*
* UIManager.put(LafWidget.TREE_AUTO_DND_SUPPORT, Boolean.TRUE);
*
*/
public final static String TREE_AUTO_DND_SUPPORT = "lafwidgets.treeAutoDnDSupport";
/**
*
* Client property name for specifying that a scroll pane should have
* auto-scroll support invoked on middle-mouse button click. This property
* can be installed on a single scroll pane or globally on {@link UIManager}
* , and the value should be either {@link Boolean#TRUE} or
* {@link Boolean#FALSE}.
*
*
* Here is an example of a scroll bar that has auto-scroll installed.
*
*
* JScrollPane scrollPane = ...
* scrollPane.putClientProperty(LafWidget.AUTO_SCROLL, Boolean.TRUE);
*
*
* @since version 3.4
*/
public final static String AUTO_SCROLL = "lafwidget.scroll.auto";
/**
*
* Client property name for specifying that the label lookup for custom
* widgets and sub-components installed by various UI delegates should
* ignore the global locale (as returned by {@link Locale#getDefault()} and
* use the component-specific locale (as returned by
* {@link JComponent#getLocale()} instead. This property can be installed
* only on a single component, and the value should be either
* {@link Boolean#TRUE} or {@link Boolean#FALSE}.
*
*
*
* Here is an example of menu bar that will be localized according to its
* own locale
*
*
* JMenuBar jmb = ...
* jmb.putClientProperty(LafWidget.IGNORE_GLOBAL_LOCALE, Boolean.TRUE);
*
*
* @since version 3.1
*/
public final static String IGNORE_GLOBAL_LOCALE = "lafwidgets.ignoreGlobalLocale";
/**
* Associates a component with this widget.
*
* @param jcomp
* Component.
*/
public void setComponent(T jcomp);
/**
* Returns indication whether this widget requires custom LAF
* support. Some widgets such as {@link TabOverviewDialogWidget} or
* {@link TabHoverPreviewWidget} require custom implementation based on the
* internals of the specific LAF. Relevant functions in the base
* {@link LafWidgetSupport} support throw
* {@link UnsupportedOperationException}.
*
* @return true if this widget requires custom LAF
* support, false otherwise.
*/
public boolean requiresCustomLafSupport();
/**
* Installs UI on the associated component.
*/
public void installUI();
/**
* Installs default settings for the associated component.
*/
public void installDefaults();
/**
* Installs listeners for the associated component.
*/
public void installListeners();
/**
* Installs components for the associated component.
*/
public void installComponents();
/**
* Uninstalls UI on the associated component.
*/
public void uninstallUI();
/**
* Uninstalls default settings for the associated component.
*/
public void uninstallDefaults();
/**
* Uninstalls listeners for the associated component.
*/
public void uninstallListeners();
/**
* Uninstalls components for the associated component.
*/
public void uninstallComponents();
}