|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
uk.ac.starlink.ast.gui.ComponentColourControls
public class ComponentColourControls
Create controls for setting the colour of a component. The actual
setting is performed by an object that implements the
PlotController
interface.
The Color is stored in a ColourStore object that provides persistence and maintains a list of listeners for changes in the colour.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class javax.swing.JPanel |
---|
JPanel.AccessibleJPanel |
Nested classes/interfaces inherited from class javax.swing.JComponent |
---|
JComponent.AccessibleJComponent |
Nested classes/interfaces inherited from class java.awt.Container |
---|
Container.AccessibleAWTContainer |
Nested classes/interfaces inherited from class java.awt.Component |
---|
Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy |
Field Summary | |
---|---|
protected JButton |
colourButton
The button used to request the colour dialog. |
protected ColourIcon |
colourIcon
Colour Icon of colour button, shows the current colour. |
protected JLabel |
colourLabel
Label showing the description of the colour that will be changed. |
protected ColourStore |
colourStore
ColourStore that provides change notifications and permanent store. |
protected PlotController |
controller
The controller of the component that we're controlling. |
protected String |
description
Description of the colour that will be changed. |
protected String |
name
Short name of these controls (for a tabbed label). |
protected Color |
originalColour
The original colour of the component. |
protected String |
title
Title for a page of these controls. |
Fields inherited from class javax.swing.JComponent |
---|
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW |
Fields inherited from class java.awt.Component |
---|
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT |
Fields inherited from interface java.awt.image.ImageObserver |
---|
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
Constructor Summary | |
---|---|
ComponentColourControls(PlotController controller,
AbstractPlotControlsModel colourStore,
String title,
String name,
String label)
Create an instance. |
Method Summary | |
---|---|
protected void |
chooseColour()
Choose a colour for the component using a chooser dialog. |
ColourStore |
getColourStore()
Get the ColourStore. |
JComponent |
getControlsComponent()
Return a reference to the JComponent sub-class that will be displayed (normally a reference to this). |
AbstractPlotControlsModel |
getControlsModel()
Return reference to the AbstractPlotControlsModel. |
static Class |
getControlsModelClass()
Return the class of object that we expect as our model. |
String |
getControlsName()
Return a short name for these controls (for the tab). |
String |
getControlsTitle()
Return a title for these controls (for the border). |
String |
getDescription()
Get the description used in the label. |
PlotController |
getPlotController()
Get the controller for the applying the colour changes. |
protected void |
initUI()
Place the UI components. |
void |
matchColour()
Update the component colour to match the one in store. |
void |
reset()
Reset the colour to original. |
void |
setColourStore(ColourStore colourStore)
Set the ColourStore used to store the colour. |
void |
setController(PlotController controller)
Set the controller of the component to be coloured. |
void |
setDescription(String title,
String name,
String label)
Set the descriptions, title, name and label. |
void |
stateChanged(ChangeEvent e)
Listen for ColourStore issuing ChangeEvents. |
Methods inherited from class javax.swing.JPanel |
---|
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected PlotController controller
protected ColourIcon colourIcon
protected JButton colourButton
protected JLabel colourLabel
protected String description
protected String title
protected String name
protected ColourStore colourStore
protected Color originalColour
Constructor Detail |
---|
public ComponentColourControls(PlotController controller, AbstractPlotControlsModel colourStore, String title, String name, String label) throws RuntimeException
controller
- a controller for the object that is to be
coloured.colourStore
- the storage for the actual Colour.description
- a short description of the property.
RuntimeException
Method Detail |
---|
protected void initUI()
public void setController(PlotController controller)
public void setColourStore(ColourStore colourStore)
public ColourStore getColourStore()
public PlotController getPlotController()
public void setDescription(String title, String name, String label)
public String getDescription()
protected void chooseColour()
public void matchColour()
public String getControlsTitle()
getControlsTitle
in interface PlotControls
public String getControlsName()
getControlsName
in interface PlotControls
public void reset()
reset
in interface PlotControls
public JComponent getControlsComponent()
getControlsComponent
in interface PlotControls
public AbstractPlotControlsModel getControlsModel()
getControlsModel
in interface PlotControls
public static Class getControlsModelClass()
public void stateChanged(ChangeEvent e)
stateChanged
in interface ChangeListener
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |