From 0031991fad54c376b742b1a425531345638cbf57 Mon Sep 17 00:00:00 2001 From: Paul Buetow Date: Sat, 7 Feb 2009 11:29:36 +0000 Subject: initial import into svn --- doc/client/NetCalendarClient.html | 562 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 562 insertions(+) create mode 100644 doc/client/NetCalendarClient.html (limited to 'doc/client/NetCalendarClient.html') diff --git a/doc/client/NetCalendarClient.html b/doc/client/NetCalendarClient.html new file mode 100644 index 0000000..d2e1a27 --- /dev/null +++ b/doc/client/NetCalendarClient.html @@ -0,0 +1,562 @@ + + + + + + +NetCalendarClient + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +client +
+Class NetCalendarClient

+
+java.lang.Object
+  extended byjava.awt.Component
+      extended byjava.awt.Container
+          extended byjava.awt.Window
+              extended byjava.awt.Frame
+                  extended byjavax.swing.JFrame
+                      extended byclient.NetCalendarClient
+
+
+
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.WindowConstants
+
+
+
+
public class NetCalendarClient
extends javax.swing.JFrame
+ +

+This is the main class of the client part of the netcalendar suite. It contains the main GUI. + All subguis are created within this class. +

+ +

+

+
Author:
+
buetow
+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class javax.swing.JFrame
EXIT_ON_CLOSE
+  + + + + + + + +
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
NetCalendarClient() + +
+          Standard constructor, creates the client GUI.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddFrame(javax.swing.JFrame jFrame) + +
+          This method tells the main netcalendar client JFrame which sub JFrames are opened.
+ voiddeleteEvent(CalendarEvent deleteEvent) + +
+          This method tells the calendar server to delete a given calendar event.
+ voiddispose() + +
+          This method disposes this JFrame window including all the JFrame windows which + belong to this session.
+ java.lang.StringgetSessionString() + +
+          If the client has several main windows open, then it will display a + session indicator so that the user knows which window belongs to which + session window.
+ voidremoveFrame(javax.swing.JFrame jFrame) + +
+          This method tells the main netcalendar client JFrame which sub JFrames are opened.
+ voidstatusMessage(java.lang.String sMessage) + +
+          This method is for various status messages.
+ voidupdate(ClientRequest clientRequest) + +
+          This method sends a client request object to the server and used the server response object + to update the JTable ith its new values using the table model.
+ voidupdate(ServerResponse serverResponse) + +
+          This method updates the GUI unsing a given server response object.
+ voidupdateLast() + +
+          This method sends the last client request object being used to the server again.
+  + + + + + + + +
Methods inherited from class javax.swing.JFrame
getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, update
+  + + + + + + + +
Methods inherited from class java.awt.Frame
addNotify, 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, 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, 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, remove, removeAll, removeContainerListener, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, transferFocusBackward, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, 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, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  + + + + + + + +
Methods inherited from interface java.awt.MenuContainer
getFont, postEvent
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+NetCalendarClient

+
+public NetCalendarClient()
+
+
Standard constructor, creates the client GUI. +

+

+ + + + + + + + +
+Method Detail
+ +

+update

+
+public void update(ClientRequest clientRequest)
+
+
This method sends a client request object to the server and used the server response object + to update the JTable ith its new values using the table model. +

+

+
Parameters:
clientRequest - Specifies the client request object to use for the updating.
+
+
+
+ +

+updateLast

+
+public void updateLast()
+
+
This method sends the last client request object being used to the server again. If + If there is no last client request, nothing will be done. +

+

+
+
+
+
+ +

+update

+
+public void update(ServerResponse serverResponse)
+
+
This method updates the GUI unsing a given server response object. +

+

+
Parameters:
serverResponse - Specifies the server response to use for the updating.
+
+
+
+ +

+deleteEvent

+
+public void deleteEvent(CalendarEvent deleteEvent)
+
+
This method tells the calendar server to delete a given calendar event. +

+

+
Parameters:
deleteEvent - Specifies the calendar event to delete.
+
+
+
+ +

+getSessionString

+
+public java.lang.String getSessionString()
+
+
If the client has several main windows open, then it will display a + session indicator so that the user knows which window belongs to which + session window. +

+

+ +
Returns:
Returns the session indicator of the current client session.
+
+
+
+ +

+statusMessage

+
+public void statusMessage(java.lang.String sMessage)
+
+
This method is for various status messages. All messages will show up in the + status bar of the current client session window. +

+

+
Parameters:
sMessage - Specifies the message to be displayed in the status bar.
+
+
+
+ +

+dispose

+
+public void dispose()
+
+
This method disposes this JFrame window including all the JFrame windows which + belong to this session. +

+

+
+
+
+
+ +

+addFrame

+
+public void addFrame(javax.swing.JFrame jFrame)
+
+
This method tells the main netcalendar client JFrame which sub JFrames are opened. + So that all the sub JFrames will be disposed as well if the main JFrame gets disposed. + A sub JFrame is for example a input form for advanced searching or the preferences dialog. +

+

+
Parameters:
jFrame - Specifies the frame object to add. .
+
+
+
+ +

+removeFrame

+
+public void removeFrame(javax.swing.JFrame jFrame)
+
+
This method tells the main netcalendar client JFrame which sub JFrames are opened. + So that all the sub JFrames will be disposed as well if the main JFrame gets disposed. + A sub JFrame is for example a input form for advanced searching or the preferences dialog. +

+

+
Parameters:
jFrame - Specifies the frame object to remove.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + -- cgit v1.2.3