package SBEAMS::Proteomics::HTMLPrinter; ############################################################################### # Program : SBEAMS::Proteomics::HTMLPrinter # Author : Eric Deutsch # $Id$ # # Description : This is part of the SBEAMS::WebInterface module which handles # standardized parts of generating HTML. # # This really begs to get a lot more object oriented such that # there are several different contexts under which the a user # can be in, and the header, button bar, etc. vary by context # # SBEAMS is Copyright (C) 2000-2005 Institute for Systems Biology # This program is governed by the terms of the GNU General Public License (GPL) # version 2 as published by the Free Software Foundation. It is provided # WITHOUT ANY WARRANTY. See the full description of GPL terms in the # LICENSE file distributed with this software. # ############################################################################### use strict; use vars qw($sbeams $current_contact_id $current_username $current_work_group_id $current_work_group_name $current_project_id $current_project_name $current_user_context_id); use CGI::Carp qw(fatalsToBrowser croak); use SBEAMS::Connection::DBConnector; use SBEAMS::Connection::Settings; use SBEAMS::Connection::TableInfo; use SBEAMS::Proteomics::Settings; use SBEAMS::Proteomics::TableInfo; use constant MENU_WIDTH => 138; ############################################################################### # Constructor ############################################################################### sub new { my $this = shift; my $class = ref($this) || $this; my $self = {}; bless $self, $class; return($self); } ############################################################################### # printPageHeader ############################################################################### sub printPageHeader { my $self = shift; $self->display_page_header(@_); } ############################################################################### # display_page_header ############################################################################### sub display_page_header { my $self = shift; my %args = @_; my $navigation_bar = $args{'navigation_bar'} || "YES"; #### If the output mode is interactive text, display text header my $sbeams = $self->getSBEAMS(); if ($sbeams->output_mode() eq 'interactive') { $sbeams->printTextHeader(); return; } #### If the output mode is not html, then we don't want a header here if ($sbeams->output_mode() ne 'html') { return; } #### Obtain main SBEAMS object and use its http_header $sbeams = $self->getSBEAMS(); my $http_header = $sbeams->get_http_header(); print qq~$http_header $DBTITLE - $SBEAMS_PART ~; $self->printJavascriptFunctions(); $self->printStyleSheet(); #### Determine the Title bar background decoration my $header_bkg = "bgcolor=\"$BGCOLOR\""; $header_bkg = "background=\"$HTML_BASE_DIR//images/plaintop.jpg\"" if ($DBVERSION =~ /Primary/); my $gwidth = ( MENU_WIDTH ) ? MENU_WIDTH/2 : 64; print qq~ ~; #print ">>>http_header=$http_header
\n"; if (uc($navigation_bar) eq 'YES' || uc($navigation_bar) eq 'SHORT') { print qq~ ~; } print qq~
ISB DB SBEAMS

$DBTITLE - $SBEAMS_PART
$DBVERSION

~; if (uc($navigation_bar) eq 'YES') { my $spad = ' ' x 3; my $datamenu = qq~
$DBTITLE Home
$SBEAMS_PART Home
Logout
   My Home
   Projects
   Experiments
   Samples
   Protocols
   Publications
~; my $browsemenu = qq~
   Summarize Fractions
   Browse Search Hits
   Summarize over
       Proteins/Peptides
   Compare Exp's
   Compare MSRuns
   Compare By Spec
   Browse BioSeqs
   Browse APD
   Browse Possible
       Tryptic Peptides
   Protein Summary
~; my $coremenu = qq~
   BioSequenceSets
   DB XRefs
   Gradient Program
   User Annot Label
   Request Experiments
   Request Management
   Data Processing
   APD Tables
~; my $othermenu = qq~
${spad}Documentation
   Proteomics Toolkit
   MassSpec Schedule
~; my ($corecontent,$corelink) = $sbeams->make_toggle_section( content => $coremenu, name => 'pr_core_menu', sticky => 1 ); my ($browsecontent,$browselink) = $sbeams->make_toggle_section( content => $browsemenu, name => 'pr_browse_menu', visible => 1, sticky => 1 ); my ($datacontent,$datalink) = $sbeams->make_toggle_section( content => $datamenu, name => 'pr_data_menu', sticky => 1 ); my ($othercontent,$otherlink) = $sbeams->make_toggle_section( content => $othermenu, visible => 1, name => 'pr_other_menu', sticky => 1 ); my $gif_spacer = $sbeams->getGifSpacer(MENU_WIDTH); print qq~
$gif_spacer
$datalink Manage Data:
$datacontent
$browselink Browse Data:
$browsecontent
${corelink}Core Management:
$corecontent
${otherlink}Other Tools:
$othercontent
~; } else { print qq~
~; } } # ############################################################################### # printStyleSheet # # Print the standard style sheet for pages. Use a font size of 10pt if # remote client is on Windows, else use 12pt. This ends up making fonts # appear the same size on Windows+IE and Linux+Netscape. Other tweaks for # different browsers might be appropriate. ############################################################################### sub printStyleSheet { my $self = shift; #### Obtain main SBEAMS object and use its style sheet $sbeams = $self->getSBEAMS(); $sbeams->printStyleSheet(); } ############################################################################### # printJavascriptFunctions # # Print the standard Javascript functions that should appear at the top of # most pages. There probably should be some customization allowance here. # Not sure how to design that yet. ############################################################################### sub printJavascriptFunctions { my $self = shift; my $javascript_includes = shift; print qq~ ~; } ############################################################################### # documentation_list ############################################################################### sub documentation_list { #link for schema needs help my $self = shift; print qq~

Proteomics Documentation

~; } ############################################################################### # printPageFooter ############################################################################### sub printPageFooter { my $self = shift; $self->display_page_footer(@_); } ############################################################################### # display_page_footer ############################################################################### sub display_page_footer { my $self = shift; my %args = @_; #### If the output mode is interactive text, display text header my $sbeams = $self->getSBEAMS(); if ($sbeams->output_mode() eq 'interactive') { $sbeams->printTextHeader(%args); return; } #### If the output mode is not html, then we don't want a header here if ($sbeams->output_mode() ne 'html') { return; } #### Process the arguments list my $close_tables = $args{'close_tables'} || 'YES'; my $display_footer = $args{'display_footer'} || 'YES'; my $separator_bar = $args{'separator_bar'} || 'NO'; #### If closing the content tables is desired if ($close_tables eq 'YES') { print qq~
~; } #### If displaying a fat bar separtor is desired if ($separator_bar eq 'YES') { print "


\n"; } #### If finishing up the page completely is desired if ($display_footer eq 'YES') { #### Default to the Core footer $sbeams->display_page_footer(display_footer=>'YES'); } } # end display_page_footer ############################################################################### 1; __END__ ############################################################################### ############################################################################### ############################################################################### =head1 NAME SBEAMS::WebInterface::HTMLPrinter - Perl extension for common HTML printing methods =head1 SYNOPSIS Used as part of this system use SBEAMS::WebInterface; $adb = new SBEAMS::WebInterface; $adb->printPageHeader(); $adb->printPageFooter(); $adb->getGoBackButton(); =head1 DESCRIPTION This module is inherited by the SBEAMS::WebInterface module, although it can be used on its own. Its main function is to encapsulate common HTML printing routines used by this application. =head1 METHODS =item B Prints the common HTML header used by all HTML pages generated by theis application =item B Prints the common HTML footer used by all HTML pages generated by this application =item B Returns a form button, coded with javascript, so that when it is clicked the user is returned to the previous page in the browser history. =head1 AUTHOR Eric Deutsch =head1 SEE ALSO perl(1). =cut