| Home >> All >> org >> greenstone >> gatherer >> [ gui Javadoc ] |
• org.greenstone.gatherer.gui: Javadoc index of package org.greenstone.gatherer.gui.
Package Samples:
• org.greenstone.gatherer.gui.tree
• org.greenstone.gatherer.gui.messages
• org.greenstone.gatherer.gui.table
• org.greenstone.gatherer.gui.border
• org.greenstone.gatherer.gui.combobox
• org.greenstone.gatherer.gui.metaaudit
• org.greenstone.gatherer.gui.browser
Classes:
• MetaAuditFrame: The MetaAuditFrame provides a table view of all of the metadata assigned to a selection of FileNodes. All values for a certain file and a certain metadata element appear in the same cell. This table can be sorted by any column, and also has a MS Excel-like AutoFilter allowing you to restrict the rows visible to only those that match a certain set of criteria (applied to each column, and then 'ANDED', or cojoined, to determine the filter). Finally this dialog does not block the Gatherer tool, so the file selection can be changed and the dialog will just generate a new table dynamically. Much effort ...
• CreatePane: This class provides a GUI view showing some statistics on your current collection, and options for building it. As the collection is built this initial view is replaced with one showing progress bars and a message log of the creation process. This log can be later accessed via the options tree located in the center of the initial pane. This class is also responsible for creating the GShellProgressMonitors that are then attatched to external shell processes, and calling the methods in the CollectionManager for actually importing and building the collection. The (i)mport and/or (b)uild options supported: ...
• AutofilterDialog: The autofilter concept comes from Microsoft Excel spreadsheets that use autofilters to filter to the sheet. When you click on the heading of a column, a new prompt allows you to specify what filter should be acting apon the selected column. Any new filter is conjoined with any previous filters to provide a sheet containing only rows that match all current filters. Each column must also provide an indicator for determining if a filter is set (in this case a special icon) and and a method for removing a filter (use the clear filter button within the autofilter dialog). Having recently discovered ...
• CollectionPane: The collection pane is analogous with a file manager. It is there that the user chooses which files to include in their collection and what structure the file hierarchy should take. The later aspect is not important for the Greenstone Suite, but is usefull for grouping files for ease of metadata markup. The view essentially consists of two file trees, one denoting the entire source workspace and the other the files within your collection. The trees themselves have a title bar at the top, a filter control at the bottom, and are coloured to indicate activity (grey for disabled). The remainder of ...
• GTableModel: Provides the model for a GTable component, filling it with metadata values for the choosen files or folders. The model also provides several different view of this data; assigned folder metadata, assigned file metadata, all assigned metadata, unassigned metadata, and all metadata. It also differentiates between metadata that is common to all of the files or folders, and that which isn't. The building of the actual model is done on a separate thread so that the gui remains responsive, and the gui is intermitantly updated by this thread. Updating of the model is triggered by events recieved from ...
• Filter: This object allows the user to set a filter on one of the workspace trees, specifying a preset type, or a regular expression that a files must match to be in the tree. Note that all directories are included. This class includes the controls for editing the filter. The trick is that several instances of the Filter class can share the same internal data (termed a 'run' of filters), so that the filter set on the CollectionPane and the MetaEditPane are virtually the same. The regular expression typed uses '*' as a wildcard character (equivalent to '.*'), and does not use '.' to match any single character ...
• ModalDialog: An extension of the JDialog that overrides the JVM's typical modal behaviour. This typical behaviour is that when a modal dialog is opened, all other windows cease to respond to user events until the modal dialog is disposed. However this prevents us opening the help documents property whenever a modal dialog is open. Thus we override the modal behaviour so that only the owner frame or dialog is blocked. Note that because we always call the super constructor with modal set to false, this should be made visible with setVisible(true) rather than show() which will return straight away.
• LongProgressBar: A progress bar that doesn't pack a sad when you feed it longs (such as the sizes of files) which get mangled into negative numbers. I know how it feels, as I often have negative progress. Also tries to be efficent when updating the JProgressBar, so only updates when the value actually changes, which become necessary when you move a large number of files with millions of bytes (where upon shifting a file of a thousand bytes would be pretty insignificant, maybe not even a percent, but would fire several progress updates).
• BorderFactory: Gatherers own version of the javax.swing.BorderFactory which has two major differences: firstly the titled borders returned are org.greenstone.gatherer.gui.border.TitledBorders which are aware who their parents are and are -not- ever shared. The second difference is that I haven't been so much of a biarch as to use a private contructor so as prevent any other programmer in the world from extending my class. Jaded? Me? Nah.
• MetaEditPane: Provides a view of controls for the editing of metadata. It makes use of several other important components such as a GTree, GTable and GValueTree. While much of the gui content is left to these components, the MetaEditPane is resposible for actioning metadata edit requests, listing for mouse clicks within its scope and other data functionality (such as providing a list of the selected files).
• GConfigPane: This serves as the Collection configuration pane and came in two flavors. The lower tech version has now been made redundant. The higher tech, and finally implemented, version uses a tree to allow a user to navigate through the various regions of the config file and further allows them to interactively design and modify such gsdl elements as classifiers and plugins.
• OptionsPane: This class serves as the data holder for all subclasses of option panes, such as Import options or All options. It also contains methods for creating each of the option lines as they would appear in the subpane. Futhermore it has a method for considering all the arguments and generating a String[] to allow you to pass them to the GShell .
• GUIManager: The GUIManager is in charge of creating the Gatherer window frame then filling it with the goodness of the view panes. GUIManager not only creates these panes, but allows some messaging between them. Furthermore GUIManager includes functionality from menu driven choices, simply as it was easier to put it here once and have it accessible from all pane children.
• GComboBox: In order for a JComboBox to perform the way Gatherer requires, ie firing a DocumentEvent of some form whenever the user edits the content of the currently selected item, we need to subclass JComboBox and build a version which adds a DocumentListener to the JTextField within the combobox not to the combobox itself. The same deal applies for KeyListeners.
• ComboArea: Combines the idea of a combobox with a text area so that multiline entries can be displayed properly. Basically takes a JCombobox, (or in this case a SteppedComboBox that allows us to control the popup window that appears), butchers out the JTextField editor while retaining the button and the data model, then uses a JTextArea for the editor instead.
• SmudgyLabel: Just like a JLabel, except the text shown is updated using an overwriting runnable so that updates will only occur when process load is moderate. This functionality is currently disabled as it was somehow taking 5% of copy time, and not doing what it was supposed to anyway (the same event apparently can be added to the event queue over and over).
• GTableCellEditor: This implementation of the TableCellRenderer interface allows for us to return a GComboBox with the correct model given a reference to the original metadata row within the given table. All edit calls, other than those from the third column, ie the values column, get the default editor component.
• GBrowserEvent: A GBrowserEvent is an event fired by one of Gatherers HTMLViewPane browser implementations. They come in two flavours; GURL events contain a url which the message is about and may have an associated message String, while pure message events contain only a String.
• SimpleOpenCollectionDialog: A dialog which provides a straight-forward access to the currently installed collections. It also will contain the ability to continue through to the original OpenCollectionDialog if your source collection is located somewhere other than the gsdl collect folder.
• Coloring: The coloring object is part of the Gatherers configuration, and stores the various colours used to render parts of the interface. In general these colours fall into three groups, those for the workspace, those for the collection and all other colour components.
• MetaEditPrompt: Displays a dynamic prompt to allow the user to choose how metadata is to be added, updated or removed from target FileNodes. The prompt changes depending on the action requested, the file nodes encountered and the number of file nodes in the selection.
• LockFileDialog: A lock file dialog is shown whenever GLI detects an existing lock on a collection it is trying to open. The user can look at the details provided with the dialog, and decide whether to 'steal' the lock or to cancel the loading.
| Home | Contact Us | Privacy Policy | Terms of Service |