AT&T Home | AT&T Labs | Research
AT&T Labs, Inc. - Research

The Yoix® Scripting Language

Home | What's New | Grammar | Documentation | Download | License | YDAT | YWAIT | Byzgraf | FAQs
JColorChooser typedict
 
A JColorChooser is the interface to the Java Swing JColorChooser Component. Yoix programs normally interact with a JColorChooser using event handlers and by reading or writing the following fields:
background The Color that is used to paint the background of the colorchooser. Reading returns a snapshot of the current color. Writing immediately changes the background to the new color. Storing NULL in background is special and means use the background of the nearest component that contains the colorchooser and was assigned a background color other than NULL; if no component qualifies the colorchooser uses VM.screen.background.
border An Object that should be a Border, Insets, Number, or String that describes the border that is drawn around this colorchooser. A NULL value, which is the default, means no border. A border that is an Insets or Number is an easy way to describe margins (i.e., an EmptyBorder), in units of 72 dots per inch, that are left around the sides of this colorchooser. A border that is a String is a quick way to surround this colorchooser with a border that uses the String as its title. Reading returns a snapshot of the current border. Writing immediately sets the colorchooser's border to the new value.
color The Color that is selected and displayed by the colorchooser. Reading returns the color currently selected by the colorchooser. Writing changes the selected color and immediately repaints the colorchooser so that it correctly displays the newly selected color.
cursor An Object that should be an int, Image, or String that selects the cursor shown when the pointer is over the colorchooser. A cursor that is an int should be one of the cursors defined in the yoix.awt.Cursor dictionary. A cursor that is an Image can describe the cursor using its size and hotspot fields and often draws it using its paint function. A cursor that is a String should be the name of a cursor that is already defined in yoix.awt.Cursor or the name a local a file or URL that contains a GIF or JPEG image that will be used as the cursor.

Reading returns the current cursor. Writing immediately changes the colorchooser's cursor to the new value. Storing STANDARD_CURSOR (the default) or NULL in cursor is special and means use the cursor assigned to the nearest component that contains the colorchooser and was assigned a cursor other than STANDARD_CURSOR; if no component qualifies the colorchooser uses DEFAULT_CURSOR.

doublebuffered An int that is 1 when the colorchooser uses double-buffering to draw itself, 0 when it does not, and starts with a default value that is selected by Java for the colorchooser. Reading returns the current double-buffering behavior. Writing immediately sets the colorchooser's double-buffering behavior to the new value. Note that double-buffering may be required when transparent components are used.
dragenabled An int that should be set to 1 when this colorchooser wants to use the automatic drag handling that Swing provides for some components, and 0 (the default) when it does not. Components that do not provide automatic drag handling always return 0 when their dragenabled field is read, so storing 1 in dragenabled should only be viewed as a request for a service that may not be available. Swing components can always take complete control of their drag and drop handling using their transferhandler field or special drag and drop event handlers.
enabled An Object that is 1 when the colorchooser can respond to user input, 0 when it can not respond, and NULL (the default) when the colorchooser inherits the value from the nearest lightweight container, like a JPanel, that contains the colorchooser and has its enabled field set to something other than NULL. The top-level application window that contains the colorchooser always gets the final say, so disabling that window always disables the colorchooser. Reading returns the current state. Writing immediately sets the colorchooser's state to the new value.
focusowner A read-only int that is non-zero when the colorchooser has the focus.
font The Font, or font name if it is a String, that is used whenever the colorchooser paints text. Reading returns a snapshot of the current font. Writing immediately repaints all text displayed by the colorchooser in the new font.
foreground The Color that is used whenever the colorchooser paints text. Reading returns a snapshot of the current color. Writing immediately repaints all text displayed by the colorchooser in the new color. Storing NULL in foreground is special and means use the foreground of the nearest component that contains the colorchooser and was assigned a foreground color other than NULL; if no component qualifies the colorchooser uses VM.screen.foreground.
layer An int, often a small number between 0 and 99, that identifies the depth of this colorchooser when it is added to a JLayeredPane or JDesktopPane. Components assigned to lower numbered layers are drawn before the components in higher numbered layers. Writing immediately changes the colorchooser's layer, which usually means the JLayeredPane or JDesktopPane that contains the colorchooser will be repainted.
location A Point that determines the location of the colorchooser in a coordinate system that has its origin at the upper left corner of the container closest to the colorchooser (in the component hierarchy) that actually contains it, positive x to the right, positive y down, and a resolution of 72 dots per inch. Reading returns a snapshot of the current location. Writing is allowed, but layout managers usually get the final say, so setting location should be viewed as a request that may not be honored.
nextfocus An Object that is the component that receives the focus after this colorchooser when the focus traverses from one component to the next (usually by means of the keyboard TAB character). A NULL value indicates that the default Java focus traversal is in effect. Reading returns the value last stored. Writing immediately sets the new focus traversal behavior.
opaque An Object that is 1 when the colorchooser is opaque, 0 when it is transparent, and NULL (the default) when the colorchooser inherits the value from the nearest component that contains the colorchooser and has its opaque field set to something other than NULL.
popup A JPopupMenu that is associated with the colorchooser. Reading returns the current popup menu. Writing immediately shows the popup menu at the point in the colorchooser's coordinate system specified by the popup menu's location field, assuming of course that the colorchooser is showing on the screen. Storing TRUE in the popup menu's visible field, which was added in release 1.2.0, is an easy way to show the popup menu that currently belongs to the colorchooser.
preferredsize A Dimension that is used by layout managers when they need to know the colorchooser's preferred size in units of 72 dots per inch. A NULL value means the colorchooser has no preference. A non-positive height or width is allowed and simply means the colorchooser has no preference for that dimension. Reading returns the current preferred size. Writing changes the preferred size and immediately notifies root.layoutmanager, which means the components contained in root may be repositioned and resized.
requestfocus An int that can be used to request or transfer the keyboard focus. Storing a non-zero value in requestfocus tries to get the focus. Storing 0 tries to transfer the focus. Reading requestfocus does not currently return any useful information.
requestfocusenabled An int that is 1 (the default) when actions, like mouse clicks or changes to the requestfocus field, can steal the keyboard focus and 0 when they can not. Note that this field does not affect acceptance of the keyboard focus during normal focus traversal. Reading returns the current state. Writing immediately sets the colorchooser's state to the new value.
reset The unchanging reference Color that is displayed by the colorchooser. Reading returns the current reference color displayed by the colorchooser. Writing changes the reference color and the selected color and immediately repaints the colorchooser so that it correctly displays the new colors in the preview panel.
root An Object that is automatically updated by the interpreter's layout machinery so it is always the top-level object that contains the colorchooser. For example, put a colorchooser in a panel and root will be set to that panel; add the panel to a frame and the colorchooser's root field will be set to that frame. A colorchooser's event handlers can use root when they need to interact with the other components in the container.
showing A read-only int that is non-zero when the colorchooser is showing on the screen.
size A Dimension that determines the size of the colorchooser in units of 72 dots per inch. Reading returns a snapshot of the current size. Writing is allowed, but layout managers usually get the final say, so setting size should be viewed as a request that may not be honored.
tag A String used to identify the colorchooser that is either supplied when the colorchooser is declared, or automatically generated otherwise. Add a colorchooser to a container, like a JFrame or JPanel, and the interpreter's layout machinery updates the root field so it points at the top-level container and then adds the colorchooser, as tag, to the root.components dictionary.
tooltiptext A String of characters that is displayed in a tightly sized pop-up window that appears near the cursor whenever the cursor lingers over the colorchooser. Setting this value to NULL (the default) disables the tooltip mechanism. Reading returns the current tooltip text. Writing immediately sets the new tooltip text.
transferhandler An Object that should be a TransferHandler or String that determines how the colorchooser handles data transfer operations like drag and drop. A value that is a String but not "" means the field named by the String should be used as the source and sink of the data that is transferred by the colorchooser. The result is the same as assigning the String to the property field in a TransferHandler and then assigning that TransferHandler to transferhandler. The empty String "" is special and refers to the TransferHandler that Swing uses for automatic drag handling, if there is one.

Swing components that provide automatic drag handling start out with a transferhandler field that is not NULL, but the automatic drag handling is not enabled until 1 is stored in dragenabled. Swing components that provide their own drag and drop event handlers currently must store NULL in transferhandler before those event handlers will start working.

visible An int that is 1 when the colorchooser is visible, and 0 otherwise. Reading returns the current visibility. Writing immediately sets the colorchooser's visibility to the new state.
Several permanent fields have not been documented and should not be used in Yoix applications. Event handlers are functions that must be added to a colorchooser when it is declared. The handlers that work with colorchooser are listed below; the names should be familiar if you have done some Java programming.
 
 Event Handlers:   actionPerformed, componentHidden, componentMoved, componentResized, componentShown, dragDropEnd, dragEnter, dragExit, dragGestureRecognized, dragMouseMoved, dragOver, drop, dropActionChanged, focusGained, focusLost, invocationRun, itemStateChanged, keyPressed, keyReleased, keyTyped, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, mouseWheelMoved, stateChanged
 
 Example:   The program,
import yoix.*.*;

JDialog chooser = {
    Dimension size = NULL;
    String    title = "Color Chooser Example";
    int       initialized = FALSE;
    int       modal = TRUE;

    Array layout = {
        new JColorChooser {
            String tag = "$_chooser";
            Color  color = Color.white;
            int    canceled = FALSE;
        }, CENTER,

        new JPanel {
            FlowLayout layoutmanager = {
                double vgap = 72.0/16;
            };

            Array layout = {
                new JButton {
                    String text = "Select";

                    actionPerformed(e) {
                        root.SetVisible(FALSE);
                    }
                },
                new JButton {
                    String text = "Reset";

                    actionPerformed(e) {
                        root.components.$_chooser.color = Color.white;
                    }
                },
                new JButton {
                    String text = "Cancel";

                    actionPerformed(e) {
                        root.components.$_chooser.canceled = TRUE;
                        root.SetVisible(FALSE);
                    }
                },
            };
        }, SOUTH,
    };

    SelectedColor() {
        Color color = NULL;

        if (!components.$_chooser.canceled)
            color = components.$_chooser.color;
        return(color);
    }

    SetVisible(int state) {
        Point location;

        if (!initialized) {
            initialized = TRUE;
            location.x = (VM.screen.width - this.size.width)/2;
            location.y = (VM.screen.height - this.size.height)/2 - 72.0;
            this.location = location;
        }
        if (state)
            this.components.$_chooser.canceled = FALSE;
        this.visible = state;
    }
};

chooser.SetVisible(TRUE);
printf("The color you selected is: %O\n", chooser.SelectedColor());
is a simple example that builds a screen, using a modal JDialog, a JColorChooser, and three JButtons that dumps the color that you choose on standard output after you press the Select button.
 
 See Also:   BevelBorder, Border, EmptyBorder, EtchedBorder, invokeLater, JButton, JCanvas, JCheckBox, JCheckBoxMenuItem, JChoice, JComboBox, JDesktopPane, JDialog, JFileChooser, JFileDialog, JFrame, JInternalFrame, JLabel, JLayeredPane, JList, JMenu, JMenuBar, JMenuItem, JPanel, JPasswordField, JPopupMenu, JProgressBar, JRadioButton, JRadioButtonMenuItem, JScrollBar, JScrollPane, JSeparator, JSlider, JSplitPane, JTabbedPane, JTable, JTextArea, JTextCanvas, JTextField, JTextPane, JTextTerm, JToggleButton, JToolBar, JTree, JWindow, LineBorder, MatteBorder, postEvent, SoftBevelBorder, TransferHandler

 

Yoix is a registered trademark of AT&T Intellectual Property.