|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.awt.Component | +--java.awt.Container | +--java.awt.Window | +--java.awt.Frame | +--javax.swing.JFrame | +--com.borland.primetime.ide.Browser
This is the Browser window, which is the center of all JBuilder UI. The Browser window consists of several different interacting parts:
ProjectView
,
ContentManager
,
StructureView
,
MessageView
,
StatusView
, Serialized FormInner Class Summary | |
protected class |
Browser.UpdateTimer
This class provides a timer which is used to trigger the update() method of ActionButton instances which have registered with this class. |
Inner classes inherited from class javax.swing.JFrame |
javax.swing.JFrame.AccessibleJFrame |
Inner classes inherited from class java.awt.Frame |
java.awt.Frame.AccessibleAWTFrame |
Inner classes inherited from class java.awt.Window |
java.awt.Window.AccessibleAWTWindow |
Inner classes inherited from class java.awt.Container |
java.awt.Container.AccessibleAWTContainer |
Inner classes inherited from class java.awt.Component |
java.awt.Component.AccessibleAWTComponent |
Field Summary | |
static UpdateAction |
ACTION_BrowserCascadeAll
Deprecated. |
static BrowserAction |
ACTION_BrowserExit
Deprecated. |
static BrowserAction |
ACTION_BrowserIconify
Deprecated. |
static UpdateAction |
ACTION_BrowserMinimizeAll
Deprecated. |
static UpdateAction |
ACTION_BrowserNew
Deprecated. |
static UpdateAction |
ACTION_BrowserRestoreAll
Deprecated. |
static BrowserAction |
ACTION_BrowserShow
Deprecated. |
static UpdateAction |
ACTION_BrowserTileAll
Deprecated. |
static BrowserAction |
ACTION_EditDefaultProjectProperties
Deprecated. |
static BrowserAction |
ACTION_EditProjectProperties
Deprecated. |
static BrowserAction |
ACTION_FileOpen
Deprecated. |
static BrowserAction |
ACTION_NavigateBack
Deprecated. |
static BrowserAction |
ACTION_NavigateForward
Deprecated. |
static BrowserAction |
ACTION_NewFolder
Deprecated. |
static BrowserAction |
ACTION_NextOpenNode
Deprecated. |
static BrowserAction |
ACTION_NodeClose
Deprecated. |
static BrowserAction |
ACTION_NodeCloseAll
Deprecated. |
static BrowserAction |
ACTION_NodeRename
Deprecated. |
static BrowserAction |
ACTION_NodeRevert
Deprecated. |
static BrowserAction |
ACTION_NodeSave
Deprecated. |
static BrowserAction |
ACTION_NodeSaveAll
Deprecated. |
static BrowserAction |
ACTION_NodeSaveAs
Deprecated. |
static BrowserAction |
ACTION_PageLayout
Deprecated. |
static BrowserAction |
ACTION_PreviousOpenNode
Deprecated. |
static DelegateAction |
ACTION_Print
Deprecated. |
static BrowserAction |
ACTION_ProjectFileOpen
Deprecated. |
static BrowserAction |
ACTION_ProjectNodeRename
Deprecated. |
static BrowserAction |
ACTION_ProjectSave
Deprecated. |
static BrowserAction |
ACTION_ProjectSaveAs
Deprecated. |
static BrowserAction |
ACTION_ToggleCurtain
Deprecated. |
static BrowserAction |
ACTION_ToolBarHideAll
Deprecated. |
static BrowserAction |
ACTION_ToolBarShowAll
Deprecated. |
static DelegateAction |
DELEGATE_ContextMenu
Action which delegates a Context Menu request to the component with the focus. |
static DelegateAction |
DELEGATE_Copy
Action which delegates a Copy request to the component with the focus. |
static DelegateAction |
DELEGATE_Cut
Action which delegates a Cut Request to the component with the focus. |
static DelegateAction |
DELEGATE_Delete
Action which delegates a Delete request to the component with the focus. |
static DelegateAction |
DELEGATE_Paste
Action which delegates a Paste request to the component with the focus. |
static DelegateAction |
DELEGATE_Redo
Action which delegates a Redo request to the component with the focus. |
static DelegateAction |
DELEGATE_Refresh
Action which delegates a Refresh request to the component with the focus. |
static DelegateAction |
DELEGATE_SearchAgain
Action which delegates a Search Again request to the component with the focus. |
static DelegateAction |
DELEGATE_SearchFind
Action which delegates a Find Text request to the component with the focus. |
static DelegateAction |
DELEGATE_SearchIncremental
Action which delegates an Incremental Search request to the component with the focus. |
static DelegateAction |
DELEGATE_SearchReplace
Action which delegates a Search & Replace request to the component with the focus. |
static DelegateAction |
DELEGATE_SelectAll
Action which delegates a Select All request to the component with the focus. |
static DelegateAction |
DELEGATE_Undo
Action which delegates an Undo request to the component with the focus. |
static ActionGroup |
GROUP_NavigateTo
Deprecated. |
static ActionGroup |
GROUP_OpenBrowsers
Deprecated. |
static ActionGroup |
GROUP_OpenWindows
Deprecated. |
static ActionGroup |
GROUP_Reopen
Deprecated. |
static ActionGroup |
GROUP_ToolBars
Deprecated. |
static BrowserStateAction |
STATE_ContentPaneVisible
The state 'ContentPaneVisible' controls the visible state of this Browser's ContentManager. |
static BrowserStateAction |
STATE_MessagePaneVisible
Deprecated. |
static BrowserStateAction |
STATE_ProjectPaneVisible
The state 'ProjectPaneVisible' controls the visible state of this Browser's ProjectView. |
static BrowserStateAction |
STATE_StatusPaneVisible
The state 'StatusPaneVisible' controls the visible state of this Browser's StatusView. |
static BrowserStateAction |
STATE_StructurePaneVisible
The state 'StructurePaneVisible' controls the visible state of this Browser's StructureView. |
static BrowserStateAction |
STATE_ToolBarPaneVisible
The state 'ToolBarVisible' controls the visible state of this Browser's main toolbar. |
protected Browser.UpdateTimer |
updateTimer
Timer for ActionButtons that have registered to be notified twice a second. |
Fields inherited from class javax.swing.JFrame |
accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled |
Fields inherited from class java.awt.Frame |
CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR |
Fields inherited from class java.awt.Component |
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT |
Fields inherited from interface javax.swing.WindowConstants |
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE |
Fields inherited from interface java.awt.image.ImageObserver |
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
Constructor Summary | |
Browser()
Constructs a new Browser window and re-opens previously open projects if the first instance. |
Method Summary | |
void |
addBrowserListener(BrowserListener l)
Adds a BrowserListener to listen to Browser events from this Browser. |
void |
addButton(ActionButton button)
Adds the given button to the update timer list. |
static void |
addMenuGroup(ActionGroup group)
Adds an ActionGroup to the end of the static list of ActionGroups that will appear in all subsequently created Browser window menus. |
static void |
addMenuGroup(int index,
ActionGroup group)
Inserts an ActionGroup into the static list of ActionGroups at the specified index. |
static void |
addStaticBrowserListener(BrowserListener l)
Adds a BrowserListener to listen to Browser events from *ALL* existing Browsers. |
static void |
addToolBarGroup(ActionGroup group)
Adds an ActionGroup to the end of the static list of ActionGroups that will appear in all subsequently created Browser window toolbars. |
static void |
addToolBarGroup(int index,
ActionGroup group)
Inserts an ActionGroup into the static list of toolbar ActionGroups at the specified index. |
static boolean |
canDisplayNode(Node node)
Returns the count of NodeViewers that have 'accepted' the specified Node, and are available to display the contents of the Node in the ContentView. |
boolean |
canNavigateBack()
Returns true if the navigation stack pointer is not at the beginning of the navigation stack. |
boolean |
canNavigateForward()
Returns true if there are items in the navigation stack beyond the current item. |
static java.io.File |
checkExtension(UrlNode urlNode,
java.io.File file)
Checks the node type extension against the selected file. |
boolean |
checkOverwrite(java.lang.String fileName)
Checks if the user wishes to overwrite the specified file. |
Url |
chooseProjectFile()
This routine uses a JFileChooser to select a project. |
void |
clearWaitMessages()
Hides the message window, and kills any delayed messages that may still be in the queue. |
void |
close()
Closes this Browser window after saves any modified files. |
void |
closeNode(Node node)
Closes the specified Node and removes it from this Browser's ContentManager. |
void |
closeNodes(Node[] nodes,
int nOpen)
Closes the specified list of Nodes and removes them from this Browser's ContentManager. |
void |
closeProject(Project project)
This routine closes the given project. |
void |
delayWaitMessage(int delay,
java.lang.String title,
java.lang.String text)
Displays an information window centered on the screen with the specified title and text messages - after the specified delay (ms) has passed. |
void |
doOpen(java.io.File openedFile,
boolean add2Proj)
Deprecated. |
void |
doOpen(Url url,
Project project,
boolean add2Proj)
This routine opens the given file and may optionally add it to the 'active' project. |
void |
doRename(Node node)
Checks the specified node to see if it is an instance of UrlNode or a LightweightNode, and calls doRenameUrlNode(UrlNode) or doRenameLightweightNode(LightweightNode) respectively. |
void |
doRenameLightweightNode(LightweightNode liteNode)
Renames the specified LightweightNode to a user specified name. |
void |
doRenameUrlNode(UrlNode urlNode)
Renames the specified UrlNode to a user specified name. |
void |
doRevert(Node[] nodes)
Scans the array of nodes and calls doRevert(UrlNode) on all UrlNode instances in the array. |
void |
doRevert(UrlNode urlNode)
Reverts the specified UrlNode. |
void |
doSave(Node[] nodes)
Scans and attempts to save each of the UrlNode instances in the passed array. |
void |
doSave(UrlNode urlNode)
Saves the specified UrlNode - or if it is a new node, doSaveAs(UrlNode) is called passing the specified node. |
void |
doSaveAll(boolean checked)
Scans JBuilder environment of opened projects for modified file buffers and/or projects then optionally (if checked flag is true) presents a list to select which ones to save. |
void |
doSaveAll(Project[] projs,
boolean checked)
Scans given array of projects for those with modified file buffers and/or projects then optionally (if checked flag is true) presents a list to select which ones to save. |
void |
doSaveAs(UrlNode urlNode)
Saves the specifed UrlNode as specified by the user. |
void |
doSaveChecked(Node[] nodes)
Presents the specified list of nodes in a save dialog for the user to select which ones they want to save. |
void |
doSaveChecked(UrlNode urlNode)
Queries the user if they want to save the specified UrlNode. |
static Browser |
findBrowser(java.lang.Object source)
Walks up the containership hierarchy to try to find a Browser instance from the passed Object (if the passed Object is a Component). |
protected void |
fireBrowserActivated()
The 'browserActivated' event is fired each time the Browser window is activated - by switching to this Browser from another Browser, or by switching to this Browser from another application. |
protected void |
fireBrowserClosed()
The 'browserClosed' event is fired when a Browser is finally closed. |
protected void |
fireBrowserClosing()
The 'browserClosing' event is fired when the Browser is attempting to close. |
protected void |
fireBrowserDeactivated()
The 'browserDeactivated' event is fired each time the Browser window is deactivated - by switching to another Browser, or by switching to another application. |
protected void |
fireBrowserNodeActivated(Node node)
The 'browserNodeActivated' event is fired when the 'active' Node in the Browser has changed - ie. |
protected void |
fireBrowserNodeClosed(Node node)
The 'browserNodeClosed' event is fired when a Node in the Browser is closed. |
protected void |
fireBrowserOpened()
The 'browserOpened' event is fired when a Browser is opened for the first time. |
protected void |
fireBrowserProjectActivated(Project project)
The 'browserProjectActivated' event is fired when the 'active' Project in the Browser has changed - ie. |
protected void |
fireBrowserProjectClosed(Project project)
The 'browserProjectClosed' event is fired when a Project in the Browser is closed. |
protected void |
fireBrowserViewerActivated(Node node,
NodeViewer viewer)
The 'browserViewerActivated' event is fired when the 'active' Node in the Browser's 'active' NodeViewer has changed - ie. |
protected void |
fireBrowserViewerDeactivating(Node node,
NodeViewer viewer)
The 'browserViewerDeactivating' event is fired when the active Node's viewer is changing - ie. |
static Browser |
getActiveBrowser()
Returns the active (most recently activated) Browser in this JBuilder session. |
Node |
getActiveNode()
Returns the active Node in this Browser. |
Project |
getActiveProject()
Returns the current 'active' project for this Browser. |
Project |
getActiveUserProject()
Returns the current 'active' project for this Browser if it is not the default project. |
NodeViewer |
getActiveViewer(Node node)
Returns the active NodeViewer for the specified Node in this Browser. |
static Node[] |
getAllOpenNodes()
Returns all the open Nodes in all Browsers. |
static Node[] |
getAllOpenNodes(Project project)
Returns all the open Nodes for a given project in all Browsers. |
static int |
getBrowserCount()
Returns the count of Browsers in this JBuilder session. |
static Browser[] |
getBrowsers()
Returns a Browser array in the correct Z order (order of activation), with the most recently active Browser first. |
static Browser[] |
getBrowsersNonZ()
Returns a Browser array in the non-Z order (order of creation), with the most recently created Browser last. |
static java.lang.String |
getBrowserTitle()
Returns the browser title. |
ContentManager |
getContentManager()
Returns this Browser's ContentManager instance. |
static Project |
getDefaultProject()
Returns the Default project. |
static Url |
getDefaultProjectUrl()
Returns a Url pointing to the Default project. |
static java.lang.String |
getIDELookAndFeelClassName()
Returns the class name of the IDE's active LookAndFeel. |
static java.io.File |
getLastDirectory()
Used to determine default directory for all open dialogs. |
Url |
getLastOpenedUrl()
Returns the last opened url address. |
static ActionGroup |
getMenuGroup(int index)
Returns the menu ActionGroup at the specied index. |
static int |
getMenuGroupCount()
Returns the static count of ActionGroups that appear in all Browser menus. |
static ActionGroup[] |
getMenuGroups()
Returns the static list of ActionGroups that appear in all Browser menus. |
MessageView |
getMessageView()
Returns this Browser's MessageView instance. |
Node[] |
getNavigationHistory()
Returns a copy of the current navigation history. |
Node |
getNavigationHistory(int index)
Returns the value at the given index into the navigation history. |
int |
getNavigationHistoryCount()
Gets the current number of entries in the navigation history. |
int |
getNavigationIndex()
Returns the current index into the navigation history returned by the getNavigationHistory() method. |
int |
getOpenNodeCount()
Returns the count of open Nodes in this Browser. |
Node[] |
getOpenNodes()
Returns the open Nodes in this Browser regardless of this project to which they belong. |
Node[] |
getOpenNodes(Project project)
Returns the open Nodes in this Browser for the given project. |
ProjectView |
getProjectView()
Returns this Browser's ProjectView instance. |
StatusView |
getStatusView()
Returns this Browser's StatusView instance. |
StructureView |
getStructureView()
Returns this Browser's StructureView instance. |
static ActionGroup |
getToolBarGroup(int index)
Returns the toolbar ActionGroup at the specied index. |
static int |
getToolBarGroupCount()
Returns the count of static Browser toolbars. |
static ActionGroup[] |
getToolBarGroups()
Returns the static list of ActionGroups that appear in all Browser toolbars. |
BrowserToolBarPane |
getToolBarPane()
Returns this browser's BrowserToolBarPane instance. |
int |
getViewerCount(Node node)
Returns the count of NodeViewers that have 'accepted' the specified Node, and are available to display the contents of the Node in the ContentView. |
NodeViewer |
getViewerOfType(Node node,
java.lang.Class clazz)
Returns the first NodeViewer instance of the specified type that have is displaying the specified Node. |
NodeViewer[] |
getViewers(Node node)
Returns the NodeViewers that have 'accepted' the specified Node, and are available to display the contents of the Node in the ContentView. |
boolean |
isConstructing()
Returns whether this Browser has completed construction and re-opening of its previously open projects. |
boolean |
isContentPaneVisible()
Returns this browser's content pane's visible state. |
boolean |
isMessagePaneVisible()
Returns this browser's message pane's visible state. |
boolean |
isOpenNode(Node node)
Returns true if the passed node is currently being displayed in this Browser. |
boolean |
isOpenNode(Project project)
Returns true if the passed project currently as a node being displayed in this Browser. |
boolean |
isProjectPaneVisible()
Returns this browser's project pane's visible state. |
boolean |
isStatusPaneVisible()
Returns this browser's status pane's visible state. |
boolean |
isStructurePaneVisible()
Returns this browser's structure pane's visible state. |
boolean |
isToolBarPaneVisible()
Returns this browser toolbar pane's visible state. |
void |
navigateBack()
Moves the active node to the previous node in the navigation stack (if the navigation stack pointer is not at the beginning). |
void |
navigateForward()
Moves the active node to the next node in the navigation stack (if the navigation stack pointer is not at the end). |
void |
navigateHome()
Moves the active node to the first node in the navigation stack (if the navigation stack pointer is not at the beginning). |
void |
navigateTo(int index)
Activates the node at the given index into the navigation history. |
void |
navigateTo(Node node)
Effectively a 'drill-in'. |
void |
nextOpenNode(boolean requestFocus)
Sets the next node as the active node in this Browser window. |
void |
openFile(boolean add2Proj)
This routine uses a JFileChooser to select a file to be opened and made the 'active' node. |
void |
openNodes(Node[] list,
Node n)
This routine opens all the nodes in the given array. |
void |
openProjectFile()
This routine uses a JFileChooser to select a project which will then be opened and made the 'active' project. |
void |
previousOpenNode(boolean requestFocus)
Sets the previous node as the active node in this Browser window. |
static void |
registerNodeViewerFactory(NodeViewerFactory factory)
Registers a NodeViewerFactory class for displaying Node contents. |
static void |
registerNodeViewerFactory(NodeViewerFactory factory,
boolean asFirst)
Registers a NodeViewerFactory class for displaying Node contents. |
void |
removeBrowserListener(BrowserListener l)
Removes a BrowserListener from this Browser. |
void |
removeButton(ActionButton button)
Removes the given button from the update timer list. |
static void |
removeMenuGroup(ActionGroup group)
Removes an ActionGroup from the static list of ActionGroups that appear in all subsequently created Browser window menus. |
static void |
removeStaticBrowserListener(BrowserListener l)
Removes a BrowserListener from the static listener list. |
static void |
removeToolBarGroup(ActionGroup group)
Removes an ActionGroup from the static list of ActionGroups that appear in all subsequently created Browser window toolbars. |
void |
setActiveNode(Node node,
boolean requestFocus)
Sets the 'active' open Node in this Browser. |
void |
setActiveProject(Project project)
This routine makes the given project the 'active' project for this Browser instance. |
void |
setActiveViewer(Node node,
NodeViewer viewer,
boolean requestFocus)
Sets the active NodeViewer for the specified Node. |
void |
setBounds(java.awt.Rectangle b)
|
static void |
setBrowserTitle(java.lang.String title)
Sets the browser title. |
void |
setContentPaneVisible(boolean visible)
Hides/shows this browser's content pane. |
static void |
setDefaultProjectUrl(Url url)
Sets the default project's url. |
static void |
setIDELookAndFeelClassName(java.lang.String className)
Sets the LookAndFeel for the whole JBuilder IDE (Browsers and all other addins). |
static void |
setLastDirectory(java.io.File file)
Sets the last visited directory. |
void |
setLastOpenedUrl(Url url)
Sets the last opened url address. |
void |
setMessagePaneVisible(boolean visible)
Hides/shows this browser's message pane. |
void |
setProjectPaneVisible(boolean visible)
Hides/shows this browser's project pane. |
void |
setStatusPaneVisible(boolean visible)
Hides/shows this browser's status pane. |
void |
setStructurePaneVisible(boolean visible)
Hides/shows this browser's structure pane. |
void |
setToolBarPaneVisible(boolean visible)
Hides/shows this browser's toolbar pane. |
void |
showIllegalFileNameWarning(java.lang.String fileName)
Alerts the user that the passed filename is invalid. |
void |
toggleCurtain()
Toggles the project/structure left pane visible/invisible. |
void |
updateViewers(Node node)
Updates the viewers registered with a node so that they hide or reveal themselves. |
void |
waitMessage(java.lang.String title,
java.lang.String text)
Displays an information window centered on the screen with the specified title and text messages. |
Methods inherited from class javax.swing.JFrame |
addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isRootPaneCheckingEnabled, paramString, processKeyEvent, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update |
Methods inherited from class java.awt.Frame |
addNotify, finalize, getCursorType, getFrames, getIconImage, getMenuBar, getState, getTitle, isResizable, remove, removeNotify, setCursor, setIconImage, setMenuBar, setResizable, setState, setTitle |
Methods inherited from class java.awt.Window |
addWindowListener, applyResourceBundle, applyResourceBundle, dispose, getFocusOwner, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getOwnedWindows, getOwner, getToolkit, getWarningString, hide, isShowing, pack, postEvent, processEvent, removeWindowListener, setCursor, show, toBack, toFront |
Methods inherited from class java.awt.Container |
add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setFont, validate, validateTree |
Methods inherited from class java.awt.Component |
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getInputMethodRequests, getLocation, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isDisplayable, isDoubleBuffered, isEnabled, isFocusTraversable, isLightweight, isOpaque, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseMotionEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBackground, setBounds, setComponentOrientation, setDropTarget, setEnabled, setForeground, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus |
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface java.awt.MenuContainer |
getFont, postEvent |
Field Detail |
protected Browser.UpdateTimer updateTimer
public static BrowserStateAction STATE_ToolBarPaneVisible
public static BrowserStateAction STATE_ProjectPaneVisible
The state 'ProjectPaneVisible' controls the visible state of this Browser's ProjectView. If the state is true, the ProjectView is visible. If the state is false, the ProjectView is invisible.
public static BrowserStateAction STATE_ContentPaneVisible
The state 'ContentPaneVisible' controls the visible state of this Browser's ContentManager. If the state is true, the ContentManager is visible. If the state is false, the ContentPane is invisible.
public static BrowserStateAction STATE_StructurePaneVisible
The state 'StructurePaneVisible' controls the visible state of this Browser's StructureView. If the state is true, the StructureView is visible. If the state is false, the StructureView is invisible.
public static BrowserStateAction STATE_StatusPaneVisible
public static DelegateAction DELEGATE_Undo
public static DelegateAction DELEGATE_Redo
public static DelegateAction DELEGATE_Cut
public static DelegateAction DELEGATE_Copy
public static DelegateAction DELEGATE_Paste
public static DelegateAction DELEGATE_Delete
public static DelegateAction DELEGATE_SelectAll
public static DelegateAction DELEGATE_SearchFind
public static DelegateAction DELEGATE_SearchReplace
public static DelegateAction DELEGATE_SearchAgain
public static DelegateAction DELEGATE_SearchIncremental
public static DelegateAction DELEGATE_ContextMenu
public static DelegateAction DELEGATE_Refresh
public static BrowserAction ACTION_NavigateBack
BrowserNavigate.ACTION_NavigateBack
public static BrowserAction ACTION_NavigateForward
BrowserNavigate.ACTION_NavigateForward
public static ActionGroup GROUP_NavigateTo
BrowserNavigate.GROUP_NavigateTo
public static BrowserAction ACTION_NextOpenNode
BrowserNavigate.ACTION_NextOpenNode
public static BrowserAction ACTION_PreviousOpenNode
BrowserNavigate.ACTION_PreviousOpenNode
public static BrowserAction ACTION_NewFolder
ProjectView.ACTION_NewFolder
public static BrowserAction ACTION_FileOpen
BrowserFile.ACTION_FileOpen
public static BrowserAction ACTION_ProjectFileOpen
BrowserFile.ACTION_ProjectFileOpen
public static BrowserAction ACTION_NodeSave
BrowserFile.ACTION_NodeSave
public static BrowserAction ACTION_NodeSaveAs
BrowserFile.ACTION_NodeSaveAs
public static BrowserAction ACTION_NodeRename
BrowserFile.ACTION_NodeRename
public static DelegateAction ACTION_Print
com.borland.primetime.ide.BrowserFile#ACTION_Print
public static BrowserAction ACTION_PageLayout
BrowserFile.ACTION_PageLayout
public static BrowserAction ACTION_ProjectNodeRename
ProjectView.ACTION_ProjectNodeRename
public static BrowserAction ACTION_NodeSaveAll
BrowserFile.ACTION_NodeSaveAll
public static BrowserAction ACTION_ProjectSave
BrowserFile.ACTION_ProjectSave
public static BrowserAction ACTION_ProjectSaveAs
BrowserFile.ACTION_ProjectSaveAs
public static BrowserAction ACTION_NodeClose
BrowserFile.ACTION_NodeClose
public static BrowserAction ACTION_NodeCloseAll
BrowserFile.ACTION_NodeCloseAll
public static BrowserAction ACTION_NodeRevert
com.borland.primetime.ide.BrowserFile#ACTION_NodeRever
public static final ActionGroup GROUP_Reopen
BrowserFile.GROUP_Reopen
public static BrowserAction ACTION_EditProjectProperties
BrowserFile.ACTION_EditProjectProperties
public static BrowserAction ACTION_EditDefaultProjectProperties
BrowserFile.ACTION_EditDefaultProjectProperties
public static UpdateAction ACTION_BrowserNew
BrowserWindow.ACTION_BrowserNew
public static UpdateAction ACTION_BrowserMinimizeAll
BrowserWindow.ACTION_BrowserMinimizeAll
public static UpdateAction ACTION_BrowserRestoreAll
BrowserWindow.ACTION_BrowserRestoreAll
public static UpdateAction ACTION_BrowserCascadeAll
BrowserWindow.ACTION_BrowserCascadeAll
public static UpdateAction ACTION_BrowserTileAll
BrowserWindow.ACTION_BrowserTileAll
public static BrowserAction ACTION_BrowserShow
BrowserWindow.ACTION_BrowserShow
public static BrowserAction ACTION_BrowserIconify
BrowserWindow.ACTION_BrowserIconify
public static BrowserAction ACTION_BrowserExit
BrowserWindow.ACTION_BrowserExit
public static ActionGroup GROUP_OpenWindows
BrowserWindow.GROUP_OpenWindows
public static ActionGroup GROUP_OpenBrowsers
BrowserWindow.GROUP_OpenBrowsers
public static BrowserAction ACTION_ToggleCurtain
BrowserView.ACTION_ToggleCurtain
public static BrowserStateAction STATE_MessagePaneVisible
BrowserView.STATE_MessagePaneVisible
public static BrowserAction ACTION_ToolBarShowAll
BrowserView.ACTION_ToolBarShowAll
public static BrowserAction ACTION_ToolBarHideAll
BrowserView.ACTION_ToolBarHideAll
public static ActionGroup GROUP_ToolBars
BrowserView.GROUP_ToolBars
Constructor Detail |
public Browser()
Method Detail |
public static int getBrowserCount()
public static Browser[] getBrowsers()
public static Browser[] getBrowsersNonZ()
public static Browser getActiveBrowser()
Returns the active (most recently activated) Browser in this JBuilder session.
Typically, if a sub-system requires a Browser, it will have been initialized with access to the specific Browser, and should use that instance rather than calling this method.
public static void registerNodeViewerFactory(NodeViewerFactory factory)
Registers a NodeViewerFactory class for displaying Node contents. This NodeViewerFactory will be added to the end of the cannonical listing of all NodeViewerFactories - thus will display as the last tab (as of yet).
factory
- The NodeViewerFactory to register.public static void registerNodeViewerFactory(NodeViewerFactory factory, boolean asFirst)
Registers a NodeViewerFactory class for displaying Node contents. If the 'asFirst' paramter is set to true, this NodeViewerFactory will be inserted at the beginning of the cannonical listing of all NodeViewerFactories - thus will display as the first tab (as of yet). If the 'asFirst' parameter is false, the NodeViewerFactory will be added to the end of the list.
factory
- The NodeViewerFactory to register.asFirst
- True if the NodeViewerFactory is to be put at the beginning
of the cannonical listing, false if at the end.public static Browser findBrowser(java.lang.Object source)
source
- The Object source to try to find an associated Browser
instance for. This is typically an event object's source:
as in e.getSource().public static void setBrowserTitle(java.lang.String title)
title
- The browser titlepublic static java.lang.String getBrowserTitle()
public static void setDefaultProjectUrl(Url url)
url
- The new default project urlpublic static Url getDefaultProjectUrl()
public static Project getDefaultProject()
public static void setIDELookAndFeelClassName(java.lang.String className)
className
- A String representing the class name of the LookAndFeel
For example, "javax.swing.plaf.motif.MotifLookAndFeel"public static java.lang.String getIDELookAndFeelClassName()
public Url getLastOpenedUrl()
public void setLastOpenedUrl(Url url)
The
- new last opened Url.public static java.io.File getLastDirectory()
public static void setLastDirectory(java.io.File file)
file
- The new value for the last directory navigated.public Url chooseProjectFile()
public void openProjectFile()
public void openFile(boolean add2Proj)
add2Proj
- True if the opened file is also to be added to Project.public void doOpen(java.io.File openedFile, boolean add2Proj)
openedFile
- The file to be opened, may be a project.add2Proj
- True if the opened file is also to be added to Project.public void doOpen(Url url, Project project, boolean add2Proj)
openedFile
- The file to be opened, may be a project.project
- Project to own the file or null to use default project.add2Proj
- True if the opened file is also to be added to Project.public void setToolBarPaneVisible(boolean visible)
visible
- true for visible, false for invisiblepublic boolean isToolBarPaneVisible()
public void setProjectPaneVisible(boolean visible)
visible
- true for visible, false for invisiblepublic boolean isProjectPaneVisible()
public void setContentPaneVisible(boolean visible)
visible
- true for visible, false for invisiblepublic boolean isContentPaneVisible()
public void setStructurePaneVisible(boolean visible)
visible
- true for visible, false for invisiblepublic boolean isStructurePaneVisible()
public void toggleCurtain()
public void setMessagePaneVisible(boolean visible)
visible
- true for visible, false for invisiblepublic boolean isMessagePaneVisible()
public void setStatusPaneVisible(boolean visible)
visible
- true for visible, false for invisiblepublic boolean isStatusPaneVisible()
public int getNavigationHistoryCount()
public int getNavigationIndex()
public Node getNavigationHistory(int index)
index
- An index into the navigation history.public Node[] getNavigationHistory()
public void navigateTo(int index) throws java.lang.Exception
index
- Index into the navigation historypublic void navigateTo(Node node) throws java.lang.Exception
node
- The node to navigate to (push onto the history stack)Several
- exceptions can be thrown if there is a problem moving to
the specified nodepublic boolean canNavigateForward()
public void navigateForward() throws java.lang.Exception
Several
- exceptions can be thrown if there is a problem moving to
the specified nodepublic boolean canNavigateBack()
public void navigateBack() throws java.lang.Exception
Several
- exceptions can be thrown if there is a problem moving to
the specified nodepublic void navigateHome() throws java.lang.Exception
Several
- exceptions can be thrown if there is a problem moving to
the specified nodepublic static int getMenuGroupCount()
public static ActionGroup getMenuGroup(int index)
index
- The index of the desired menu grouppublic static ActionGroup[] getMenuGroups()
public static void addMenuGroup(ActionGroup group)
group
- The ActionGroup to add to the static list of menus.public static void addMenuGroup(int index, ActionGroup group)
group
- The ActionGroup to insert into the static list of menus.public static void removeMenuGroup(ActionGroup group)
group
- The ActionGroup to remove from the static list of menus.public BrowserToolBarPane getToolBarPane()
public static int getToolBarGroupCount()
public static ActionGroup getToolBarGroup(int index)
index
- The index of the desired toolbar grouppublic static ActionGroup[] getToolBarGroups()
public static void addToolBarGroup(ActionGroup group)
group
- The ActionGroup to add to the static list of toolbars.public static void addToolBarGroup(int index, ActionGroup group)
group
- The ActionGroup to insert into the static list of toolbars.public static void removeToolBarGroup(ActionGroup group)
group
- The ActionGroup to remove from the static list of toolbars.public void waitMessage(java.lang.String title, java.lang.String text)
title
- The title to display in the mesage windowtext
- The message text to display in the message windowpublic void delayWaitMessage(int delay, java.lang.String title, java.lang.String text)
delay
- The time (ms) to wait before displaying the message windowtitle
- The title to display in the mesage windowtext
- The message text to display in the message windowpublic void clearWaitMessages()
public ProjectView getProjectView()
public void setActiveProject(Project project) throws java.lang.Exception
project
- The project to be made 'active'.public Project getActiveProject()
public Project getActiveUserProject()
public void closeProject(Project project) throws java.lang.Exception
project
- The project to be closed.java.lang.Exception
- A myriad of different exceptions can be thrown when
closing a Project, including VetoException (if a BrowserListener
doesn't want the Project, Node, or the viewer to change, or if a
NodeViewer doesn't want the viewer to change). Any number of
IOExceptions or Node exceptions can be thrown during the Node
save/close process.public int getOpenNodeCount()
public Node[] getOpenNodes()
public Node[] getOpenNodes(Project project)
public static Node[] getAllOpenNodes()
public static Node[] getAllOpenNodes(Project project)
project
- The project whose open Nodes are to be found.public boolean isOpenNode(Node node)
node
- The Node to checkpublic boolean isOpenNode(Project project)
node
- The Project to checkpublic void setActiveNode(Node node, boolean requestFocus) throws java.lang.Exception
Sets the 'active' open Node in this Browser. If the passed Node already exists in the set of opened Nodes, it will be activated as the active open node. If the passed Node is not in the opened list, it will be opened, activated, and added to the list.
Note that if the passed Node is not already the active Node in this Browser, calling this method will trigger several Browser events:
node
- The Node to set as the active Node in this Browser.java.lang.Exception
- A myriad of different exceptions can be thrown when
setting the active Node, including VetoException (if a
BrowserListener doesn't want the Node or the viewer to change, or
if a NodeViewer doesn't want the viewer to change). Any
number of IOExceptions or Node exceptions can be thrown if the Node
is being opened for the first time.public void openNodes(Node[] list, Node n) throws java.lang.Exception
list
- The Nodes to be opened.n
- The Node in 'list' to be activated.java.lang.Exception
- A myriad of different exceptions can be thrown when
setting the active Node, including VetoException (if a
BrowserListener doesn't want the Node or the viewer to change, or
if a NodeViewer doesn't want the viewer to change). Any
number of IOExceptions or Node exceptions can be thrown if the Node
is being opened for the first time.public Node getActiveNode()
public void closeNode(Node node) throws java.lang.Exception
Closes the specified Node and removes it from this Browser's ContentManager.
This method will check if the Node has been modified. If it has, the user will be prompted to save changes. The user will be given the option to save, not save (revert), or cancel. Choosing save will save the changes to the Node before closing. Choosing not to save will revert the Node before closing (this is important if the Node's Buffer is being displayed in another Node - in this Browser or perhaps another). Choosing cancel will stop the whole process and the Node will not save, revert, or close.
Note that if the passed Node is the active Node in this ContentManager, calling this method will trigger several Browser events:
node
- The Node to close and remove from this Browser's ContentManager.java.lang.Exception
- A myriad of different exceptions can be thrown when
closing a Node, including VetoException (if a BrowserListener
doesn't want the active Node or the viewer to change, or if a
NodeViewer doesn't want the viewer to change). Any
number of IOExceptions or Node exceptions can be thrown if the Node
is modified, and there are troubles saving it.public void closeNodes(Node[] nodes, int nOpen) throws java.lang.Exception
Closes the specified list of Nodes and removes them from this Browser's ContentManager.
This method will check if the Nodes have been modified. The user will be prompted to save changes to modified nodes in a grouped dialog. The user will be given the option to save or not save (revert) each node, or to cancel the close operation. Selecting save for each node will save the changes to the Node before closing. Choosing not to save will revert the Node before closing (this is important if the Node's Buffer is being displayed in another Node - in this Browser or perhaps another). Choosing cancel will stop the whole process and none of the Nodes will be saved, reverted, or closed.
Note that if one of the passed Nodes is the active Node in this ContentManager, calling this method will trigger several Browser events:
nodes
- The array of Nodes to close and remove from this Browser's
ContentManager.java.lang.Exception
- A myriad of different exceptions can be thrown when
closing a Node, including VetoException (if a BrowserListener
doesn't want the active Node or the viewer to change, or if a
NodeViewer doesn't want the viewer to change). Any
number of IOExceptions or Node exceptions can be thrown if the Node
is modified, and there are troubles saving it.public void nextOpenNode(boolean requestFocus) throws java.lang.Exception
requestFocus
- True to set focus on the next node, false to move
without changing focuspublic void previousOpenNode(boolean requestFocus) throws java.lang.Exception
requestFocus
- True to set focus on the privious node, false to move
without changing focuspublic void doSaveAll(boolean checked) throws VetoException
checked
- If true, a dialog will be presented to the user to select
which files are to be saved.VetoException
- If the user selects Cancel or if there is a problem
while savingpublic void doSaveAll(Project[] projs, boolean checked) throws VetoException
checked
- If true, a dialog will be presented to the user to select
which files are to be saved.VetoException
- If the user selects Cancel or if there is a problem
while savingpublic void doSaveChecked(Node[] nodes) throws VetoException
nodes
- An array of Nodes to present to the userVetoException
- if the user clicks the Cancel button on the save
dialogpublic void doSave(Node[] nodes) throws VetoException
nodes
- An array of nodes to attempt to saveVetoException
- if the user clicks on cancel in any of the many
possible resulting dialogspublic void doSaveChecked(UrlNode urlNode) throws java.lang.Exception
urlNode
- The node to save or revert as the user specifiesjava.lang.Exception
- See doSave(UrlNode) to see the exception typespublic void doSave(UrlNode urlNode) throws java.lang.Exception
urlNode
- The node to saveAny
- of several exceptions if the save process failspublic void doSaveAs(UrlNode urlNode) throws java.lang.Exception
urlNode
- The node to save asjava.lang.Exception
- Several exceptions can be thrown by the saveAs operationpublic void doRevert(Node[] nodes)
nodes
- The array of nodes to revertpublic void doRevert(UrlNode urlNode) throws java.lang.Exception
urlNode
- The node to revertjava.lang.Exception
- Several exceptions can be thrown by attempting to revert
a nodepublic void doRename(Node node) throws java.lang.Exception
node
- The node to renamejava.lang.Exception
- the rename process can throw several exceptionspublic void doRenameUrlNode(UrlNode urlNode) throws java.lang.Exception
urlNode
- The node to renameException
- several exceptions can be thrown when renaming a nodepublic void doRenameLightweightNode(LightweightNode liteNode)
liteNode
- The node to renamepublic static java.io.File checkExtension(UrlNode urlNode, java.io.File file)
urlNode
- The Node with the file extension to be checked.file
- The File object for a file with an extension.public boolean checkOverwrite(java.lang.String fileName) throws VetoException
fileName
- The name of the file to be displayed.public void showIllegalFileNameWarning(java.lang.String fileName)
fileName
- The name of the file to be displayed.public static boolean canDisplayNode(Node node)
Returns the count of NodeViewers that have 'accepted' the specified Node, and are available to display the contents of the Node in the ContentView. This is the number of tabs showing along the bottom of the ContentView for the specified Node.
NOTE: If the passed Node is in the ContentManager's opened list, zero is silently returned. Be sure the Node in question is actually opened before checking the number of Viewers it has.
node
- The Node to get the count of NodeViewers for.public NodeViewer getViewerOfType(Node node, java.lang.Class clazz)
Returns the first NodeViewer instance of the specified type that have is displaying the specified Node. This is one of the tabs showing along the bottom of the ContentView for the specified Node.
NOTE: If the passed Node is in the ContentManager's opened list, null is returned. Be sure the Node in question is actually opened before retrieving a NodeViewer.
node
- The Node to get the NodeViewer forclazz
- The type (java.lang.Class) of NodeViewer to returnpublic int getViewerCount(Node node)
Returns the count of NodeViewers that have 'accepted' the specified Node, and are available to display the contents of the Node in the ContentView. This is the number of tabs showing along the bottom of the ContentView for the specified Node.
NOTE: If the passed Node is in the ContentManager's opened list, zero is silently returned. Be sure the Node in question is actually opened before checking the number of Viewers it has.
node
- The Node to get the count of NodeViewers for.public NodeViewer[] getViewers(Node node)
Returns the NodeViewers that have 'accepted' the specified Node, and are available to display the contents of the Node in the ContentView. These are the tabs showing along the bottom of the ContentView for the specified Node.
NOTE: If the passed Node is not in the ContentManager's opened list, a zero-length array is silently returned. Be sure the Node in question is actually opened before retrieving its NodeViewers.
node
- The Node to retrieve the NodeViewers for.public void setActiveViewer(Node node, NodeViewer viewer, boolean requestFocus) throws java.lang.Exception
Sets the active NodeViewer for the specified Node.
NOTE: If the passed Node is not opened in this Browser, calling this method will fire an AssertionException. A few Browser events will be triggered:
node
- The Node to set the specified NodeViewer onviewer
- The NodeViewer to display the specified node withrequestFocus
- True for the NodeViewer to request focus once activatedjava.lang.Exception
- A few exceptions can be thrown when setting the active
NodeViewer, including VetoException (if a BrowserListener doesn't
want the viewer to change, or if a NodeViewer doesn't want the
viewer to change). An AssertionException can be thrown if the
specified Node is not currently opened in this Browser, or if the
NodeViewer is not a valid selection for the specified Node.public NodeViewer getActiveViewer(Node node)
node
- The Node whose viewer is desired.public void updateViewers(Node node)
node
- The Node whose viewers to update.public MessageView getMessageView()
public StructureView getStructureView()
public StatusView getStatusView()
public ContentManager getContentManager()
public void addBrowserListener(BrowserListener l)
l
- The BrowserListener implementation to add the listener list.public void removeBrowserListener(BrowserListener l)
l
- The BrowserListener implementation to remove from listener list.public static void addStaticBrowserListener(BrowserListener l)
l
- The BrowserListener implementation to add the listener list.public static void removeStaticBrowserListener(BrowserListener l)
l
- The BrowserListener implementation to remove from listener list.protected void fireBrowserOpened()
protected void fireBrowserActivated()
protected void fireBrowserDeactivated()
protected void fireBrowserClosing() throws VetoException
VetoException
- A listener might throw a VetoException to stop the
Browser from closing.protected void fireBrowserClosed()
protected void fireBrowserProjectActivated(Project project)
project
- The Browser's new 'active' Project. MAY BE NULL!protected void fireBrowserProjectClosed(Project project)
project
- The project that closed.protected void fireBrowserNodeActivated(Node node)
node
- The Browser's new 'active' Node. MAY BE NULL!protected void fireBrowserNodeClosed(Node node)
node
- The node that closed.protected void fireBrowserViewerActivated(Node node, NodeViewer viewer)
node
- The Node whose NodeViewer has changed.viewer
- The Node's new 'active' NodeViewer.protected void fireBrowserViewerDeactivating(Node node, NodeViewer viewer) throws VetoException
node
- The Node whose viewer is changing.viewer
- The Node's active NodeViewer.VetoException
- A listener might throw a VetoException to stop the
active NodeViewer from changing.public boolean isConstructing()
public void close() throws java.lang.Exception
java.lang.Exception
- A myriad of different exceptions can be thrown when
closing a Project, including VetoException (if a BrowserListener
doesn't want the Project, Node, or the viewer to change, or if a
NodeViewer doesn't want the viewer to change). Any number of
IOExceptions or Node exceptions can be thrown during the Node
save/close process.public void setBounds(java.awt.Rectangle b)
setBounds
in class java.awt.Component
public void addButton(ActionButton button)
button
- ActionButton to be add to the update timer list.public void removeButton(ActionButton button)
button
- ActionButton to be removed from the update timer list.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |