C# Class SobekCM.Library.AdminViewer.Settings_AdminViewer

Class allows an authenticated system admin to view and edit the library-wide system settings in this library
This class extends the abstract_AdminViewer class.

MySobek Viewers are used for registration and authentication with mySobek, as well as performing any task which requires authentication, such as online submittal, metadata editing, and system administrative tasks.

During a valid html request, the following steps occur:
  • Application state is built/verified by the Application_State_Builder
  • Request is analyzed by the QueryString_Analyzer and output as a Navigation_Object
  • Main writer is created for rendering the output, in his case the Html_MainWriter
  • The HTML writer will create the necessary subwriter. Since this action requires authentication, an instance of the MySobek_HtmlSubwriter class is created.
  • The mySobek subwriter creates an instance of this viewer to show the library-wide system settings in this digital library
Inheritance: abstract_AdminViewer
Datei anzeigen Open project: MarkVSullivan/SobekCM-Web-Application

Public Methods

Method Description
Settings_AdminViewer ( RequestCache RequestSpecificValues ) : System

Constructor for a new instance of the Thematic_Headings_AdminViewer class

Postback from handling saving the new settings is handled here in the constructor

Write_HTML ( TextWriter Output, Custom_Tracer Tracer ) : void

Add the HTML to be displayed in the main SobekCM viewer area

This class does nothing, since the themes list is added as controls, not HTML

Write_ItemNavForm_Closing ( TextWriter Output, Custom_Tracer Tracer ) : void

This is an opportunity to write HTML directly into the main form, without using the pop-up html form architecture

This text will appear within the ItemNavForm form tags

Private Methods

Method Description
Add_Setting_Table_Heading ( TextWriter Output, string Heading, bool IsFirst ) : void
Add_Setting_Table_Setting ( TextWriter Output, SobekCM.Core.Settings.Admin_Setting_Value Value, bool OddRow ) : void
Is_Value_ReadOnly ( SobekCM.Core.Settings.Admin_Setting_Value Value, bool ReadOnlyMode, bool LimitedRightsMode ) : bool
add_builder_folders_info ( TextWriter Output ) : void
add_builder_info ( TextWriter Output ) : void
add_builder_modules_info ( TextWriter Output ) : void
add_builder_settings_info ( TextWriter Output ) : void
add_builder_toplevel_info ( TextWriter Output ) : void
add_buttons ( TextWriter Output ) : void
add_configuration_file_info ( TextWriter Output ) : void
add_configuration_info ( TextWriter Output ) : void
add_configuration_log_info ( TextWriter Output ) : void
add_configuration_toplevel_info ( TextWriter Output ) : void
add_engine_authentication_info ( TextWriter Output ) : void
add_engine_brief_item_mapping_info ( TextWriter Output ) : void
add_engine_contact_info ( TextWriter Output ) : void
add_engine_info ( TextWriter Output ) : void
add_engine_oai_pmh_info ( TextWriter Output ) : void
add_engine_qc_tool_info ( TextWriter Output ) : void
add_engine_server_endpoints_info ( TextWriter Output ) : void
add_engine_toplevel_info ( TextWriter Output ) : void
add_extensions_info ( TextWriter Output ) : void
add_html_info ( TextWriter Output ) : void
add_html_missing_page_info ( TextWriter Output ) : void
add_html_no_results_info ( TextWriter Output ) : void
add_html_toplevel_info ( TextWriter Output ) : void
add_html_usage_email_info ( TextWriter Output ) : void
add_leftnav_h2_link ( string Text, string LinkCode, string RedirectUrl, string CurrentLinkCode ) : string
add_leftnav_li_link ( string Text, string LinkCode, string RedirectUrl, string CurrentLinkCode ) : string
add_metadata_fields_info ( TextWriter Output ) : void
add_metadata_file_readers_info ( TextWriter Output ) : void
add_metadata_info ( TextWriter Output ) : void
add_metadata_mets_profiles_info ( TextWriter Output ) : void
add_metadata_mets_sections_info ( TextWriter Output ) : void
add_metadata_modules_info ( TextWriter Output ) : void
add_metadata_single_config ( TextWriter Output, METS_Section_ReaderWriter_Config Config, bool onlyShowDefaultMd ) : void
add_metadata_toplevel_info ( TextWriter Output ) : void
add_settings_info ( TextWriter Output ) : void
add_single_metadata_writing_profile ( TextWriter Output, METS_Writing_Profile Profile ) : void
add_single_verb_mapping_in_table ( Engine_VerbMapping Mapping, TextWriter Output ) : void
add_tab_page_info ( TextWriter Output, string TabPageName, List AdminSettingValues, string OmitHeading = null ) : void
add_top_level_info ( TextWriter Output ) : void
add_ui_citation_info ( TextWriter Output ) : void
add_ui_citation_set_info ( TextWriter Output, CitationSet SetInfo ) : void
add_ui_client_endpoints_info ( TextWriter Output ) : void
add_ui_info ( TextWriter Output ) : void
add_ui_map_editor_info ( TextWriter Output ) : void
add_ui_template_elements_info ( TextWriter Output ) : void
add_ui_toplevel_info ( TextWriter Output ) : void
add_ui_viewers_info ( TextWriter Output ) : void
build_setting_objects_for_display ( ) : void
must_be_positive_number ( Simple_Setting NewSetting ) : void
must_be_valid_regular_expression ( Simple_Setting NewSetting ) : void
must_end_with ( Simple_Setting NewSetting, string EndsWith ) : void
must_start_end_with ( Simple_Setting NewSetting, string StartsWith, string EndsWith ) : void
must_start_with ( Simple_Setting NewSetting, string StartsWith ) : void
recursively_write_all_endpoints ( Engine_Path_Endpoint RootEndpoint, TextWriter Output, string Url ) : void
save_setting_values ( RequestCache RequestSpecificValues, Settings_Mode_Enum MainMode ) : void
validate_update_entered_data ( List NewValues ) : bool

Method Details

Settings_AdminViewer() public method

Constructor for a new instance of the Thematic_Headings_AdminViewer class
Postback from handling saving the new settings is handled here in the constructor
public Settings_AdminViewer ( RequestCache RequestSpecificValues ) : System
RequestSpecificValues RequestCache All the necessary, non-global data specific to the current request
return System

Write_HTML() public method

Add the HTML to be displayed in the main SobekCM viewer area
This class does nothing, since the themes list is added as controls, not HTML
public Write_HTML ( TextWriter Output, Custom_Tracer Tracer ) : void
Output System.IO.TextWriter Textwriter to write the HTML for this viewer
Tracer SobekCM.Tools.Custom_Tracer Trace object keeps a list of each method executed and important milestones in rendering
return void

Write_ItemNavForm_Closing() public method

This is an opportunity to write HTML directly into the main form, without using the pop-up html form architecture
This text will appear within the ItemNavForm form tags
public Write_ItemNavForm_Closing ( TextWriter Output, Custom_Tracer Tracer ) : void
Output System.IO.TextWriter Textwriter to write the pop-up form HTML for this viewer
Tracer SobekCM.Tools.Custom_Tracer Trace object keeps a list of each method executed and important milestones in rendering
return void