Package schrodinger :: Package ui :: Module appframework :: Class JobInputFrame

Class JobInputFrame

widget.tkinterwidget.schroWidget --+    
                                   |    
        Tkinter.Misc --+           |    
                       |           |    
      Tkinter.BaseWidget --+       |    
                           |       |    
            Tkinter.Pack --+       |    
                           |       |    
           Tkinter.Place --+       |    
                           |       |    
            Tkinter.Grid --+       |    
                           |       |    
              Tkinter.Widget --+   |    
                               |   |    
                   Tkinter.Frame --+    
                                   |    
          widget.tkinterwidget.Frame --+
                                       |
                                      JobInputFrame

Known Subclasses:


An application input source selection widget.

Allows the user to choose the source of the job input:  Project Table,
files, or Workspace (which is not included entries, just the Workspace
ct).

Configuration options set via constructor keywords are...

    filetypes -    If file input allowed, the file filters used in the
                   askopenfilename.  List of tuples.  Default is
                   [('Maestro Files', '*.mae')].
    initialdir -   If file input allowed, the default initial directory
                   in the askopenfilename.  Default is '.'.
    file -         Allow an external file as an input source.  Default is
                   True.
    projecttable - Allow the Project Table as an input source.  Maestro
                   only.  Default is True.
    workspace -    Allow the Workspace as an input source.  Maestro only.
                   Default is True.

    default_source - What the default source should be. Must be one of:
                     "file", "workspace", or "projecttable".
                     Default is "projecttable" if projecttable is True;
                     otherwise "file" (if file is True).

    writefile -    Automatically generate the '<jobname>.<ext>' file from
                   WS/PT/FILE source.   Default is True.  If True, the
                   written file name is stored as 'inputstrucfile' in the
                   JobParameters object, or for File input, the original
                   file name is stored as 'inputstrucorigfile'.  If False,
                   the WS CT is stored in the JobParams object as
                   'inputstruc', or the FILE filename is stored as
                   'inputstrucfile'.  If False, it is the users job to
                   create the desired input structure file(s) from the
                   JobParameters information.  For PT input, the user
                   should call 'writeSelectedEntries(<filename>)' to
                   export the desired CTs.
    label_text -   Default is: 'Use structures from:'

    file_text -    Default is: 'Input file:'

Job parameters passed out in the getParams() JobInputParams object are...

    state -         The input source type, FILE, PROJECT_TABLE, or
                    WORKSPACE
    fileselection - The file name if FILE source

These are not JobParameters attributes, and the input structure file is not
written by this class.  AppJobInputFrame does that work.

Nested Classes

[hide private]

Inherited from Tkinter.Misc: getdouble, getint

Instance Methods

[hide private]

__init__(self, parent, **kwargs)
See class docstring.

updateInput(self, result)
Callback method of the input option menu.

_enableFileSelect(self)
Turn on the file selector browse button and entry field.

_disableFileSelect(self)
Turn off the file selector browse button and entry field.

browseFiles(self)
Callback method of the file browse button.

inputState(self)
Return the input type as class constant FILE, PROJECT_TABLE, or WORKSPACE.

getFile(self)
Return the contents of the filename entry field.

warning(self, text)
Display a warning window with the specified text.

validate(self)
Validate that the JobInputFrame is in a consistent and complete state.

getParams(self)
If the current GUI state isn't valid, pop up an error message and return None.

writeSelectedEntries(self, filename, warn=True, append=False)
Write selected Project Table entries to 'filename'.

_reset(self)
Reset the input frame

Inherited from widget.tkinterwidget.schroWidget: grid, pack

Inherited from widget.tkinterwidget.schroWidget (private): _getDflts, _retrieveDflts, _update_placement

Inherited from Tkinter.BaseWidget: destroy

Inherited from Tkinter.BaseWidget (private): _do, _setup

Inherited from Tkinter.Misc: __contains__, __getitem__, __setitem__, __str__, after, after_cancel, after_idle, bbox, bell, bind, bind_all, bind_class, bindtags, cget, clipboard_append, clipboard_clear, clipboard_get, colormodel, columnconfigure, config, configure, deletecommand, event_add, event_delete, event_generate, event_info, focus, focus_displayof, focus_force, focus_get, focus_lastfor, focus_set, getboolean, getvar, grab_current, grab_release, grab_set, grab_set_global, grab_status, grid_bbox, grid_columnconfigure, grid_location, grid_propagate, grid_rowconfigure, grid_size, grid_slaves, image_names, image_types, keys, lift, lower, mainloop, nametowidget, option_add, option_clear, option_get, option_readfile, pack_propagate, pack_slaves, place_slaves, propagate, quit, register, rowconfigure, selection_clear, selection_get, selection_handle, selection_own, selection_own_get, send, setvar, size, slaves, tk_bisque, tk_focusFollowsMouse, tk_focusNext, tk_focusPrev, tk_menuBar, tk_setPalette, tk_strictMotif, tkraise, unbind, unbind_all, unbind_class, update, update_idletasks, wait_variable, wait_visibility, wait_window, waitvar, winfo_atom, winfo_atomname, winfo_cells, winfo_children, winfo_class, winfo_colormapfull, winfo_containing, winfo_depth, winfo_exists, winfo_fpixels, winfo_geometry, winfo_height, winfo_id, winfo_interps, winfo_ismapped, winfo_manager, winfo_name, winfo_parent, winfo_pathname, winfo_pixels, winfo_pointerx, winfo_pointerxy, winfo_pointery, winfo_reqheight, winfo_reqwidth, winfo_rgb, winfo_rootx, winfo_rooty, winfo_screen, winfo_screencells, winfo_screendepth, winfo_screenheight, winfo_screenmmheight, winfo_screenmmwidth, winfo_screenvisual, winfo_screenwidth, winfo_server, winfo_toplevel, winfo_viewable, winfo_visual, winfo_visualid, winfo_visualsavailable, winfo_vrootheight, winfo_vrootwidth, winfo_vrootx, winfo_vrooty, winfo_width, winfo_x, winfo_y

Inherited from Tkinter.Misc (private): _bind, _configure, _displayof, _getboolean, _getconfigure, _getconfigure1, _getdoubles, _getints, _grid_configure, _gridconvvalue, _nametowidget, _options, _register, _report_exception, _root, _substitute

Inherited from Tkinter.Pack: forget, info, pack_configure, pack_forget, pack_info

Inherited from Tkinter.Place: place, place_configure, place_forget, place_info

Inherited from Tkinter.Grid: grid_configure, grid_forget, grid_info, grid_remove, location

Class Variables

[hide private]

ERROR = 1

FILE = 'File'

OK = 0
hash(x)

PROJECT_TABLE = 'Project Table (selected entries)'

WORKSPACE = 'Workspace'

Inherited from Tkinter.Misc: _noarg_

Inherited from Tkinter.Misc (private): _subst_format, _subst_format_str, _tclCommands

Properties

[hide private]

Inherited from Tkinter.Misc (private): _windowingsystem

Method Details

[hide private]

init(self, parent, **kwargs)
(Constructor)

See class docstring. Raises an Exception if no input source is allowed.

Overrides: Tkinter.BaseWidget.__init__

updateInput(self, result)

Callback method of the input option menu. Disables the file selector and EntryField if that is not the source chosen.

browseFiles(self)

Callback method of the file browse button. Pops up a askopenfilename and places the selected file name into the file EntryField.

getFile(self)

Return the contents of the filename entry field. Returns "" if this is called while file input is not allowed.

validate(self)

Validate that the JobInputFrame is in a consistent and complete state. Pops up a warning dialog and returns ERROR if the source is set to FILE but there is no specified file name. Returns OK otherwise.

getParams(self)

If the current GUI state isn't valid, pop up an error message and return None. Otherwise, return a JobInputParams object with the input source type and filename (if FILE source).

writeSelectedEntries(self, filename, warn=True, append=False)

Write selected Project Table entries to 'filename'. If 'warn' is True, pop up a warning dialog if the file already exists. If 'append' is True, the structures will be appended to an existing file; otherwise, the existing file is overwritten. Returns True if successful, False otherwise.

Class JobInputFrame

__init__(self, parent, **kwargs) (Constructor)

updateInput(self, result)

browseFiles(self)

getFile(self)

validate(self)

getParams(self)

writeSelectedEntries(self, filename, warn=True, append=False)

init(self, parent, **kwargs)
(Constructor)