org.gudy.azureus2.ui.swt.components
Class Legend

java.lang.Object
  extended by org.gudy.azureus2.ui.swt.components.Legend

public class Legend
extends java.lang.Object

TODO: have a callback when color changes


Nested Class Summary
static interface Legend.LegendListener
           
 
Constructor Summary
Legend()
           
 
Method Summary
static org.eclipse.swt.widgets.Composite createLegendComposite(org.eclipse.swt.widgets.Composite panel, org.eclipse.swt.graphics.Color[] blockColors, java.lang.String[] keys)
          Create a legend containing a modifyable color box and description
static org.eclipse.swt.widgets.Composite createLegendComposite(org.eclipse.swt.widgets.Composite panel, org.eclipse.swt.graphics.Color[] blockColors, java.lang.String[] keys, boolean horizontal)
           
static org.eclipse.swt.widgets.Composite createLegendComposite(org.eclipse.swt.widgets.Composite panel, org.eclipse.swt.graphics.Color[] blockColors, java.lang.String[] keys, java.lang.Object layoutData)
           
static org.eclipse.swt.widgets.Composite createLegendComposite(org.eclipse.swt.widgets.Composite panel, org.eclipse.swt.graphics.Color[] blockColors, java.lang.String[] keys, java.lang.String[] key_texts, java.lang.Object layoutData, boolean horizontal)
          Create a legend containing a modifyable color box and description
static org.eclipse.swt.widgets.Composite createLegendComposite(org.eclipse.swt.widgets.Composite panel, org.eclipse.swt.graphics.Color[] blockColors, java.lang.String[] keys, java.lang.String[] key_texts, java.lang.Object layoutData, boolean horizontal, Legend.LegendListener listener)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Legend

public Legend()
Method Detail

createLegendComposite

public static org.eclipse.swt.widgets.Composite createLegendComposite(org.eclipse.swt.widgets.Composite panel,
                                                                      org.eclipse.swt.graphics.Color[] blockColors,
                                                                      java.lang.String[] keys)
Create a legend containing a modifyable color box and description

Parameters:
panel - Where to add legend to
blockColors - array of colors for each legend entry. This array WILL BE modified if the user changes the color
keys - array of keys for each legend entry
Returns:
The composite containing the legend

createLegendComposite

public static org.eclipse.swt.widgets.Composite createLegendComposite(org.eclipse.swt.widgets.Composite panel,
                                                                      org.eclipse.swt.graphics.Color[] blockColors,
                                                                      java.lang.String[] keys,
                                                                      boolean horizontal)

createLegendComposite

public static org.eclipse.swt.widgets.Composite createLegendComposite(org.eclipse.swt.widgets.Composite panel,
                                                                      org.eclipse.swt.graphics.Color[] blockColors,
                                                                      java.lang.String[] keys,
                                                                      java.lang.Object layoutData)

createLegendComposite

public static org.eclipse.swt.widgets.Composite createLegendComposite(org.eclipse.swt.widgets.Composite panel,
                                                                      org.eclipse.swt.graphics.Color[] blockColors,
                                                                      java.lang.String[] keys,
                                                                      java.lang.String[] key_texts,
                                                                      java.lang.Object layoutData,
                                                                      boolean horizontal)
Create a legend containing a modifyable color box and description

Parameters:
panel - Where to add legend to
blockColors - array of colors for each legend entry. This array WILL BE modified if the user changes the color
keys - array of keys for each legend entry
layoutData - How to layout the legend (ie. GridData, LayoutData, etc)
Returns:
The composite containing the legend

createLegendComposite

public static org.eclipse.swt.widgets.Composite createLegendComposite(org.eclipse.swt.widgets.Composite panel,
                                                                      org.eclipse.swt.graphics.Color[] blockColors,
                                                                      java.lang.String[] keys,
                                                                      java.lang.String[] key_texts,
                                                                      java.lang.Object layoutData,
                                                                      boolean horizontal,
                                                                      Legend.LegendListener listener)