| java.lang.Object
 java.awt.Component
java.awt.Canvas
org.w3c.tools.widgets.TreeBrowser
All known Subclasses: org.w3c.jigadm.editors.FrameBrowser,
| TreeBrowser | | public class TreeBrowser extends Canvas implements AdjustmentListener(Code) | | The TreeBrowser class.
This class is a generic framework to browser any hierachical structure.
Genericity is obtained through the use of 'handlers': the TreeBrowser
itself does not perform any action in response to user events, but simply
forward them as notifications to handlers. Each item inserted
may have its own handler, but handlers may also (this is the most common
case) be shared between handlers.
Any item added in the Tree is displayed with an icon and a label. When a
handler receive a notification on a node, it may change this node, to modify
or update its appearance.
author:
Jean-Michel.Leon@sophia.inria.fr
author:
Yves.Lafon@w3.org
author:
Thierry.Kormann@sophia.inria.fr |
| Field Summary | |
| final static int | DXLEVEL
| | final static int | HGAP
| | final static int | HMARGIN
| | final public static int | MULTIPLE
The policy that enables a multiple selection of nodes. | | final public static int | SCROLLBARS_ALWAYS
Specifies that the horizontal/vertical scrollbars should always be shown
regardless of the respective sizes of the TreeBrowser. | | final public static int | SCROLLBARS_ASNEEDED
Specifies that horizontal/vertical scrollbars should be shown only when
the size of the nodes exceeds the size of the TreeBrowser in the
horizontal/vertical dimension. | | final public static int | SINGLE
This policy that lets just one node selected at the same time. | | final static int | VMARGIN
| | protected int | fontHeight
| | protected Vector | items
| | protected Vector | selection
| | protected int | selectionPolicy
| | protected int | topItem
| | protected int | visibleItemCount
|
| Method Summary | |
| public void | adjustmentValueChanged(AdjustmentEvent evt)
Updates graphical appearance in response to a scroll. | | public synchronized void | collapse(TreeNode item)
Contracts the representation of the specified node.
removes all the children nodes of 'item'. | | public TreeNode | getNode(Object obj)
Gets the node associated to the specified object, or null if any. | | public TreeNode | getParent(TreeNode child)
Returns the parent node of the specified node.
If 'child' is a valid node belonging to the Tree and has a parent node,
returns its parent. | | public Dimension | getPreferredSize()
| | public int | getSelectionPolicy()
Gets the selection policy. | | protected void | initialize(Object item, String label, NodeHandler handler, Image icon)
| | public void | insert(TreeNode parent, Object item, NodeHandler handler, String label, Image icon)
Inserts new node. | | protected TreeNode | itemAt(int y)
this should be private. | | public void | paint(Graphics g)
repaints the View. | | public void | remove(TreeNode node)
Removes the specified node.
This simply removes a node, without modifying its children if any. | | public void | removeBranch(TreeNode node)
Removes the specified node and its children. | | public void | select(TreeNode node)
Selects the specified node.
Selects the given node. | | public Enumeration | selection()
Returns an Enumeraiton of selected items. | | public void | setHorizontalScrollbar(Scrollbar a)
Sets 'a' as horizontal Scrollbar. | | public void | setScrollbarDisplayPolicy(int scrollbarDisplayPolicy)
Sets the scrollbars display policy to the specified policy. | | public void | setSelectionBackgroudColor(Color color)
Sets the background color of a selected node to the specified color. | | public void | setSelectionFontColor(Color color)
Sets the color of a selected node to the specified color. | | public void | setSelectionPolicy(int policy)
Sets the selection policy. | | public void | setVerticalScrollbar(Scrollbar a)
Sets 'a' as vertical Scrollbar. | | public void | unselect(TreeNode node)
Unselects the specified node. | | public void | unselectAll()
Unselects all selected items. | | public void | update(Graphics pg)
|
| DXLEVEL | | final static int DXLEVEL(Code) | | |
| HGAP | | final static int HGAP(Code) | | |
| HMARGIN | | final static int HMARGIN(Code) | | |
| MULTIPLE | | final public static int MULTIPLE(Code) | | The policy that enables a multiple selection of nodes.
|
| SCROLLBARS_ALWAYS | | final public static int SCROLLBARS_ALWAYS(Code) | | Specifies that the horizontal/vertical scrollbars should always be shown
regardless of the respective sizes of the TreeBrowser.
|
| SCROLLBARS_ASNEEDED | | final public static int SCROLLBARS_ASNEEDED(Code) | | Specifies that horizontal/vertical scrollbars should be shown only when
the size of the nodes exceeds the size of the TreeBrowser in the
horizontal/vertical dimension.
|
| SINGLE | | final public static int SINGLE(Code) | | This policy that lets just one node selected at the same time.
|
| VMARGIN | | final static int VMARGIN(Code) | | |
| fontHeight | | protected int fontHeight(Code) | | |
| selectionPolicy | | protected int selectionPolicy(Code) | | |
| topItem | | protected int topItem(Code) | | |
| visibleItemCount | | protected int visibleItemCount(Code) | | |
| TreeBrowser | | public TreeBrowser(Object root, String label, NodeHandler handler, Image icon)(Code) | | Builds a new browser instance
Parameters:
root - the root node for this hierarchy
Parameters:
label - the label that should be displayed for this item
Parameters:
handler - the handler for this node
Parameters:
icon - the icon that must be displayed for this item |
| TreeBrowser | | protected TreeBrowser()(Code) | | |
| adjustmentValueChanged | | public void adjustmentValueChanged(AdjustmentEvent evt)(Code) | | Updates graphical appearance in response to a scroll.
|
| collapse | | public synchronized void collapse(TreeNode item)(Code) | | Contracts the representation of the specified node.
removes all the children nodes of 'item'. It is caller's
responsibility to call repaint() afterwards.
Parameters:
item - the node to contracts |
| getNode | | public TreeNode getNode(Object obj)(Code) | | Gets the node associated to the specified object, or null if any.
Parameters:
obj - the object related to a node |
| getParent | | public TreeNode getParent(TreeNode child)(Code) | | Returns the parent node of the specified node.
If 'child' is a valid node belonging to the Tree and has a parent node,
returns its parent. Returns null otherwise.
Parameters:
child - the child node you want to get its parent |
| getSelectionPolicy | | public int getSelectionPolicy()(Code) | | Gets the selection policy.
|
| itemAt | | protected TreeNode itemAt(int y)(Code) | | this should be private. having it protected is a present
for dummy VM that doesn't know that an inner class can access
private method of its parent class
|
| remove | | public void remove(TreeNode node)(Code) | | Removes the specified node.
This simply removes a node, without modifying its children if any. USE
WITH CAUTION.
Parameters:
node - the node to remove |
| removeBranch | | public void removeBranch(TreeNode node)(Code) | | Removes the specified node and its children.
NOTE: if two threads are doing adds and removes,
this can lead to IndexOutOfBound exception.
You will probably have to use locks to get rid of that problem
Parameters:
node - the node to remove |
| select | | public void select(TreeNode node)(Code) | | Selects the specified node.
Selects the given node. If selectionPolicy is SINGLE any previously
selected node is unselected first. It is caller's responsibility to
call repaint()
Parameters:
node - the node to select |
| selection | | public Enumeration selection()(Code) | | Returns an Enumeraiton of selected items.
|
| setHorizontalScrollbar | | public void setHorizontalScrollbar(Scrollbar a)(Code) | | Sets 'a' as horizontal Scrollbar.
The Browser becomes an AdjustmentListener of this scrollbar.
|
| setScrollbarDisplayPolicy | | public void setScrollbarDisplayPolicy(int scrollbarDisplayPolicy)(Code) | | Sets the scrollbars display policy to the specified policy. The default
is SCROLLBARS_ALWAYS
Parameters:
scrollbarDisplayPolicy - SCROLLBARS_NEVER | SCROLLBARS_ASNEEDED |SCROLLBARS_ALWAYS |
| setSelectionBackgroudColor | | public void setSelectionBackgroudColor(Color color)(Code) | | Sets the background color of a selected node to the specified color.
Parameters:
color - the color used to paint the background of a selected node |
| setSelectionFontColor | | public void setSelectionFontColor(Color color)(Code) | | Sets the color of a selected node to the specified color.
Parameters:
color - the color used to paint a selected node |
| setSelectionPolicy | | public void setSelectionPolicy(int policy)(Code) | | Sets the selection policy.
policy: SINGLE or MULTIPLE |
| setVerticalScrollbar | | public void setVerticalScrollbar(Scrollbar a)(Code) | | Sets 'a' as vertical Scrollbar.
The Browser becomes an AdjustmentListener of this scrollbar.
|
| unselect | | public void unselect(TreeNode node)(Code) | | Unselects the specified node.
It is caller's responsibility to call repaint()
Parameters:
node - the node to unselect |
| unselectAll | | public void unselectAll()(Code) | | Unselects all selected items.
|
| Methods inherited from java.awt.Component | public boolean action(Event evt, Object what)(Code)(Java Doc)
public void add(PopupMenu popup)(Code)(Java Doc)
public synchronized void addComponentListener(ComponentListener l)(Code)(Java Doc)
public synchronized void addFocusListener(FocusListener l)(Code)(Java Doc)
public void addHierarchyBoundsListener(HierarchyBoundsListener l)(Code)(Java Doc)
public void addHierarchyListener(HierarchyListener l)(Code)(Java Doc)
public synchronized void addInputMethodListener(InputMethodListener l)(Code)(Java Doc)
public synchronized void addKeyListener(KeyListener l)(Code)(Java Doc)
public synchronized void addMouseListener(MouseListener l)(Code)(Java Doc)
public synchronized void addMouseMotionListener(MouseMotionListener l)(Code)(Java Doc)
public synchronized void addMouseWheelListener(MouseWheelListener l)(Code)(Java Doc)
public void addNotify()(Code)(Java Doc)
public synchronized void addPropertyChangeListener(PropertyChangeListener listener)(Code)(Java Doc)
public synchronized void addPropertyChangeListener(String propertyName, PropertyChangeListener listener)(Code)(Java Doc)
public void applyComponentOrientation(ComponentOrientation orientation)(Code)(Java Doc)
public boolean areFocusTraversalKeysSet(int id)(Code)(Java Doc)
public Rectangle bounds()(Code)(Java Doc)
public int checkImage(Image image, ImageObserver observer)(Code)(Java Doc)
public int checkImage(Image image, int width, int height, ImageObserver observer)(Code)(Java Doc)
protected AWTEvent coalesceEvents(AWTEvent existingEvent, AWTEvent newEvent)(Code)(Java Doc)
public boolean contains(int x, int y)(Code)(Java Doc)
public boolean contains(Point p)(Code)(Java Doc)
public Image createImage(ImageProducer producer)(Code)(Java Doc)
public Image createImage(int width, int height)(Code)(Java Doc)
public VolatileImage createVolatileImage(int width, int height)(Code)(Java Doc)
public VolatileImage createVolatileImage(int width, int height, ImageCapabilities caps) throws AWTException(Code)(Java Doc)
public void deliverEvent(Event e)(Code)(Java Doc)
public void disable()(Code)(Java Doc)
final protected void disableEvents(long eventsToDisable)(Code)(Java Doc)
final public void dispatchEvent(AWTEvent e)(Code)(Java Doc)
public void doLayout()(Code)(Java Doc)
public void enable()(Code)(Java Doc)
public void enable(boolean b)(Code)(Java Doc)
final protected void enableEvents(long eventsToEnable)(Code)(Java Doc)
public void enableInputMethods(boolean enable)(Code)(Java Doc)
protected void firePropertyChange(String propertyName, Object oldValue, Object newValue)(Code)(Java Doc)
protected void firePropertyChange(String propertyName, boolean oldValue, boolean newValue)(Code)(Java Doc)
protected void firePropertyChange(String propertyName, int oldValue, int newValue)(Code)(Java Doc)
public void firePropertyChange(String propertyName, byte oldValue, byte newValue)(Code)(Java Doc)
public void firePropertyChange(String propertyName, char oldValue, char newValue)(Code)(Java Doc)
public void firePropertyChange(String propertyName, short oldValue, short newValue)(Code)(Java Doc)
public void firePropertyChange(String propertyName, long oldValue, long newValue)(Code)(Java Doc)
public void firePropertyChange(String propertyName, float oldValue, float newValue)(Code)(Java Doc)
public void firePropertyChange(String propertyName, double oldValue, double newValue)(Code)(Java Doc)
public AccessibleContext getAccessibleContext()(Code)(Java Doc)
public float getAlignmentX()(Code)(Java Doc)
public float getAlignmentY()(Code)(Java Doc)
public Color getBackground()(Code)(Java Doc)
public int getBaseline(int width, int height)(Code)(Java Doc)
public BaselineResizeBehavior getBaselineResizeBehavior()(Code)(Java Doc)
public Rectangle getBounds()(Code)(Java Doc)
public Rectangle getBounds(Rectangle rv)(Code)(Java Doc)
public ColorModel getColorModel()(Code)(Java Doc)
public Component getComponentAt(int x, int y)(Code)(Java Doc)
public Component getComponentAt(Point p)(Code)(Java Doc)
public synchronized ComponentListener[] getComponentListeners()(Code)(Java Doc)
public ComponentOrientation getComponentOrientation()(Code)(Java Doc)
public Cursor getCursor()(Code)(Java Doc)
public synchronized DropTarget getDropTarget()(Code)(Java Doc)
public Container getFocusCycleRootAncestor()(Code)(Java Doc)
public synchronized FocusListener[] getFocusListeners()(Code)(Java Doc)
public Set<AWTKeyStroke> getFocusTraversalKeys(int id)(Code)(Java Doc)
public boolean getFocusTraversalKeysEnabled()(Code)(Java Doc)
public Font getFont()(Code)(Java Doc)
public FontMetrics getFontMetrics(Font font)(Code)(Java Doc)
public Color getForeground()(Code)(Java Doc)
public Graphics getGraphics()(Code)(Java Doc)
public GraphicsConfiguration getGraphicsConfiguration()(Code)(Java Doc)
public int getHeight()(Code)(Java Doc)
public synchronized HierarchyBoundsListener[] getHierarchyBoundsListeners()(Code)(Java Doc)
public synchronized HierarchyListener[] getHierarchyListeners()(Code)(Java Doc)
public boolean getIgnoreRepaint()(Code)(Java Doc)
public InputContext getInputContext()(Code)(Java Doc)
public synchronized InputMethodListener[] getInputMethodListeners()(Code)(Java Doc)
public InputMethodRequests getInputMethodRequests()(Code)(Java Doc)
public synchronized KeyListener[] getKeyListeners()(Code)(Java Doc)
public T[] getListeners(Class<T> listenerType)(Code)(Java Doc)
public Locale getLocale()(Code)(Java Doc)
public Point getLocation()(Code)(Java Doc)
public Point getLocation(Point rv)(Code)(Java Doc)
public Point getLocationOnScreen()(Code)(Java Doc)
public Dimension getMaximumSize()(Code)(Java Doc)
public Dimension getMinimumSize()(Code)(Java Doc)
public synchronized MouseListener[] getMouseListeners()(Code)(Java Doc)
public synchronized MouseMotionListener[] getMouseMotionListeners()(Code)(Java Doc)
public Point getMousePosition() throws HeadlessException(Code)(Java Doc)
public synchronized MouseWheelListener[] getMouseWheelListeners()(Code)(Java Doc)
public String getName()(Code)(Java Doc)
public Container getParent()(Code)(Java Doc)
public ComponentPeer getPeer()(Code)(Java Doc)
public Dimension getPreferredSize()(Code)(Java Doc)
public synchronized PropertyChangeListener[] getPropertyChangeListeners()(Code)(Java Doc)
public synchronized PropertyChangeListener[] getPropertyChangeListeners(String propertyName)(Code)(Java Doc)
public Dimension getSize()(Code)(Java Doc)
public Dimension getSize(Dimension rv)(Code)(Java Doc)
public Toolkit getToolkit()(Code)(Java Doc)
final public Object getTreeLock()(Code)(Java Doc)
public int getWidth()(Code)(Java Doc)
public int getX()(Code)(Java Doc)
public int getY()(Code)(Java Doc)
public boolean gotFocus(Event evt, Object what)(Code)(Java Doc)
public boolean handleEvent(Event evt)(Code)(Java Doc)
public boolean hasFocus()(Code)(Java Doc)
public void hide()(Code)(Java Doc)
public boolean imageUpdate(Image img, int infoflags, int x, int y, int w, int h)(Code)(Java Doc)
public boolean inside(int x, int y)(Code)(Java Doc)
public void invalidate()(Code)(Java Doc)
public boolean isBackgroundSet()(Code)(Java Doc)
public boolean isCursorSet()(Code)(Java Doc)
public boolean isDisplayable()(Code)(Java Doc)
public boolean isDoubleBuffered()(Code)(Java Doc)
public boolean isEnabled()(Code)(Java Doc)
public boolean isFocusCycleRoot(Container container)(Code)(Java Doc)
public boolean isFocusOwner()(Code)(Java Doc)
public boolean isFocusTraversable()(Code)(Java Doc)
public boolean isFocusable()(Code)(Java Doc)
public boolean isFontSet()(Code)(Java Doc)
public boolean isForegroundSet()(Code)(Java Doc)
public boolean isLightweight()(Code)(Java Doc)
public boolean isMaximumSizeSet()(Code)(Java Doc)
public boolean isMinimumSizeSet()(Code)(Java Doc)
public boolean isOpaque()(Code)(Java Doc)
public boolean isPreferredSizeSet()(Code)(Java Doc)
public boolean isShowing()(Code)(Java Doc)
public boolean isValid()(Code)(Java Doc)
public boolean isVisible()(Code)(Java Doc)
public boolean keyDown(Event evt, int key)(Code)(Java Doc)
public boolean keyUp(Event evt, int key)(Code)(Java Doc)
public void layout()(Code)(Java Doc)
public void list()(Code)(Java Doc)
public void list(PrintStream out)(Code)(Java Doc)
public void list(PrintStream out, int indent)(Code)(Java Doc)
public void list(PrintWriter out)(Code)(Java Doc)
public void list(PrintWriter out, int indent)(Code)(Java Doc)
public Component locate(int x, int y)(Code)(Java Doc)
public Point location()(Code)(Java Doc)
public boolean lostFocus(Event evt, Object what)(Code)(Java Doc)
public Dimension minimumSize()(Code)(Java Doc)
public boolean mouseDown(Event evt, int x, int y)(Code)(Java Doc)
public boolean mouseDrag(Event evt, int x, int y)(Code)(Java Doc)
public boolean mouseEnter(Event evt, int x, int y)(Code)(Java Doc)
public boolean mouseExit(Event evt, int x, int y)(Code)(Java Doc)
public boolean mouseMove(Event evt, int x, int y)(Code)(Java Doc)
public boolean mouseUp(Event evt, int x, int y)(Code)(Java Doc)
public void move(int x, int y)(Code)(Java Doc)
public void nextFocus()(Code)(Java Doc)
public void paint(Graphics g)(Code)(Java Doc)
public void paintAll(Graphics g)(Code)(Java Doc)
protected String paramString()(Code)(Java Doc)
public boolean postEvent(Event e)(Code)(Java Doc)
public Dimension preferredSize()(Code)(Java Doc)
public boolean prepareImage(Image image, ImageObserver observer)(Code)(Java Doc)
public boolean prepareImage(Image image, int width, int height, ImageObserver observer)(Code)(Java Doc)
public void print(Graphics g)(Code)(Java Doc)
public void printAll(Graphics g)(Code)(Java Doc)
protected void processComponentEvent(ComponentEvent e)(Code)(Java Doc)
protected void processEvent(AWTEvent e)(Code)(Java Doc)
protected void processFocusEvent(FocusEvent e)(Code)(Java Doc)
protected void processHierarchyBoundsEvent(HierarchyEvent e)(Code)(Java Doc)
protected void processHierarchyEvent(HierarchyEvent e)(Code)(Java Doc)
protected void processInputMethodEvent(InputMethodEvent e)(Code)(Java Doc)
protected void processKeyEvent(KeyEvent e)(Code)(Java Doc)
protected void processMouseEvent(MouseEvent e)(Code)(Java Doc)
protected void processMouseMotionEvent(MouseEvent e)(Code)(Java Doc)
protected void processMouseWheelEvent(MouseWheelEvent e)(Code)(Java Doc)
public void remove(MenuComponent popup)(Code)(Java Doc)
public synchronized void removeComponentListener(ComponentListener l)(Code)(Java Doc)
public synchronized void removeFocusListener(FocusListener l)(Code)(Java Doc)
public void removeHierarchyBoundsListener(HierarchyBoundsListener l)(Code)(Java Doc)
public void removeHierarchyListener(HierarchyListener l)(Code)(Java Doc)
public synchronized void removeInputMethodListener(InputMethodListener l)(Code)(Java Doc)
public synchronized void removeKeyListener(KeyListener l)(Code)(Java Doc)
public synchronized void removeMouseListener(MouseListener l)(Code)(Java Doc)
public synchronized void removeMouseMotionListener(MouseMotionListener l)(Code)(Java Doc)
public synchronized void removeMouseWheelListener(MouseWheelListener l)(Code)(Java Doc)
public void removeNotify()(Code)(Java Doc)
public synchronized void removePropertyChangeListener(PropertyChangeListener listener)(Code)(Java Doc)
public synchronized void removePropertyChangeListener(String propertyName, PropertyChangeListener listener)(Code)(Java Doc)
public void repaint()(Code)(Java Doc)
public void repaint(long tm)(Code)(Java Doc)
public void repaint(int x, int y, int width, int height)(Code)(Java Doc)
public void repaint(long tm, int x, int y, int width, int height)(Code)(Java Doc)
public void requestFocus()(Code)(Java Doc)
protected boolean requestFocus(boolean temporary)(Code)(Java Doc)
public boolean requestFocusInWindow()(Code)(Java Doc)
protected boolean requestFocusInWindow(boolean temporary)(Code)(Java Doc)
public void reshape(int x, int y, int width, int height)(Code)(Java Doc)
public void resize(int width, int height)(Code)(Java Doc)
public void resize(Dimension d)(Code)(Java Doc)
public void setBackground(Color c)(Code)(Java Doc)
public void setBounds(int x, int y, int width, int height)(Code)(Java Doc)
public void setBounds(Rectangle r)(Code)(Java Doc)
public void setComponentOrientation(ComponentOrientation o)(Code)(Java Doc)
public void setCursor(Cursor cursor)(Code)(Java Doc)
public synchronized void setDropTarget(DropTarget dt)(Code)(Java Doc)
public void setEnabled(boolean b)(Code)(Java Doc)
public void setFocusTraversalKeys(int id, Set<? extends AWTKeyStroke> keystrokes)(Code)(Java Doc)
public void setFocusTraversalKeysEnabled(boolean focusTraversalKeysEnabled)(Code)(Java Doc)
public void setFocusable(boolean focusable)(Code)(Java Doc)
public void setFont(Font f)(Code)(Java Doc)
public void setForeground(Color c)(Code)(Java Doc)
public void setIgnoreRepaint(boolean ignoreRepaint)(Code)(Java Doc)
public void setLocale(Locale l)(Code)(Java Doc)
public void setLocation(int x, int y)(Code)(Java Doc)
public void setLocation(Point p)(Code)(Java Doc)
public void setMaximumSize(Dimension maximumSize)(Code)(Java Doc)
public void setMinimumSize(Dimension minimumSize)(Code)(Java Doc)
public void setName(String name)(Code)(Java Doc)
public void setPreferredSize(Dimension preferredSize)(Code)(Java Doc)
public void setSize(int width, int height)(Code)(Java Doc)
public void setSize(Dimension d)(Code)(Java Doc)
public void setVisible(boolean b)(Code)(Java Doc)
public void show()(Code)(Java Doc)
public void show(boolean b)(Code)(Java Doc)
public Dimension size()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
public void transferFocus()(Code)(Java Doc)
public void transferFocusBackward()(Code)(Java Doc)
public void transferFocusUpCycle()(Code)(Java Doc)
public void update(Graphics g)(Code)(Java Doc)
public void validate()(Code)(Java Doc)
|
|
|