All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class jclass.bwt.JCOutlinerComponent

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Canvas
                   |
                   +----jclass.bwt.JCComponent
                           |
                           +----jclass.bwt.JCOutlinerComponent

public class JCOutlinerComponent

extends JCComponent

implements JCOutlinerInterface, JCMultiColumnInterface, JCSortInterface, JCScrollableInterface

See Also:

JCOutliner

actionListeners

List of JCActionEvent listeners

BEGIN

data

The object which maintains the multi-column data.

default_style

DRAGDROP_ALL

DRAGDROP_NONE

DRAGDROP_SOURCE

DRAGDROP_TARGET

END

FOLDER_CLOSED

FOLDER_OPEN_ALL

FOLDER_OPEN_FOLDERS

FOLDER_OPEN_ITEMS

FOLDER_OPEN_NONE

full_node_height

itemListeners

List of JCOutlinerEvent listeners

node_list

List of all nodes, in drawing order.

scrolled_window

Parent window.

shortcut_close_icon

shortcut_open_icon

SHORTCUT_SIZE

style_list

JCOutlinerComponent()

Creates an empty JCOutliner.

JCOutlinerComponent(int, boolean)

Creates an outliner with the specified number of visible lines.

JCOutlinerComponent(JCOutlinerNode)

Creates a new JCOutliner with the specified root node.

JCOutlinerComponent(JCOutlinerNode, Applet, String)

Creates an outliner which reads parameters from the applet's HTML file.

addActionListener(JCActionListener)

Adds the specified action listener to receive action events.

addItemListener(JCItemListener)

Adds the specified item listener to receive node events.

addNotify()

Creates icons and processes nodes.

calculateNodeHeight(JCOutlinerNode)

Calculates the height of a node (by looking at the node's style).

calculateStyleHeight(JCOutlinerNodeStyle)

Calculates the height of a node given its style characteristics.

calcWidth(int)

Calculates the width of a column for all nodes.

calcWidth(JCOutlinerNode, int)

Calculates the width of a node's column, excluding the left and right margins.

checkState(int)

Checks that a state is valid.

compare(Object, Object)

JCSortInterface comparison method.

countAllNodes(JCOutlinerNode, JCVector)

Returns the number of nodes and subnodes in a folder, regardless of visibility

countChildren(JCOutlinerNode)

Returns the number of nodes and subnodes in a folder.

countPreviousRows(JCOutlinerNode)

Returns the number of visible nodes prior to a node.

countRows(JCOutlinerNode)

Returns the number of visible nodes and subnodes in a folder.

countRows(JCOutlinerNode, JCOutlinerNode)

Returns the number of visible nodes between 2 nodes.

doubleClickAction(JCOutlinerNode, Event)

Called when the node is double-clicked.

drawNode(JCOutlinerNode, boolean)

Draws a single node.

drawNode(JCOutlinerNode, Graphics, boolean)

Draws a single node.

drawNode(JCOutlinerNode, int, int, Graphics)

Draws a node and its children.

drawShortcut(JCOutlinerNode, Graphics, int, int)

Draws a folder's shortcut button.

drop(Event)

Called when the user finishes the drag & drop operation.

dropOver(Event)

Called as the user drags over the outliner.

eventInShortcut(Event, JCOutlinerNode)

Returns true if the node is a folder and the event is within the folder's shortcut button.

eventToNode(Event)

Gets the node in which the event occurred.

eventToNode(Event, boolean)

Gets the node in which the event occurred.

findNode(char)

Finds the first node whose label starts with the specified character, or null if none could be found.

findNode(JCOutlinerNode, int)

Returns a visible node at a position.

folderChanged(JCOutlinerNode)

Notifies the outliner that the number of a folder's children has changed.

getAllowMultipleSelections()

Returns true if this outliner allows multiple selections.

getAutoSelect()

Gets the AutoSelect value.

getBatched()

Gets the Batched value.

getBounds(JCOutlinerNode, Rectangle)

Gets the physical bounding rectangle of a node (icon and label) (ie adjusted for scrolling and insets).

getColumnAlignment(int)

Gets a column's alignment.

getColumnAlignments()

Gets the column alignments.

getColumnLeftMargin(int)

Gets the column's left margin value (pixels).

getColumnPosition(int)

Gets the physical position of the left boundary of the column (accounting for horizontal scrolling).

getColumnRightMargin(int)

Gets the column's right margin value (pixels).

getColumnWidth(int)

Gets the current width of a column, or 0 if the column does not exist.

getColumnWidths()

Gets a list of the column widths.

getDefaultNodeStyle()

Gets the default node style.

getDoubleBufferGraphics()

Creates a double-buffer image, for subsequent retrieval via getDoubleBufferImage

getDoubleBufferImage()

Returns the double-buffer image previously created in a call to getDoubleBufferGraphics.

getDragAndDropPolicy()

Gets the DragAndDropPolicy value.

getFocusNode()

Returns the node which currently has focus, or null.

getHorizOrigin()

Gets the horizontal origin.

getIcon(JCOutlinerNode)

Gets the appropriate image for a node.

getMultiColumnData()

Gets the component's JCMultiColumnData instance.

getNextNode(JCOutlinerNode)

Returns the next node (not necessarily visible).

getNextState(JCOutlinerNode)

Gets the folder's next state, or BWTEnum.NOVALUE if the node is not a folder.

getNextVisibleNode(JCOutlinerNode)

Returns the next visible node, or null if none was found.

getNodeHeight()

Gets the NodeHeight value.

getNodeIndent()

Gets the NodeIndent value.

getNumColumns()

Gets the current number of columns.

getNumNodes()

Gets the current number of non-collapsed nodes (ie the number of open folders and their children).

getParameters()

Reads the parameter values from the HTML page using the component's applet.

getPreviousNode(JCOutlinerNode)

Returns the previous node (not necessarily visible).

getPreviousVisibleNode(JCOutlinerNode)

Returns the previous visible node, or null if none was found.

getRootNode()

Gets the root node.

getRootVisible()

Gets the RootVisible value.

getSelectedIndex()

Gets the row of the first selected node, or BWTEnum.NOTFOUND if no node is selected.

getSelectedIndexes()

Returns an array containing the selected indexes, or null if no nodes are selected.

getSelectedNode()

Returns the currently selected node, or null.

getSelectedObjects()

Returns the an array (length 1) containing the label of the selected node, or null if no node is selected.

getSpacing()

Gets the spacing between items.

getStateList()

Gets the current StateList.

getStyleList()

Gets the current StyleList.

getTree()

Gets the current node hierarchy as a string list.

getVertOrigin()

Gets the vertical origin.

getVisibleNodes()

Gets a list of the nodes which are currently displayed.

getVisibleRows()

Returns the number of visible lines.

invalidate()

Invalidates the component.

isDropTarget(JCOutlinerNode, JCOutlinerNode)

Returns true if the node is a potential target for a drag & drop operation by the drag node.

isMultiSelectable(JCOutlinerNode, boolean)

If more then one node will be selected as a result of the last event, we check to make sure all nodes have the same parent

isVisible(JCOutlinerNode)

Checks whether the node should be visible.

keyDown(Event, int)

If the down arrow is hit, calls nextFocus.

If the up arrow is hit, calls previousFocus.

If RETURN is hit, calls doubleClickAction for the focus node.

If space key is hit, selects focus node.

makeNodeVisible(JCOutlinerNode)

Scrolls the display if necessary to make the node visible.

mouseDown(Event, int, int)

Process mouse down events.

If a node is clicked, setFocusNode and selectNode are called.

If a node is double-clicked or a shortcut button is clicked, calls doubleClickAction.

mouseDrag(Event, int, int)

mouseUp(Event, int, int)

multiSelectNode(JCOutlinerNode, Event)

MultiSelect support This exhibits multi-select behavior similar to the Windows ListView, but some logic must be altered to bring it into complete emulation.

nextFocus(Event)

Sets the focus on the next node after the current node which has focus.

paintComponent(Graphics)

Draws all visible nodes.

postActionEvent(Event, int, JCOutlinerNode, int)

Posts a JCOutlinerEvent if the node is a folder, or a JCActionEvent if the node is not a folder

preferredHeight()

Calculates the height based on the node heights.

preferredWidth()

Gets the subclass' preferred width (default: 100).

previousFocus(Event)

Sets the focus on the previous node before the current node which has focus.

processRootNode()

Sets the node_list.

removeActionListener(JCActionListener)

Removes the specified action listener so it no longer receives action events.

removeItemListener(JCItemListener)

Removes the specified item listener so it no longer receives node events.

repaint()

Repaints the component if Batched is false.

selectNode(JCOutlinerNode)

Selects a node.

selectNode(JCOutlinerNode, Event)

Selects a node, and posts a JCOutlinerEvent.

setAllowMultipleSelections(boolean)

Sets whether the outliner allows multiple selections.

setAutoSelect(boolean)

If true (default), the node which currently has focus is also selected.

setBackground(Color)

Sets the background color of the component.

HTML param name/value: "Background"/Color

setBatched(boolean)

If false (default), the component is repainted every time an item is changed.

setColumnAlignment(int, int)

Sets a column's alignment.

setColumnAlignments(int[])

Sets the column's alignments.

setColumnButtons(JCVector)

If the outliner is a child of a JCOutliner, sets a header for the window with buttons with the specified labels.

setColumnLabels(JCVector)

If the list is a child of a JCMultiColumnList, sets a header for the window with the specified labels.

setColumnLeftMargin(int, int)

Sets the column's left margin value (pixels) (default: 2).

setColumnRightMargin(int, int)

Sets the column's right margin value (pixels) (default: 2).

The values for all columns may be set from an HTML file using a PARAM tag with a "ColumnRightMargins" name and a comma-separated list of ints.

setColumnWidth(int, int)

Sets the width of a column.

setColumnWidths(int[])

Sets the list of column widths.

setDoubleBuffer(boolean)

Controls whether double-buffering is used when displaying and updating the component (default: true).

HTML param name/value: "DoubleBuffer"/boolean

setDragAndDropPolicy(int)

Sets whether the outliner can be used as a drag and/or drop site.

setFocusNode(JCOutlinerNode, Event)

Sets a node to have the keyboard focus.

setFont(Font)

Sets the font of the component.

setForeground(Color)

Sets the foreground color of the component.

HTML param name/value: "Foreground"/Color

setHorizOrigin(int)

Sets the horizontal origin prior to scrolling.

setNodeHeight(int)

Sets the height of each node (pixels).

setNodeIndent(int)

Sets the indentation of each node relative to its parent (pixels) (default: 15).

setNodeState(JCOutlinerNode, int, boolean)

Sets the state of a folder.

setNumColumns(int)

Sets the current number of columns (default: 1).

HTML param name/value: "NumColumns"/int

setRootNode(JCOutlinerNode)

Sets the root node.

setRootVisible(boolean)

If true (default), the root node is drawn.

setSpacing(int)

Sets the spacing between items (default: 0).

setStateList(int[])

Sets a list of values used for double-clicking on a folder or clicking it shortcut button.

setStyleList(JCOutlinerNodeStyle[])

Sets the list of node styles.

setTree(String[])

Sets the node hierarchy by parsing the string list.

setVertOrigin(int)

Sets the vertical origin prior to scrolling.

setVisibleRows(int)

Sets the number of visible rows.

shouldBeDrawn(JCOutlinerNode)

Checks the node's folder to determine whether the node should be drawn.

sort(int, JCSortInterface, int)

Sorts the open nodes in the list based on a specified column, using the String equivalents of each value.

 public static final int FOLDER_CLOSED

 public static final int FOLDER_OPEN_NONE

 public static final int FOLDER_OPEN_FOLDERS

 public static final int FOLDER_OPEN_ITEMS

 public static final int FOLDER_OPEN_ALL

 public static final int DRAGDROP_NONE

 public static final int DRAGDROP_TARGET

 public static final int DRAGDROP_SOURCE

 public static final int DRAGDROP_ALL

 protected OutlinerMultiColumnData data

The object which maintains the multi-column data.

 protected transient JCMultiColumnWindow scrolled_window

Parent window.

 protected JCVector node_list

List of all nodes, in drawing order.

 protected JCOutlinerNodeStyle style_list[]

 protected JCOutlinerNodeStyle default_style

 protected transient Image shortcut_open_icon

 protected transient Image shortcut_close_icon

 protected static final int SHORTCUT_SIZE

 protected static final int BEGIN

 protected static final int END

 protected int full_node_height

 protected JCVector itemListeners

List of JCOutlinerEvent listeners

 protected JCVector actionListeners

List of JCActionEvent listeners

 public JCOutlinerComponent()

Creates an empty JCOutliner.

 public JCOutlinerComponent(JCOutlinerNode root)

Creates a new JCOutliner with the specified root node.

 public JCOutlinerComponent(int rows,
                            boolean multipleSelections)

Creates an outliner with the specified number of visible lines.

Parameters:

rows - the number of items to show. If set to 0, the outliner will attempt to show all its items.

multipleSelections - if true then multiple selections are allowed.

 public JCOutlinerComponent(JCOutlinerNode root,
                            Applet applet,
                            String name)

Creates an outliner which reads parameters from the applet's HTML file.

Parameters:

root - the root node (may be null, and set later with setRootNode())

applet - the applet whose PARAM tags are to be read

name - if this is not null, only parameters preceded by this name are read

See Also:

setRootNode, getParameter, JCString

 protected void getParameters()

Reads the parameter values from the HTML page using the component's applet. The values will override those previously set.

Overrides:

getParameters in class JCComponent

 public synchronized void setFont(Font f)

Sets the font of the component. This value may be set from an HTML file using a PARAM tag with a "Font" name and a Font value.

Overrides:

setFont in class JCComponent

See Also:

toFont

 protected void processRootNode()

Sets the node_list.

 public synchronized void setColumnLabels(JCVector labels)

If the list is a child of a JCMultiColumnList, sets a header for the window with the specified labels.

See Also:

setColumnLabels

 public synchronized void setColumnButtons(JCVector labels)

If the outliner is a child of a JCOutliner, sets a header for the window with buttons with the specified labels.

See Also:

setColumnButtons

 public synchronized void folderChanged(JCOutlinerNode node)

Notifies the outliner that the number of a folder's children has changed. This must be called only if the outliner has been made visible.

 public JCOutlinerNode getRootNode()

Gets the root node.

See Also:

setRootNode

 public synchronized void setRootNode(JCOutlinerNode node)

Sets the root node.

 public String[] getTree()

Gets the current node hierarchy as a string list.

See Also:

setTree

 public synchronized void setTree(String s[])

Sets the node hierarchy by parsing the string list. Each line in the list represents a node. Spaces or tabs at the start of each line specify the tree hierarchy. Lines with the same indentation level are children.

Throws: IllegalArgumentException

if the indentation levels are invalid

 public boolean getRootVisible()

Gets the RootVisible value.

See Also:

setRootVisible

 public synchronized void setRootVisible(boolean v)

If true (default), the root node is drawn.

 public boolean getBatched()

Gets the Batched value.

See Also:

setBatched

 public synchronized void setBatched(boolean v)

If false (default), the component is repainted every time an item is changed. If set to true, the component is only repainted (if necessary) when the value is again set to false.

 public int getNodeHeight()

Gets the NodeHeight value.

See Also:

setNodeHeight

 public synchronized void setNodeHeight(int v)

Sets the height of each node (pixels). If 0 (default), the height is determined using the largest font and image height in the list of node styles.

 public int getNumNodes()

Gets the current number of non-collapsed nodes (ie the number of open folders and their children).

 public boolean getAllowMultipleSelections()

Returns true if this outliner allows multiple selections.

See Also:

setAllowMultipleSelections

 public void setAllowMultipleSelections(boolean v)

Sets whether the outliner allows multiple selections. HTML param name/value: "AllowMultipleSelections"/boolean

See Also:

getAllowMultipleSelections

 public boolean getAutoSelect()

Gets the AutoSelect value.

See Also:

setAutoSelect

 public synchronized void setAutoSelect(boolean v)

If true (default), the node which currently has focus is also selected.

See Also:

setFocusNode, selectNode

 public int getNodeIndent()

Gets the NodeIndent value.

See Also:

setNodeIndent

 public synchronized void setNodeIndent(int v)

Sets the indentation of each node relative to its parent (pixels) (default: 15).

 public int[] getStateList()

Gets the current StateList.

See Also:

setStateList

 public synchronized void setStateList(int list[])

Sets a list of values used for double-clicking on a folder or clicking it shortcut button. If this list is changed, the outliner will be redrawn. The folder's state is cycled through the list. Valid values:

 FOLDER_CLOSED       Folder closed; no children visible
 FOLDER_OPEN_NONE    Folder open; no children visible
 FOLDER_OPEN_FOLDERS Folder open; only folder children visible
 FOLDER_OPEN_ITEMS   Folder open; only non-folder children visible
 FOLDER_OPEN_ALL     Folder open; all children visible
 

Default value: { FOLDER_CLOSED, FOLDER_OPEN_ALL }

 public JCOutlinerNodeStyle[] getStyleList()

Gets the current StyleList.

See Also:

setStyleList

 public synchronized void setStyleList(JCOutlinerNodeStyle list[])

Sets the list of node styles. The list is only used for determining the node height if it has not been set.

See Also:

setNodeHeight

 public synchronized void setForeground(Color c)

Sets the foreground color of the component.

HTML param name/value: "Foreground"/Color

Overrides:

setForeground in class JCComponent

 public synchronized void setBackground(Color c)

Sets the background color of the component.

HTML param name/value: "Background"/Color

Overrides:

setBackground in class JCComponent

 public JCOutlinerNodeStyle getDefaultNodeStyle()

Gets the default node style.

 public int getSpacing()

Gets the spacing between items.

See Also:

setSpacing

 public synchronized void setSpacing(int v)

Sets the spacing between items (default: 0). This value increases the HighlightThickness value.

See Also:

setHighlightThickness

 public int getVisibleRows()

Returns the number of visible lines.

See Also:

setVisibleRows

 public synchronized void setVisibleRows(int v)

Sets the number of visible rows. If set to 0 (default), the list will attempt to resize itself so that all its items are visible.

 public synchronized int getSelectedIndex()

Gets the row of the first selected node, or BWTEnum.NOTFOUND if no node is selected.

See Also:

selectNode

 public synchronized int[] getSelectedIndexes()

Returns an array containing the selected indexes, or null if no nodes are selected.

 public synchronized Object[] getSelectedObjects()

Returns the an array (length 1) containing the label of the selected node, or null if no node is selected.

 public synchronized JCOutlinerNode getSelectedNode()

Returns the currently selected node, or null.

 public synchronized void selectNode(JCOutlinerNode node,
                                     Event ev)

Selects a node, and posts a JCOutlinerEvent.

Parameters:

node - if null, the currently selected node is deselected

ev - event which caused the selection

See Also:

addItemListener

 protected void selectNode(JCOutlinerNode node)

Selects a node.

Parameters:

node - if null, the currently selected node is deselected

 protected boolean isMultiSelectable(JCOutlinerNode node,
                                     boolean bMulti)

If more then one node will be selected as a result of the last event, we check to make sure all nodes have the same parent

 public synchronized void multiSelectNode(JCOutlinerNode node,
                                          Event ev)

MultiSelect support This exhibits multi-select behavior similar to the Windows ListView, but some logic must be altered to bring it into complete emulation. Select one or more nodes, and posts JCOutlinerEvents.

Parameters:

node - if null, the currently selected node is deselected

ev - event which caused the selection

See Also:

addItemListener

 public JCOutlinerNode getFocusNode()

Returns the node which currently has focus, or null.

 public synchronized void setFocusNode(JCOutlinerNode node,
                                       Event ev)

Sets a node to have the keyboard focus.

Parameters:

node - if null, no the current focus node is unchanged

ev - event which caused the focus change

 public JCVector getVisibleNodes()

Gets a list of the nodes which are currently displayed.

 public JCOutlinerNode findNode(char c)

Finds the first node whose label starts with the specified character, or null if none could be found.

 public int calculateNodeHeight(JCOutlinerNode node)

Calculates the height of a node (by looking at the node's style).

 protected int calculateStyleHeight(JCOutlinerNodeStyle style)

Calculates the height of a node given its style characteristics.

 protected int preferredHeight()

Calculates the height based on the node heights.

Overrides:

preferredHeight in class JCComponent

 protected int preferredWidth()

Gets the subclass' preferred width (default: 100).

Overrides:

preferredWidth in class JCComponent

 public synchronized void repaint()

Repaints the component if Batched is false.

Overrides:

repaint in class JCComponent

See Also:

setBatched

 public void addNotify()

Creates icons and processes nodes.

Overrides:

addNotify in class JCComponent

 public synchronized void setDoubleBuffer(boolean v)

Controls whether double-buffering is used when displaying and updating the component (default: true).

HTML param name/value: "DoubleBuffer"/boolean

Overrides:

setDoubleBuffer in class JCComponent

 public void invalidate()

Invalidates the component.

Overrides:

invalidate in class Component

 public Image getDoubleBufferImage()

Returns the double-buffer image previously created in a call to getDoubleBufferGraphics.

Overrides:

getDoubleBufferImage in class JCComponent

 public synchronized Graphics getDoubleBufferGraphics()

Creates a double-buffer image, for subsequent retrieval via getDoubleBufferImage

Overrides:

getDoubleBufferGraphics in class JCComponent

 protected void paintComponent(Graphics gc)

Draws all visible nodes.

Overrides:

paintComponent in class JCComponent

 public boolean setNodeState(JCOutlinerNode node,
                             int state,
                             boolean notify)

Sets the state of a folder.

Parameters:

node - if not a folder, no action is taken

state - one of:

 FOLDER_CLOSED       Folder closed; no children visible
 FOLDER_OPEN_NONE    Folder open; no children visible
 FOLDER_OPEN_FOLDERS Folder open; only folder children visible
 FOLDER_OPEN_ITEMS   Folder open; only non-folder children visible
 FOLDER_OPEN_ALL     Folder open; all children visible
 

notify - if true, a JCOutlinerEvent is posted for the node

Returns:

false if the app disallowed the state change

Throws: IllegalArgumentException

If the value is invalid

See Also:

addActionListener, addItemListener

 public boolean makeNodeVisible(JCOutlinerNode node)

Scrolls the display if necessary to make the node visible.

Returns:

false if the node could not be made visible due to its parent's state

 protected boolean checkState(int state)

Checks that a state is valid.

 protected int getNextState(JCOutlinerNode folder)

Gets the folder's next state, or BWTEnum.NOVALUE if the node is not a folder.

 public JCOutlinerNode getNextNode(JCOutlinerNode node)

Returns the next node (not necessarily visible).

See Also:

getNextVisibleNode

 public JCOutlinerNode getNextVisibleNode(JCOutlinerNode node)

Returns the next visible node, or null if none was found.

 public JCOutlinerNode getPreviousNode(JCOutlinerNode node)

Returns the previous node (not necessarily visible).

See Also:

getPreviousVisibleNode

 public JCOutlinerNode getPreviousVisibleNode(JCOutlinerNode node)

Returns the previous visible node, or null if none was found.

 protected boolean nextFocus(Event ev)

Sets the focus on the next node after the current node which has focus.

 protected boolean previousFocus(Event ev)

Sets the focus on the previous node before the current node which has focus.

 public void addItemListener(JCItemListener l)

Adds the specified item listener to receive node events. If the listener implements JCOutlinerListener (an JCItemListener subclass), it will be passed JCOutlinerEvents.

See Also:

JCItemEvent, JCOutlinerEvent, JCOutlinerListener

 public void removeItemListener(JCItemListener l)

Removes the specified item listener so it no longer receives node events.

 public void addActionListener(JCActionListener l)

Adds the specified action listener to receive action events. Action events occur when a node is double-clicked.

See Also:

JCActionEvent

 public void removeActionListener(JCActionListener l)

Removes the specified action listener so it no longer receives action events.

See Also:

addActionListener

 protected JCOutlinerEvent postActionEvent(Event ev,
                                           int stage,
                                           JCOutlinerNode node,
                                           int new_state)

Posts a JCOutlinerEvent if the node is a folder, or a JCActionEvent if the node is not a folder

Parameters:

stage - BEGIN or END

Returns:

the posted event, or null if no itemListeners/actionListeners have been registered

See Also:

addActionListener, addItemListener

 protected boolean doubleClickAction(JCOutlinerNode node,
                                     Event ev)

Called when the node is double-clicked.

 public boolean keyDown(Event ev,
                        int key)

If the down arrow is hit, calls nextFocus.

If the up arrow is hit, calls previousFocus.

If RETURN is hit, calls doubleClickAction for the focus node.

If space key is hit, selects focus node.

Overrides:

keyDown in class Component

See Also:

nextFocus, previousFocus, doubleClickAction

 public JCOutlinerNode eventToNode(Event ev)

Gets the node in which the event occurred.

 public JCOutlinerNode eventToNode(Event ev,
                                   boolean inside)

Gets the node in which the event occurred.

Parameters:

inside - if true, the event must be inside the node

 public boolean eventInShortcut(Event ev,
                                JCOutlinerNode node)

Returns true if the node is a folder and the event is within the folder's shortcut button.

 public boolean mouseDown(Event ev,
                          int x,
                          int y)

Process mouse down events.

If a node is clicked, setFocusNode and selectNode are called.

If a node is double-clicked or a shortcut button is clicked, calls doubleClickAction.

Overrides:

mouseDown in class JCComponent

See Also:

setFocusNode, selectNode, doubleClickAction

 public int getDragAndDropPolicy()

Gets the DragAndDropPolicy value.

See Also:

setDragAndDropPolicy

 public void setDragAndDropPolicy(int v)

Sets whether the outliner can be used as a drag and/or drop site.

Parameters:

v - DRAGDROP_NONE (default), DRAGDROP_TARGET, DRAGDROP_SOURCE, DRAGDROP_ALL

 protected boolean isDropTarget(JCOutlinerNode drag_node,
                                JCOutlinerNode node)

Returns true if the node is a potential target for a drag & drop operation by the drag node. It returns false if the nodes are equal, or if the drag_node is the drop node's parent.

 public boolean mouseDrag(Event ev,
                          int x,
                          int y)

Overrides:

mouseDrag in class Component

 public boolean dropOver(Event ev)

Called as the user drags over the outliner.

Returns:

true if the drag was handled

 public boolean mouseUp(Event ev,
                        int x,
                        int y)

Overrides:

mouseUp in class Component

 public boolean drop(Event ev)

Called when the user finishes the drag & drop operation.

Returns:

true if the drop was handled

 public Rectangle getBounds(JCOutlinerNode node,
                            Rectangle rect)

Gets the physical bounding rectangle of a node (icon and label) (ie adjusted for scrolling and insets).

Parameters:

rect - if not null, its members are set

Returns:

null if rect is null, otherwise the bounding rectangle

 protected Image getIcon(JCOutlinerNode node)

Gets the appropriate image for a node.

 protected boolean shouldBeDrawn(JCOutlinerNode node)

Checks the node's folder to determine whether the node should be drawn.

 protected boolean isVisible(JCOutlinerNode node)

Checks whether the node should be visible.

 protected boolean drawNode(JCOutlinerNode node,
                            boolean clear)

Draws a single node.

Parameters:

clear - if true, the node's rectangle is cleared to the background color

Returns:

false if the node is outside the drawing area

 protected boolean drawNode(JCOutlinerNode node,
                            Graphics gc,
                            boolean clear)

Draws a single node.

Parameters:

clear - if true, the node's rectangle is cleared to the background color

Returns:

false if the node is outside the drawing area

 protected int drawNode(JCOutlinerNode node,
                        int indent,
                        int row,
                        Graphics gc)

Draws a node and its children.

Parameters:

indent - indentation level at which to draw node

row - row at which to draw node

Returns:

the number of rows this node took to display

 protected void drawShortcut(JCOutlinerNode node,
                             Graphics gc,
                             int x,
                             int y)

Draws a folder's shortcut button.

 protected int countRows(JCOutlinerNode node)

Returns the number of visible nodes and subnodes in a folder.

 protected int countChildren(JCOutlinerNode node)

Returns the number of nodes and subnodes in a folder.

 protected int countPreviousRows(JCOutlinerNode node)

Returns the number of visible nodes prior to a node.

 protected int countRows(JCOutlinerNode from,
                         JCOutlinerNode to)

Returns the number of visible nodes between 2 nodes.

 protected int countAllNodes(JCOutlinerNode node,
                             JCVector list)

Returns the number of nodes and subnodes in a folder, regardless of visibility

Parameters:

list - if not null, the node is added to it

 protected JCOutlinerNode findNode(JCOutlinerNode node,
                                   int row)

Returns a visible node at a position. If not present, its visible children are checked.

 public boolean compare(Object o1,
                        Object o2)

JCSortInterface comparison method. Compares nodes based on their labels.

 public void sort(int column,
                  JCSortInterface sort_if,
                  int direction)

Sorts the open nodes in the list based on a specified column, using the String equivalents of each value.

Parameters:

sort_if - An optional interface whose compare method is called during sorting, to provide a mechanism for the application to specify whether one object is greater than another (similar to qsort's compare function). If this parameter is null, the column is sorted by numerical or string comparison as applicable.

direction - sort direction: JCqsort.ASCENDING or DESCENDING

 protected int calcWidth(JCOutlinerNode node,
                         int col)

Calculates the width of a node's column, excluding the left and right margins.

 public int calcWidth(int col)

Calculates the width of a column for all nodes.

 public int[] getColumnWidths()

Gets a list of the column widths.

See Also:

setColumnWidths

 public void setColumnWidths(int widths[])

Sets the list of column widths. If a column's value is set to BWTEnum.VARIABLE, the width is set to the widest value in the column.

This value may be set from an HTML file using a PARAM tag with a "ColumnWidths" name and a comma-separated list of ints.

 public int getColumnWidth(int col)

Gets the current width of a column, or 0 if the column does not exist.

 public void setColumnWidth(int col,
                            int width)

Sets the width of a column. If the value is set to BWTEnum.VARIABLE, the width is set to the widest value in the column.

 public int getNumColumns()

Gets the current number of columns.

 public void setNumColumns(int v)

Sets the current number of columns (default: 1).

HTML param name/value: "NumColumns"/int

 public int[] getColumnAlignments()

Gets the column alignments.

 public int getColumnAlignment(int col)

Gets a column's alignment.

 public void setColumnAlignment(int col,
                                int align)

Sets a column's alignment. The first column's alignment (column 0) cannot be set.

Parameters:

alignment - one of: BWTEnum.TOPLEFT, TOPCENTER, TOPRIGHT, MIDDLELEFT (default), MIDDLECENTER, MIDDLERIGHT, BOTTOMLEFT, BOTTOMCENTER and BOTTOMRIGHT

 public void setColumnAlignments(int align[])

Sets the column's alignments. The first column's alignment (column 0) cannot be set.

HTML param name/value: "ColumnAlignments"/a comma-separated list of enums.

Parameters:

align - one of: BWTEnum.TOPLEFT, TOPCENTER, TOPRIGHT, MIDDLELEFT (default), MIDDLECENTER, MIDDLERIGHT, BOTTOMLEFT, BOTTOMCENTER and BOTTOMRIGHT

 public int getColumnPosition(int col)

Gets the physical position of the left boundary of the column (accounting for horizontal scrolling).

 public int getColumnLeftMargin(int col)

Gets the column's left margin value (pixels).

 public void setColumnLeftMargin(int col,
                                 int value)

Sets the column's left margin value (pixels) (default: 2). The values for all columns may be set from an HTML file using a PARAM tag with a "ColumnLeftMargins" name and a comma-separated list of ints.

 public int getColumnRightMargin(int col)

Gets the column's right margin value (pixels).

 public void setColumnRightMargin(int col,
                                  int value)

Sets the column's right margin value (pixels) (default: 2).

The values for all columns may be set from an HTML file using a PARAM tag with a "ColumnRightMargins" name and a comma-separated list of ints.

 public JCMultiColumnData getMultiColumnData()

Gets the component's JCMultiColumnData instance.

 public int getHorizOrigin()

Gets the horizontal origin.

 public void setHorizOrigin(int v)

Sets the horizontal origin prior to scrolling.

 public int getVertOrigin()

Gets the vertical origin.

 public void setVertOrigin(int v)

Sets the vertical origin prior to scrolling.

All Packages  Class Hierarchy  This Package  Previous  Next  Index