Package uk.ac.starlink.ast.gui

This package is intended as a repository for components that are useful when developing UIs that control the uk.ac.starlink.ast class library.

See:
          Description

Interface Summary
AstPlotSource Interface defining access to a Plot held by some other object.
FontChangedListener FontChangedListener defines an interface used when listening for changes in a displayed font specification.
PlotController An interface for interacting with a PlotConfigurator.
PlotControls Interface for a set of controls that may be added to a PlotConfigurator tabbed pane.
 

Class Summary
AbstractPlotControlsModel This abstract class provides a default implementation for a XMLEncodeDecode.
AstAxes AstAxes is a model of the axes elements shown in an AST Plot.
AstAxisLabels AstAxisLabel is a model of the Axis label elements shown in say an AST Plot.
AstBorder AstBorder is a model of the Border element shown in say an AST Plot.
AstCellEditor Cell editor for table fields containing AstDouble objects.
AstDouble AstDouble implements a double precision Number that represents a value that should be formatted and unformatted using the characteristics of an axis of an AST Frame.
AstDoubleDocument AstDoubleDocument extends PlainDocument to so that any associated components will only accept valid AstDouble formatted strings.
AstDoubleField AstDoubleField extends JTextField to enforce the entry of valid AST coordinates (that is doubles or formatted strings).
AstFigureProps Subclass of FigureProps that can convert a Figure between coordinates systems using a Mapping when restoring from an XML serialization.
AstFigureStore A subclass of DrawFigureStore that adds functionality to store and restore the current AST context along with the properties of a set of figures.
AstGrid AstGrid is a model of the Grid element shown in say an AST Plot.
AstNumberLabels AstNumberLabels is a model of the axis numeric label elements shown in say an AST Plot.
AstStrings AstStrings is a model for all the general text elements shown in an AST Plot (i.e.
AstStyleBox AstStyleBox extends a JComboBox by adding a default set of values that correspond to the default AST line styles (plain, dashed, dot etc.).
AstTicks AstTicks is a model of the tick mark elements shown in say an AST Plot.
AstTitle AstTitle is a model of the Title element shown in say an AST Plot.
AxesControls AxesControls creates a "page" of widgets that are a view of an AstAxes object.
AxisLabelControls AxisLabelControls creates a "page" of widgets that are a view of an AstAxisLabel object.
AxisNumLabControls AxisNumLabControls.Java creates a "page" of widgets that are a view of an AstAxisLabel object.
BorderControls BorderControls creates a "page" of widgets that are a view of an AstBorder object.
ColourIcon Creates a rectangular Icon that is painted with a given colour and has a coloured border of a specified thickness.
ColourStore Store a java.awt.Color.
ComponentColourControls Create controls for setting the colour of a component.
DecimalDocument DecimalDocument extends PlainDocument to so that any associated components will only accept valid floating or integer words.
DecimalField DecimalField extends JTextField to force the entry of valid decimal (i.e.
FontChangedEvent FontChangedEvent defines an event that passes on a new Font.
FontControls FontControls add a series of controls for selecting from the available families of fonts and assigning a size and style.
GraphicsEdges GraphicsEdges defines options about how the edges of a plot should be drawn (note these are not AST plot related).
GraphicsEdgesControls GraphicsEdgesControls creates a "page" of widgets that are a view of a GraphicsHints object.
GraphicsHints GraphicsHints defines the RenderingHints that should be used when drawing of a Plot.
GraphicsHintsControls GraphicsHintsControls creates a "page" of widgets that are a view of a GraphicsHints object.
GridControls GridControls creates a "page" of widgets that are a view of an AstGrid object.
LineControls LineControls add a series of controls for showing and changing the display properties of any drawn lines (the thickness, style and colour).
PlotConfiguration PlotConfiguration is a repository for all the configuration information related to a Plot (i.e.
PlotConfigurator PlotConfigurator creates a dialog window for controlling the configuration of an Plot.
ScientificFormat a formatter that uses a format suitable for numeric values in a scientific context.
ScientificSpinner A type of JSpinner that displays a Number using a ScientificFormat instance.
StringsControls StringsControls creates a "page" of widgets that are a view of an AstStrings object.
TickControls TickControls.Java creates a "page" of widgets that are a view of an AstTicks object.
TitleControls TitleControls creates a "page" of widgets that are a view of an AstTitle object.
Utilities Static utilities class for astgui package.
 

Package uk.ac.starlink.ast.gui Description

This package is intended as a repository for components that are useful when developing UIs that control the uk.ac.starlink.ast class library.

The main contents are currently a generic interface for configuring AST Plots PlotConfigurator and a number of models of the contents of various related plot options. These are unified by the PlotConfiguration class. Together with the StoreConfigurator and ConfigurationStore configurations can be applied to Plots and stored/restored from XML (see XMLEncodeAndDecode).

In addition to the standard Plot configuration options, extra pages of controls can be added to the PlotConfigurator, these can then be used to configure related features. The classes GraphicsHints, GraphicsEdges and ColourStore, together with their related controls exemplify this (also see the TestPlotConfigFrame.java example file in the source release).

The presentation of AST axis related values can be made to work in a native fashion using the AstDouble class, and the various components that make use of it: AstDoubleField, AstCellEditor and AstDoubleDocument. For completeness there's also a similar DecimalField for simple numbers.

Finally a set of classes for displaying all the fonts in a Font and choosing any characters for export are available (see SelectCharacters and supporting classes).

Related documentation



Copyright © 2015 Central Laboratory of the Research Councils. All Rights Reserved.