Application: gvSIG desktop » Library: org.gvsig.tools

package org.gvsig.tools.swing.api;

import java.awt.Color;

import java.awt.Dimension;

import java.awt.Image;

import java.awt.event.ActionListener;

import java.awt.image.BufferedImage;

import java.io.File;

import javax.swing.AbstractButton;

import javax.swing.ComboBoxModel;

import javax.swing.Icon;

import javax.swing.JButton;

import javax.swing.JComboBox;

import javax.swing.JComponent;

import javax.swing.JLabel;

import javax.swing.JList;

import javax.swing.JSlider;

import javax.swing.JTabbedPane;

import javax.swing.JTable;

import javax.swing.JTree;

import javax.swing.table.TableModel;

import javax.swing.text.JTextComponent;

import javax.swing.tree.TreeModel;

import org.apache.commons.lang3.StringUtils;

import org.gvsig.tools.bookmarksandhistory.Bookmarks;

import org.gvsig.tools.bookmarksandhistory.History;

import org.gvsig.tools.swing.api.bookmarkshistory.BookmarksController;

import org.gvsig.tools.swing.api.bookmarkshistory.HistoryController;

import org.gvsig.tools.swing.api.pickercontroller.ColorPickerController;

import org.gvsig.tools.swing.api.pickercontroller.DataTypePickerController;

import org.gvsig.tools.swing.api.pickercontroller.DatePickerController;

import org.gvsig.tools.swing.api.pickercontroller.FilePickerController;

import org.gvsig.tools.swing.api.pickercontroller.FolderPickerController;

import org.gvsig.tools.swing.api.pickercontroller.PickerController;

public interface ToolsSwingManager {

    public ActionListenerSupport createActionListenerSupport();

    public JListWithCheckbox createJListWithCheckbox(JList wrappedList);

    public void setTreeModel(JComboBox comboBox, TreeModel aTreeModel);

    public ComboBoxModel createComboBoxModel(TreeModel treeModel);

    /**

     * @param txtLabel

     * @param btnShowDialog

     * @param sldAlpha

     * @param allowNull

     * @return 

     * @deprecated use createColorPickerController

     */

    public ColorChooserController createColorChooserController(JTextComponent txtLabel, JButton btnShowDialog, JSlider sldAlpha, boolean allowNull);

    /**

     * @param txtLabel

     * @param btnShowDialog

     * @return 

     * @deprecated use createColorPickerController

     */

    public ColorChooserController createColorChooserController(JTextComponent txtLabel, JButton btnShowDialog);

    /**

     * @param txtLabel

     * @param btnShowDialog

     * @param sldAlpha

     * @return 

     * @deprecated use createColorPickerController

     */

    public ColorChooserController createColorChooserController(JTextComponent txtLabel, JButton btnShowDialog, JSlider sldAlpha);

    /**

     * Create a buffered Image of the given size and type.

     * In this context, buffered image means editable image (admits setRGB etc)

     * If the size is bigger of max physical size of buffered image, creates a file mapped buffered Image.

     *

     * @param w width in pixels of the requested image

     * @param h height in pixels of the requested image

     * @param type image type (refers to bands, etc. see {@link Image}

     * @return a buffered (editable) image of the desired size and type

     * @see setMaxPhysicalSizeOfBufferedImage

     * @see getMaxPhysicalSizeOfBufferedImage

     *

     */

    public BufferedImage createBufferedImage(int w, int h, int type);

    /**

     * Create a file mapped buffered Image of the given size and type.

     * In this context, buffered image means editable image (admits setRGB etc)

     *

     * @param w width in pixels of the requested image

     * @param h height in pixels of the requested image

     * @param type image type (refers to bands, etc. see {@link Image}

     * @return a buffered (editable) image of the desired size and type

     */

    public BufferedImage createVirtualBufferedImage(int w, int h, int type);

    public BufferedImage copyBufferedImage(BufferedImage img);

    /**

     * Sets the max physical size of buffered image creates by this manager.

     *

     * @param dimension

     * @see createBufferedImage

     * @see createVirtualBufferedImage

     */

    public void setMaxPhysicalSizeOfBufferedImage(Dimension dimension);

    /**

     * Return the max physical size of buffered image creates by this manager.

     *

     * @return

     * @see createBufferedImage

     * @see createVirtualBufferedImage

     */

    public Dimension getMaxPhysicalSizeOfBufferedImage();

    /**

     * Alpha blending is the process of combining a translucent foreground color with a background 

     * 

     * https://en.wikipedia.org/wiki/Alpha_compositing#Alpha_blending

     * 

     * @param bgColor

     * @param fgColor

     * @return 

     */    

    public Color alphaBlendingWithOpaqueBackground(Color bgColor, Color fgColor);

    public Color opaqueColor(Color src);

    public void translate(JComponent component);

    public void translate(AbstractButton component);

    public void translate(JLabel component);

    public void translate(JTabbedPane component);

    public void translate(JComponent component, boolean wrap);

    public void translate(AbstractButton component, boolean wrap);

    public void translate(JLabel component, boolean wrap);

    public void translate(JTabbedPane component, boolean wrap);

    public void setDefaultPopupMenu(final JTextComponent component);

    public void setDefaultPopupMenu(final JComboBox component);

    public void setDefaultPopupMenu(final JTextComponent component, String title);    

    public void setDefaultPopupMenu(final JComboBox component, String title);    

    public ChangeListenerHelper createChangeListenerHelper();

    public ColorPickerController createColorPickerController(JTextComponent txtLabel, JButton btnShowDialog, JSlider sldAlpha, boolean allowNull);

    public ColorPickerController createColorPickerController(JTextComponent txtLabel, JButton btnShowDialog);

    public ColorPickerController createColorPickerController(JTextComponent txtLabel, JButton btnShowDialog, JSlider sldAlpha);

    public DatePickerController createDatePickerController(JTextComponent txtDate, JButton btnDate);

    public FilePickerController createFilePickerController(JTextComponent txtFile, JButton btnFile, String dialogTitle, String fileChooserID, File initialPath, boolean seticon);

    public FilePickerController createFilePickerController(JTextComponent txtFile, JButton btnFile);

    public FilePickerController createFilePickerController(JTextComponent txtFile, JButton btnFile, String dialogTitle);

    public FolderPickerController createFolderPickerController(JTextComponent txtFile, JButton btnFile, String dialogTitle, String fileChooserID, File initialPath, boolean seticon);

    public FolderPickerController createFolderPickerController(JTextComponent txtFile, JButton btnFile);

    public FolderPickerController createFolderPickerController(JTextComponent txtFile, JButton btnFile, String dialogTitle);

    public PickerController<byte[]> createByteArrayPickerController(JTextComponent txtText, JButton btnUpload, JButton btnDownload, String fileChooserID, File initialPath);

    public PickerController<byte[]> createByteArrayPickerController(JTextComponent txtText, JButton btnUpload, JButton btnDownload);

    public void removeBorder(JComponent component);

    public void addClearButton(final JTextComponent text,  final ActionListener action);

    public void addClearButton(final JTextComponent text);

    public void addClearButton(JComboBox combo);

    public boolean hasClearButton(final JComboBox combo);

    public boolean hasClearButton(final JTextComponent text);

    public void removeClearButton(final JComboBox combo);

    public void removeClearButton(final JTextComponent text);

    public SimpleImage createSimpleImage();

    public SimpleImage createSimpleImage(Object source);

    public DropDown createDropDown(JComboBox combo);

    public DropDown createDropDown(JLabel label);

    public DropDown createDropDown(AbstractButton button);

    public DropDown createDropDown(JComponent component);

    /**

     * Contructor for creating a CompoundIcon where the icons are

     * layed out HORIZONTAL, the gap is 0 and the X/Y alignments will

     * default to CENTER.

     *

     * @param icons the Icons to be painted as part of the CompoundIcon

     * 

     * @return the CompoundIcon

     */

    public CompoundIcon createCompoundIcon(Icon... icons);

    /**

     * Contructor for creating a CompoundIcon where the gap is 0 and

     * the X/Y alignments will default to CENTER.

     *

     * @param orientation the orientation used to lay out the icons for painting. 

     * Must be one of SwingConstants.HORIZONTAL, SwingConstants.VERTICAL or STACKED.

     * @param icons the Icons to be painted as part of the CompoundIcon

     * 

     * @return the CompoundIcon

     */

    public CompoundIcon createCompoundIcon(int orientation, Icon... icons);

    /**

     * Convenience contructor for creating a CompoundIcon where the X/Y

     * alignments will default to CENTER.

     *

     * @param orientation the orientation used to lay out the icons for painting. 

     * Must be one of SwingConstants.HORIZONTAL, SwingConstants.VERTICAL or STACKED.

     * @param gap the gap between the icons

     * @param icons the Icons to be painted as part of the CompoundIcon

     * 

     * @return the CompoundIcon

     */

    public CompoundIcon createCompoundIcon(int orientation, int gap, Icon... icons);

    /**

     * Create a CompoundIcon specifying all the properties.

     *

     * @param orientation the orientation used to lay out the icons for painting. 

     * Must be one of SwingConstants.HORIZONTAL, SwingConstants.VERTICAL or STACKED.

     * @param gap the gap between the icons

     * @param alignmentX the X alignment of the icons. Common values are SwingConstants.LEFT,

     * SwingConstants.CENTER, SwingConstants.RIGHT.

     * @param alignmentY the Y alignment of the icons. Common values are SwingConstants.TOP,

     * SwingConstants.CENTER, SwingConstants.BOTTOM.

     * @param icons the Icons to be painted as part of the CompoundIcon

     * 

     * @return the CompoundIcon

     */

    public CompoundIcon createCompoundIcon(int orientation, int gap, int alignmentX, int alignmentY, Icon... icons);

    public BookmarksController createBookmarksController(Bookmarks bookmarks, JButton button);

    public HistoryController createHistoryController(History history, JButton button);

    public FilteredTableModel createFilteredTableModel(TableModel model, int filterColumn);

    public FilteredListModel createFilteredListModel();

    public FilteredTreeModel createFilteredTreeModel(JTree tree);

    public FilteredListController createFilteredListController(JList list, JTextComponent text, JButton button);

    public FilteredTreeController createFilteredTreeController(JTree list, JTextComponent text, JButton button);

    public JLabel createTitledSeparator(String title, int height, int titlePosition, int titleJustification);

    public JLabel createTitledSeparator(String title);

    public JWebBrowser createJWebBrowser();

    public void registerJWebBrowserFactory(JWebBrowserFactory factory);

    public DataTypePickerController createDataTypePickerController(JComboBox cboDataType, JButton btnDataType, boolean allowNull);

    public TableColumnAdjuster createTableColumnAdjuster(JTable table);

    public MessageBarController createMessageBarController(JLabel txtLabel, int timeDuration);

    public String showZoomDialog(java.awt.Component parent, String title, String text, boolean editable);

    public DropDown createDropDownIcon(JLabel lblNull);

    public void putInClipboard(String data);

    public String getFromClipboard();

}