|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | 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.ca.directory.jxplorer.JXplorer
Does the main setup for JXplorer.
| Nested Class Summary |
| Nested classes inherited from class javax.swing.JFrame |
javax.swing.JFrame.AccessibleJFrame |
| Nested classes inherited from class java.awt.Frame |
java.awt.Frame.AccessibleAWTFrame |
| Nested classes inherited from class java.awt.Window |
java.awt.Window.AccessibleAWTWindow |
| Nested classes inherited from class java.awt.Container |
java.awt.Container.AccessibleAWTContainer |
| Nested classes inherited from class java.awt.Component |
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy |
| Field Summary | |
static java.lang.String |
CA_PATH_PROPERTY
|
static java.lang.String |
CA_TYPE_PROPERTY
|
static java.lang.String |
CLIENT_PATH_PROPERTY
|
static java.lang.String |
CLIENT_TYPE_PROPERTY
|
static boolean |
debug
|
static int |
debugLevel
|
static java.lang.String |
fileURLPrefix
|
protected CBHelpSystem |
helpSystem
|
java.lang.Thread |
jndiThread
|
static javax.swing.JFrame |
jx
|
static java.lang.String |
localDir
|
protected MainMenu |
mainMenu
|
static java.util.Properties |
myProperties
|
java.lang.Thread |
offlineThread
|
static java.lang.String |
propertyFile
|
java.lang.Thread |
schemaThread
|
java.lang.Thread |
searchThread
|
protected java.util.Stack |
statusStack
|
protected StopMonitor |
stopMonitor
|
| 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, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, 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 | |
JXplorer()
Constructor for the JXplorer object, which is in fact the whole browser. |
|
| Method Summary | |
void |
addJXplorerListener(JXplorerListener l)
Adds the specified JXplorer listener to receive JXplorer events from JXplorer. |
protected void |
addSecurityProvider(java.lang.String providerName)
Allows extra security providers to be manually added. |
static boolean |
checkFileEnvironment()
Checks that the file directories are valid, and contain any vital files. |
static boolean |
checkJavaEnvironment()
Checks that the java and system environment is adequate to run in. |
void |
checkPropertyDependantActions(java.lang.String key,
java.lang.String value)
This is triggered when a global property changes for some reason, and takes any appropriate action. |
void |
disconnect()
Disables/enables the menu and button bar items to reflect a disconnected state. |
void |
fireJXplorerEvent(JXplorerEvent e)
Creates JXplorer events by dispatching them to any registered JXplorerListener objects.
|
SmartTree |
getActiveTree()
Returns the tree that is currently being directly displayed to the user. |
AttributeDisplay |
getAttributeDisplay()
Returns the Attribute Display. |
javax.swing.JScrollPane |
getExplorePanel()
Returns the Explore panel. |
static java.lang.String |
getFileURL(java.lang.String fileDir)
In order to use file paths as urls, we must attach an appropriate prefix (e.g. file://) and change any backslashes to forward slashes. |
CBHelpSystem |
getHelpSystem()
This returns the help system used by JX. |
static javax.swing.ImageIcon |
getImageIcon(java.lang.String name)
JXplorer utility ftn: load an image from the standard JX images directory. |
MainMenu |
getMainMenu()
Returns Main Menu. |
static java.util.Properties |
getMyProperties()
Sometimes it is more convenient to simply pass the whole properties hash to a subordinate class, rather than using the get...() methods |
static java.lang.String |
getProperty(java.lang.String key)
Convenience function to access both the System property list, or failing that the internal JXplorer properties list. |
static java.lang.String |
getProperty(java.lang.String key,
java.lang.String defaultValue)
Convenience function to access the internal JXplorer properties list. |
javax.swing.JScrollPane |
getResultsPanel()
Returns the panel for displaying the search results. |
static javax.swing.JFrame |
getRootFrame()
Returns the JXplorer frame. |
JNDIBroker |
getSearchBroker()
Returns the JNDIBroker used for searching, and the search tree. |
SmartTree |
getSearchTree()
Returns the search display tree. |
java.lang.String |
getStatus()
|
StopMonitor |
getStopMonitor()
returns the current stop monitor object. |
SmartTree |
getTree()
Returns the display tree. |
javax.swing.JTabbedPane |
getTreeTabPane()
Returns the tree's tabbed pane. |
void |
initialiseTree(SmartTree tree,
DataSink viewer,
JXplorerEventGenerator gen)
|
void |
initJNDIBroker()
|
void |
initOfflineBroker()
initialise the offline broker, used for viewing ldif files independantly of a working directory. |
void |
initSchemaBroker()
|
void |
initSearchBroker()
|
void |
initStopMonitor()
|
void |
initUtilityFtns(javax.swing.JFrame rootFrame)
Set up some common utility ftns for logging and error reporting. |
static boolean |
isLinux()
Test for Linux (usually to disable features that appear to be more than usually broken on that platform - e.g. |
static boolean |
isSolaris()
Test for solaris (usually to disable features that appear to be more than usually broken on that platform - e.g. drag and drop). |
static void |
main(java.lang.String[] args)
The main class, from whence all else proceeds. |
protected void |
makeDNAutoRefreshing(DN dn)
|
java.lang.String |
popStatus()
recalls a status message saved via @pushStatus, as well as setting it using @setStatus. |
protected void |
positionBrowser()
Set the position and size of the browser to be (where possible) the same As it was the last time it was used. |
boolean |
postConnectionSetup(com.ca.directory.jxplorer.broker.JNDIBroker.DataConnectionQuery request)
When a connection has been established (i.e. by JXOpenConWin), this method is called to link up the trees with their respective data brokers. |
void |
preConnectionSetup()
Before a new connection is made, the old display trees should be cleared. |
protected static void |
printSecurityProviders()
|
static void |
printTime(java.lang.String msg)
|
void |
pushStatus(java.lang.String newMessage)
saves the old Status message on the status stack for later use, and sets status to a new message. |
void |
removeJXplorerListener(JXplorerListener l)
Removes the specified JXplorer listener so that it no longer receives JXplorer events from this button. |
static void |
runTests()
|
protected static void |
setDefaultLocationProperty(java.lang.String propName,
java.lang.String defaultLocation)
loads a property representing a file directory (XXX or url), and checks that that it exists. |
static java.lang.String |
setDefaultProperty(java.lang.String key,
java.lang.String value)
Sets the default values for properties. |
void |
setDisconnectView()
Disables/enables the menu and button bar items to reflect a disconnected state. |
static void |
setProperties(java.util.Properties suppliedProperties)
Initialises the myProperties property list, and sets default values for properties not in the config file. |
static void |
setProperty(java.lang.String key,
java.lang.String value)
sets a property in the dxserver property list. |
void |
setStatus(java.lang.String s)
Sets a status message that is displayed on the bottom of the screen. |
protected void |
setupActiveComponents()
this is where smart objects such as the tree viewer, the results viewer (from the search class) and the attribute viewers get added to the panes. |
protected void |
setupFrills()
Make minor additions; the top-right window icon and the title bar text. |
protected void |
setupGUI()
Starts the GUI off, calling subroutines to initialise the overall window, the menu and the main panel. |
protected void |
setupHelp()
Initialise the JavaHelp system, pointing it at the right help files. |
protected void |
setupLookAndFeel()
This sets the initial look and feel to the local system look and feel, if possible; otherwise uses the java default. |
protected void |
setupMainPanel()
Sets up the main panel, and places the directory viewing panels in it. |
protected void |
setupMainWorkArea()
Sets up the main work area, below the tool bar, which displays the tree/browser panel, and the results panel... |
protected void |
setupMenu()
Sets up the menu items, along with appropriate listeners |
void |
setupResourceFiles()
A variety of plugin possibilities exist in JXplorer. |
protected void |
setupSecurityProviders()
|
protected void |
setupStatusDisplay()
The Status panel is the small (one line) panel at the bottom of the browser that reports to users what is happening with the browser (e.g. |
protected void |
setupToolBars()
|
protected void |
setupWindowButtons()
Sets up the window behaviour to close the application on a window close. |
void |
showSplashScreen(javax.swing.JWindow splash)
Displays a splash screen with a thin black border in the center of the screen. |
void |
shutdown()
Closes the application down |
void |
shutdown(java.lang.String msg)
Closes the application down, optionally printing out a message |
static void |
start(java.util.Properties myProperties)
A common start point. |
java.lang.String |
toString()
|
| Methods inherited from class javax.swing.JFrame |
addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update |
| Methods inherited from class java.awt.Frame |
addNotify, finalize, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setIconImage, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated |
| Methods inherited from class java.awt.Window |
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, hide, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, show, toBack, toFront |
| Methods inherited from class java.awt.Container |
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, transferFocusBackward, transferFocusDownCycle, validate, validateTree |
| Methods inherited from class java.awt.Component |
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, 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, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, transferFocus, transferFocusUpCycle |
| 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 |
public static java.util.Properties myProperties
public static java.lang.String propertyFile
public static java.lang.String localDir
public static java.lang.String fileURLPrefix
public static javax.swing.JFrame jx
public static boolean debug
public static int debugLevel
protected java.util.Stack statusStack
protected MainMenu mainMenu
protected CBHelpSystem helpSystem
protected StopMonitor stopMonitor
public java.lang.Thread jndiThread
public java.lang.Thread schemaThread
public java.lang.Thread searchThread
public java.lang.Thread offlineThread
public static final java.lang.String CLIENT_TYPE_PROPERTY
public static final java.lang.String CA_TYPE_PROPERTY
public static final java.lang.String CLIENT_PATH_PROPERTY
public static final java.lang.String CA_PATH_PROPERTY
| Constructor Detail |
public JXplorer()
| Method Detail |
public static void printTime(java.lang.String msg)
public static void main(java.lang.String[] args)
args - Not currently used.public void initUtilityFtns(javax.swing.JFrame rootFrame)
public static void start(java.util.Properties myProperties)
public static void runTests()
public static boolean checkJavaEnvironment()
public static boolean checkFileEnvironment()
public static java.lang.String getProperty(java.lang.String key)
public static java.lang.String getProperty(java.lang.String key,
java.lang.String defaultValue)
public static java.util.Properties getMyProperties()
public static void setProperty(java.lang.String key,
java.lang.String value)
public void checkPropertyDependantActions(java.lang.String key,
java.lang.String value)
public static java.lang.String setDefaultProperty(java.lang.String key,
java.lang.String value)
key - the unique key of the property.value - the actual value to set.
public static java.lang.String getFileURL(java.lang.String fileDir)
If fileURLPrefix has been set to a legitimate web address, the files should be automatically pulled from that site.
fileDir - the file directory to reproduce as a url
public static void setProperties(java.util.Properties suppliedProperties)
protected static void setDefaultLocationProperty(java.lang.String propName,
java.lang.String defaultLocation)
public void initJNDIBroker()
public void initSearchBroker()
public void initSchemaBroker()
public void initOfflineBroker()
public void initStopMonitor()
public StopMonitor getStopMonitor()
protected void setupGUI()
protected void positionBrowser()
protected void setupLookAndFeel()
protected void setupWindowButtons()
protected void setupMenu()
public MainMenu getMainMenu()
public JNDIBroker getSearchBroker()
public javax.swing.JTabbedPane getTreeTabPane()
public javax.swing.JScrollPane getExplorePanel()
public javax.swing.JScrollPane getResultsPanel()
public SmartTree getSearchTree()
public SmartTree getTree()
public static javax.swing.JFrame getRootFrame()
public AttributeDisplay getAttributeDisplay()
protected void setupMainPanel()
protected void setupToolBars()
protected void setupActiveComponents()
public void initialiseTree(SmartTree tree,
DataSink viewer,
JXplorerEventGenerator gen)
protected void setupStatusDisplay()
public java.lang.String getStatus()
public void setStatus(java.lang.String s)
public void pushStatus(java.lang.String newMessage)
newMessage - the new status message to set
(note - this new Message is *not* saved on the stack!)public java.lang.String popStatus()
protected void setupMainWorkArea()
public SmartTree getActiveTree()
protected void setupFrills()
public static javax.swing.ImageIcon getImageIcon(java.lang.String name)
name - the file name of the image file within the images directory
protected void setupHelp()
public CBHelpSystem getHelpSystem()
public void shutdown()
public void shutdown(java.lang.String msg)
msg - optional message to be printed out on closing.public java.lang.String toString()
toString in class java.awt.Componentpublic void preConnectionSetup()
public boolean postConnectionSetup(com.ca.directory.jxplorer.broker.JNDIBroker.DataConnectionQuery request)
This does quite a bit of work, including trying to find the default base naming context(s), and registering schema.
protected void makeDNAutoRefreshing(DN dn)
public void disconnect()
public void setDisconnectView()
public void addJXplorerListener(JXplorerListener l)
l - the JXplorer listenerjava.awt.event.JXplorerListener,
java.awt.Button#removeJXplorerListenerpublic void removeJXplorerListener(JXplorerListener l)
l - the JXplorer listenerjava.awt.event.JXplorerListener,
java.awt.Button#addJXplorerListenerpublic void fireJXplorerEvent(JXplorerEvent e)
JXplorerListener objects.
(Implements the JXplorerEventGenerator interface)
fireJXplorerEvent in interface JXplorerEventGeneratore - the JXplorer event.JXplorerEventGenerator,
JXplorerListener,
addJXplorerListener(com.ca.directory.jxplorer.event.JXplorerListener)public void showSplashScreen(javax.swing.JWindow splash)
public void setupResourceFiles()
protected void setupSecurityProviders()
protected void addSecurityProvider(java.lang.String providerName)
providerName - the class name of the security provider to
add (e.g. something like 'sun.security.provider.Sun')protected static void printSecurityProviders()
public static boolean isSolaris()
public static boolean isLinux()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||