alice.util.thinlet

Class Thinlet

java.lang.Object

java.awt.Component

java.awt.Container

alice.util.thinlet.Thinlet

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Runnable

Direct Known Subclasses:

LibraryDialog, ThinletConsole, ThinletDebugArea, ThinletStatusBar, ThinletTheoryEditor, ThinletToolBar

public class Thinlet
extends Container
implements Runnable, Serializable

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

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

Constructors

Constructor and Description
Thinlet()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Object component) Adds the specified component to the root desktop
void	add(Object parent, Object component) Adds the specified component to the end of the specified container
void	add(Object parent, Object component, int index) Adds the specified component to the container at the given position
protected void	characters(String text) The SAX-like parser calls this method, you have to overwrite it
Object	create(String classname) Creates a new component
boolean	destroy() This method is called by the FrameLauncher if the window was closing, or AppletLauncher's destroy method.
protected void	endElement() The SAX-like parser calls this method, you have to overwrite it
Object	find(Object component, String name) Finds the first component from the specified component by a name
Object	find(String name) Finds the first component from the root desktop by a specified name value
boolean	getBoolean(Object component, String key) Gets the property value of the given component by the property key
String	getChoice(Object component, String key) Gets the property value of the given component by the property key
String	getClass(Object component) Gets the type of the given component
int	getCount(Object component) Gets the count of subcomponents in the list of the given component
int	getCount(Object component, String key) Gets the count of subcomponents in the list of the given component
Object	getDesktop() Get the topmost component
protected String	getDOMAttribute(Object node, String key) Gets the attribute value by the specified key for a DOM tag
protected int	getDOMCount(Object node, String key) Gets the number of tags in a tag by a specified tagname
protected Object	getDOMNode(Object node, String key, int index) Gets the subtag of the specified tag by tagname and index
protected String	getDOMText(Object node) Gets the content string of a tag
Image	getIcon(Object component, String key) Gets the property value of the given component by the property key
Image	getIcon(String path) Creates an image, and loads it immediately by default
Image	getIcon(String path, boolean preload) Creates an image from the specified resource.
int	getInteger(Object component, String key) Gets the property value of the given component by the property key
Object	getItem(Object component, int index) Returns the subcomponent of the given component at the specified index
Object	getItem(Object component, String key, int index) Returns the subcomponent of the given component's specified list at the given index
Object[]	getItems(Object component) Gets all the components in this container
Object[]	getItems(Object component, String key) Gets all the components in this container's specified list
Object	getParent(Object component) Gets the parent of this component
Dimension	getPreferredSize() Gets the preferred size of the root component
Object	getProperty(Object component, Object key) Returns the value of the property with the specified key.
int	getSelectedIndex(Object component) Gets the index of the first selected item in the given component (list, table, or tree)
Object	getSelectedItem(Object component) Gets the first selected item of the given component (list, table, or tree)
Object[]	getSelectedItems(Object component) Gets the selected item of the given component (list, table, or tree) when multiple selection is allowed
String	getString(Object component, String key) Gets the property value of the given component by the property key
boolean	isFocusTraversable() This component can be traversed using Tab or Shift-Tab keyboard focus traversal, although 1.4 replaced this method by isFocusable, so 1.4 compilers write deprecation warning
void	paint(Graphics g) Paints the components inside the graphics clip area
Object	parse(InputStream inputstream) Creates a component from the given stream
Object	parse(InputStream inputstream, Object handler) Creates a component from the given stream and event handler
Object	parse(String path) Creates a component (and its subcomponents, and properties) from the given xml resource
Object	parse(String path, Object handler) Creates a component from the given xml resource using the specified event handler
protected Object	parseDOM(InputStream inputstream) You can use the internal xml parser as a simple DOM-like parser, use the getDOMAttribute, getDOMText, getDOMCount, getDOMNode, getClass, and getParent methods to analise the document
protected void	parseXML(InputStream inputstream) You can use the internal xml parser as a simple SAX-like parser, during the process it calls the startElement, characters, and endElement methods
protected void	processEvent(AWTEvent e) Dispatches mouse, key, focus, and component events occurring on the Thinlet component internally
void	putProperty(Object component, Object key, Object value) Binds the specified key to the specified value, and stores in this component.
void	remove(Object component) Removes the specified component from its parent
void	removeAll(Object component) Removes all the components from this container
void	removeAll(Object component, String key) Removes all the components from this container's specified list
boolean	requestFocus(Object component) Requests that both the Thinlet component, and the given widget get the input focus
void	run() A second thread is used to repeat value change events for scrollbar or spinbox during the mouse is pressed, or to pop up tooltip
void	setBoolean(Object component, String key, boolean value) Sets the given property pair (key and value) for the component
void	setChoice(Object component, String key, String value) Sets the given property pair (key and value) for the component
void	setColors(int background, int text, int textbackground, int border, int disable, int hover, int press, int focus, int select) Sets the 9 colors used for components, and repaints the whole UI
void	setFont(Font font) Sets the only one font used everywhere, and revalidates the whole UI.
void	setIcon(Object component, String key, Image icon) Sets the given property pair (key and value) for the component
void	setInteger(Object component, String key, int value) Sets the given property pair (key and value) for the component
void	setMethod(Object component, String key, String value, Object root, Object handler) Sets a new event handler method for a component
void	setString(Object component, String key, String value) Sets the given property pair (key and value) for the component
protected void	startElement(String name, Hashtable attributelist) The SAX-like parser calls this method, you have to overwrite it
void	update(Graphics g) Invokes the paint method

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, isValidateRoot, layout, list, list, locate, minimumSize, paintComponents, paramString, preferredSize, print, printComponents, processContainerEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, revalidate, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Thinlet

public Thinlet()

Method Detail

setColors

public void setColors(int background,
             int text,
             int textbackground,
             int border,
             int disable,
             int hover,
             int press,
             int focus,
             int select)

Sets the 9 colors used for components, and repaints the whole UI

Parameters:

background - the backround of panels (dialogs, desktops), and disabled controls, not editable texts, lines between list items (the default value if #e6e6e6)

text - for text, arrow foreground (black by default)

textbackground - the background of text components, and lists (white by default)

border - for outer in inner borders of enabled components (#909090 by default)

disable - for text, border, arrow color in disabled components (#b0b0b0 by default)

hover - indicates that the mouse is inside a button area (#ededed by default)

press - for pressed buttons, gradient image is calculated using the background and this press color (#b9b9b9 by default)

focus - for text caret and rectagle color marking the focus owner (#89899a by default)

select - used as the background of selected text, and list items, and in slider (#c5c5dd by default)

setFont

public void setFont(Font font)

Sets the only one font used everywhere, and revalidates the whole UI. Scrollbar width/height, spinbox, and combobox button width, and slider size is the same as the font height

Overrides:

setFont in class Container

Parameters:

font - the default font is SansSerif, plain, and 12pt

getPreferredSize

public Dimension getPreferredSize()

Gets the preferred size of the root component

Overrides:

getPreferredSize in class Container

Returns:

a dimension object indicating the root component's preferred size

update

public void update(Graphics g)

Invokes the paint method

Overrides:

update in class Container

paint

public void paint(Graphics g)

Paints the components inside the graphics clip area

Overrides:

paint in class Container

run

public void run()

A second thread is used to repeat value change events for scrollbar or spinbox during the mouse is pressed, or to pop up tooltip

Specified by:

run in interface Runnable

isFocusTraversable

public boolean isFocusTraversable()

This component can be traversed using Tab or Shift-Tab keyboard focus traversal, although 1.4 replaced this method by isFocusable, so 1.4 compilers write deprecation warning

Overrides:

isFocusTraversable in class Component

Returns:

true as focus-transverable component, overwrites the default false value

processEvent

protected void processEvent(AWTEvent e)

Dispatches mouse, key, focus, and component events occurring on the Thinlet component internally

Overrides:

processEvent in class Container

requestFocus

public boolean requestFocus(Object component)

Requests that both the Thinlet component, and the given widget get the input focus

Parameters:

component - a focusable widget inside visible and enabled parents, and tabbedpane's selected tab

Returns:

true, if the given component was focusable

create

public Object create(String classname)

Creates a new component

Parameters:

classname - the widget type (e.g. button)

Returns:

a new component, every component is simply an Object

Throws:

IllegalArgumentException - for unknown widget type

getClass

public String getClass(Object component)

Gets the type of the given component

Parameters:

component - a widget

Returns:

the class name of the component (e.g. button)

getDesktop

public Object getDesktop()

Get the topmost component

Returns:

the root object (it is a desktop), never null

getCount

public int getCount(Object component)

Gets the count of subcomponents in the list of the given component

Parameters:

component - a widget

Returns:

the number of components in this component

getCount

public int getCount(Object component,
           String key)

Gets the count of subcomponents in the list of the given component

Parameters:

component - a widget

key - the list is identified by the key name for tabbed pane (tab, or component) or table (column, or row) The component and the row is the default key

Returns:

the number of components in this component

getParent

public Object getParent(Object component)

Gets the parent of this component

Parameters:

component - a widget

Returns:

the parent container of this component or item

getSelectedIndex

public int getSelectedIndex(Object component)

Gets the index of the first selected item in the given component (list, table, or tree)

Parameters:

component - a widget

Returns:

the first selected index or -1

getSelectedItem

public Object getSelectedItem(Object component)

Gets the first selected item of the given component (list, table, or tree)

Parameters:

component - a widget

Returns:

the first selected item or null

getSelectedItems

public Object[] getSelectedItems(Object component)

Gets the selected item of the given component (list, table, or tree) when multiple selection is allowed

Parameters:

component - a widget

Returns:

the array of selected items, or a 0 length array

removeAll

public void removeAll(Object component)

Removes all the components from this container

Parameters:

component - the specified container

removeAll

public void removeAll(Object component,
             String key)

Removes all the components from this container's specified list

Parameters:

component - the specified container

key - the list is identified by the key name for tabbed pane (tab, or component) or table (column, or row) The component and the row is the default key

getItem

public Object getItem(Object component,
             int index)

Returns the subcomponent of the given component at the specified index

Parameters:

component - a specified container

index - the index of the component to get

Returns:

the index^th component in this container

getItems

public Object[] getItems(Object component)

Gets all the components in this container

Parameters:

component - a specified container

Returns:

an array of all the components in this container

getItem

public Object getItem(Object component,
             String key,
             int index)

Returns the subcomponent of the given component's specified list at the given index

Parameters:

component - a specified container

key - the list is identified by the key name

index - the index of the component to get

Returns:

the index^th component in this container

getItems

public Object[] getItems(Object component,
                String key)

Gets all the components in this container's specified list

Parameters:

component - a specified container

key - the list is identified by the key name

Returns:

an array of all the components in this container

add

public void add(Object component)

Adds the specified component to the root desktop

Parameters:

component - a widget to be added

add

public void add(Object parent,
       Object component)

Adds the specified component to the end of the specified container

Parameters:

parent - a container

component - a component to be added

add

public void add(Object parent,
       Object component,
       int index)

Adds the specified component to the container at the given position

Parameters:

parent - a container

component - a component to be inserted

index - the position at which to insert the component, or -1 to insert the component at the end

remove

public void remove(Object component)

Removes the specified component from its parent

Parameters:

component - the component to be removed

Throws:

IllegalArgumentException

find

public Object find(String name)

Finds the first component from the root desktop by a specified name value

Parameters:

name - parameter value identifies the widget

Returns:

the first suitable component, or null

find

public Object find(Object component,
          String name)

Finds the first component from the specified component by a name

Parameters:

component - the widget is searched inside this component

name - parameter value identifies the widget

Returns:

the first suitable component, or null

putProperty

public void putProperty(Object component,
               Object key,
               Object value)

Binds the specified key to the specified value, and stores in this component. Null value removes the property. Use the parameter tag in the xml resource to bind a string value, the format is: parameter='key=value'

Parameters:

component - the hashtable is binded to this component

key - the client property key

value - the new client property value

getProperty

public Object getProperty(Object component,
                 Object key)

Returns the value of the property with the specified key.

Parameters:

component - searches the hashtable of this component

key - the client property key

Returns:

the value to which the key is mapped or null if the key is not mapped to any value

parse

public Object parse(String path)
             throws IOException

Creates a component (and its subcomponents, and properties) from the given xml resource

Parameters:

path - is relative to your thinlet instance or the classpath (if the path starts with an / character)

Returns:

the root component of the parsed resource

Throws:

IOException

parse

public Object parse(String path,
           Object handler)
             throws IOException

Creates a component from the given xml resource using the specified event handler

Parameters:

path - is relative to your application package or the classpath

handler - bussiness methods are implemented in this object

Returns:

the parsed components' root

Throws:

IOException

parse

public Object parse(InputStream inputstream)
             throws IOException

Creates a component from the given stream

Parameters:

inputstream - e.g. new URL("http://myserver/myservlet").openStream()

Returns:

the root component of the parsed stream

Throws:

IOException

parse

public Object parse(InputStream inputstream,
           Object handler)
             throws IOException

Creates a component from the given stream and event handler

Parameters:

inputstream - read xml from this stream

handler - event handlers are implemented in this object

Returns:

the parsed components' root

Throws:

IOException

parseXML

protected void parseXML(InputStream inputstream)
                 throws IOException

You can use the internal xml parser as a simple SAX-like parser, during the process it calls the startElement, characters, and endElement methods

Parameters:

inputstream - e.g. new URL("http://myserver/myservlet").openStream()

Throws:

IOException

startElement

protected void startElement(String name,
                Hashtable attributelist)

The SAX-like parser calls this method, you have to overwrite it

Parameters:

name - of the tag

attributelist - a list of attributes including keys and value pairs

characters

protected void characters(String text)

The SAX-like parser calls this method, you have to overwrite it

Parameters:

text - the content of a tag

endElement

protected void endElement()

The SAX-like parser calls this method, you have to overwrite it

parseDOM

protected Object parseDOM(InputStream inputstream)
                   throws IOException

You can use the internal xml parser as a simple DOM-like parser, use the getDOMAttribute, getDOMText, getDOMCount, getDOMNode, getClass, and getParent methods to analise the document

Parameters:

inputstream - e.g. new URL("http://myserver/myservlet").openStream()

Returns:

the root tag

Throws:

IOException

getDOMAttribute

protected String getDOMAttribute(Object node,
                     String key)

Gets the attribute value by the specified key for a DOM tag

Parameters:

node - a specified tag

key - a string to identify the value pair

Returns:

the value, or null

getDOMText

protected String getDOMText(Object node)

Gets the content string of a tag

Parameters:

node - a specified tag

Returns:

the value, or null

getDOMCount

protected int getDOMCount(Object node,
              String key)

Gets the number of tags in a tag by a specified tagname

Parameters:

node - a specified tag

key - the searched tagname

Returns:

the number of tags

getDOMNode

protected Object getDOMNode(Object node,
                String key,
                int index)

Gets the subtag of the specified tag by tagname and index

Parameters:

node - a specified tag

key - the searched tagname

index - the index of the requested subtag

Returns:

the found tag, or null

setString

public void setString(Object component,
             String key,
             String value)

Sets the given property pair (key and value) for the component

getString

public String getString(Object component,
               String key)

Gets the property value of the given component by the property key

setChoice

public void setChoice(Object component,
             String key,
             String value)

Sets the given property pair (key and value) for the component

getChoice

public String getChoice(Object component,
               String key)

Gets the property value of the given component by the property key

setBoolean

public void setBoolean(Object component,
              String key,
              boolean value)

Sets the given property pair (key and value) for the component

getBoolean

public boolean getBoolean(Object component,
                 String key)

Gets the property value of the given component by the property key

setInteger

public void setInteger(Object component,
              String key,
              int value)

Sets the given property pair (key and value) for the component

getInteger

public int getInteger(Object component,
             String key)

Gets the property value of the given component by the property key

setIcon

public void setIcon(Object component,
           String key,
           Image icon)

Sets the given property pair (key and value) for the component

getIcon

public Image getIcon(Object component,
            String key)

Gets the property value of the given component by the property key

setMethod

public void setMethod(Object component,
             String key,
             String value,
             Object root,
             Object handler)

Sets a new event handler method for a component

Parameters:

component - the target component

key - the key name of the parameter (e.g. action)

value - the method name and parameters (e.g. foo(this, this.text, mybutton, mybutton.enabled) for public void foo(Object component, String text, Object mybutton, boolean enabled))

root - the search starting component for name components in the arguments

handler - the target event handler object including the method

Throws:

IllegalArgumentException

getIcon

public Image getIcon(String path)

Creates an image, and loads it immediately by default

Parameters:

path - is relative to your thinlet instance or the classpath (if the path starts with '/' character)

Returns:

the loaded image or null

getIcon

public Image getIcon(String path,
            boolean preload)

Creates an image from the specified resource. To speed up loading the same images use a cache (a simple hashtable). And flush the resources being used by an image when you won't use it henceforward

Parameters:

path - is relative to your thinlet instance or the classpath

preload - waits for the whole image if true, starts loading (and repaints, and updates the layout) only when required (painted, or size requested) if false

Returns:

the loaded image or null

destroy

public boolean destroy()

This method is called by the FrameLauncher if the window was closing, or AppletLauncher's destroy method. Overwrite it to e.g. save the application changes.

Returns:

true to exit, and false to keep the frame and continue the application