C# Class SobekCM.Library.MySobekViewer.Folder_Mgmt_MySobekViewer

Class allows an authenticated user to view the items and searches in their bookshelves (or folders) online

This class extends the abstract_MySobekViewer 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.Application_State_Builder
Request is analyzed by the Navigation.SobekCM_QueryString_Analyzer and output as a SobekCM_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 display the list of items in each bookshelf or the list of bookshelves
This viewer uses the PagedResults_HtmlSubwriter class to display the items just like any search or browse on SobekCM

Inheritance: abstract_MySobekViewer

Mostra file Open project: MarkVSullivan/SobekCM-Web-Application

Public Methods

Method	Description
Add_Controls ( System.Web.UI.WebControls.PlaceHolder MainPlaceHolder, Custom_Tracer Tracer ) : void	Add controls directly to the form in the main control area placeholder The PagedResults_HtmlSubwriter class is instantiated and adds controls to the placeholder here
Add_Popup_HTML ( TextWriter Output, Custom_Tracer Tracer ) : void	Add the HTML to be added near the top of the page for those viewers that implement pop-up forms for data retrieval This adds any popup divisions for form metadata elements
Folder_Mgmt_MySobekViewer ( RequestCache RequestSpecificValues ) : System	Constructor for a new instance of the Folder_Mgmt_MySobekViewer class
Write_HTML ( TextWriter Output, Custom_Tracer Tracer ) : void	Add the HTML to be displayed in the main SobekCM viewer area

Private Methods

Method	Description
add_children_nodes ( System.Web.UI.WebControls.TreeNode ParentNode, SobekCM.Library.Users.User_Folder ThisFolder, string SelectedFolder, string RedirectURL, List SelectedNodes ) : void
refresh_user_folders ( SobekCM.Library.Users.User_Object User, Custom_Tracer Tracer ) : void

Method Details

Add_Controls() public method

Add controls directly to the form in the main control area placeholder

The PagedResults_HtmlSubwriter class is instantiated and adds controls to the placeholder here

public Add_Controls ( System.Web.UI.WebControls.PlaceHolder MainPlaceHolder, Custom_Tracer Tracer ) : void
MainPlaceHolder	System.Web.UI.WebControls.PlaceHolder	Main place holder to which all main controls are added
Tracer	Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	void

Add_Popup_HTML() public method

Add the HTML to be added near the top of the page for those viewers that implement pop-up forms for data retrieval

This adds any popup divisions for form metadata elements

public Add_Popup_HTML ( TextWriter Output, Custom_Tracer Tracer ) : void
Output	System.IO.TextWriter	Textwriter to write the pop-up form HTML for this viewer
Tracer	Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	void

Folder_Mgmt_MySobekViewer() public method

Constructor for a new instance of the Folder_Mgmt_MySobekViewer class

public Folder_Mgmt_MySobekViewer ( 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

public Write_HTML ( TextWriter Output, Custom_Tracer Tracer ) : void
Output	System.IO.TextWriter	Textwriter to write the HTML for this viewer
Tracer	Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	void