C# Class SobekCM.Library.MySobekViewer.abstract_MySobekViewer

Abstract class which all mySobek viewer classes extend

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. If the action requires authentication, an instance of the MySobek_HtmlSubwriter class is created.
To allow the requested action, the mySobek subwriter will create one of the mySobek viewers( implementing this class )

Inheritance: iMySobek_Admin_Viewer

ファイルを表示 Open project: MarkVSullivan/SobekCM-Web-Application Class Usage Examples

Protected Properties

Property	Type	Description
RequestSpecificValues	RequestCache
emptybehaviors	List

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 No controls are added here, although some children class override this virtual method to add controls
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 No html is added here, although some children class override this virtual method to add pop-up form HTML
Write_HTML ( TextWriter Output, Custom_Tracer Tracer ) : void	Add the HTML to be displayed in the main SobekCM viewer area (outside of any form) Abstract method must be implemented by all extending classes
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
Write_ItemNavForm_Opening ( TextWriter Output, Custom_Tracer Tracer ) : void	This is an opportunity to write HTML directly into the main form before any controls are placed in the main place holder This text will appear within the ItemNavForm form tags
Write_Within_HTML_Head ( TextWriter Output, Custom_Tracer Tracer ) : bool	Write any additional values within the HTML Head of the final served page By default this does nothing, but can be overwritten by all the individual html subwriters

Protected Methods

Method	Description
Write_Item_Type_Top ( TextWriter Output, BriefItemInfo Item ) : void	Writes the top part of the page, mimicing the item viewer
Write_Item_Type_Top ( TextWriter Output, SobekCM_Item Item ) : void	Writes the top part of the page, mimicing the item viewer
abstract_MySobekViewer ( RequestCache RequestSpecificValues ) : System	Constructor for a new instance of the abstract_MySobekViewer class

Method Details

Add_Controls() public method

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

No controls are added here, although some children class override this virtual method to add controls

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	SobekCM.Tools.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

No html is added here, although some children class override this virtual method to add pop-up form HTML

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	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	void

Write_HTML() public abstract method

Add the HTML to be displayed in the main SobekCM viewer area (outside of any form)

Abstract method must be implemented by all extending classes

public abstract 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

Write_ItemNavForm_Opening() public method

This is an opportunity to write HTML directly into the main form before any controls are placed in the main place holder

This text will appear within the ItemNavForm form tags

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

Write_Item_Type_Top() protected method

Writes the top part of the page, mimicing the item viewer

protected Write_Item_Type_Top ( TextWriter Output, BriefItemInfo Item ) : void
Output	System.IO.TextWriter	Stream to write the item-level top to
Item	SobekCM.Core.BriefItem.BriefItemInfo	Item with all the information necessary to write the top
return	void

Write_Item_Type_Top() protected method

Writes the top part of the page, mimicing the item viewer

protected Write_Item_Type_Top ( TextWriter Output, SobekCM_Item Item ) : void
Output	System.IO.TextWriter	Stream to write the item-level top to
Item	SobekCM.Resource_Object.SobekCM_Item	Item with all the information necessary to write the top
return	void

Write_Within_HTML_Head() public method

Write any additional values within the HTML Head of the final served page

By default this does nothing, but can be overwritten by all the individual html subwriters

public Write_Within_HTML_Head ( TextWriter Output, Custom_Tracer Tracer ) : bool
Output	System.IO.TextWriter	Output stream currently within the HTML head tags
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

abstract_MySobekViewer() protected method

Constructor for a new instance of the abstract_MySobekViewer class

protected abstract_MySobekViewer ( RequestCache RequestSpecificValues ) : System
RequestSpecificValues	RequestCache	All the necessary, non-global data specific to the current request
return	System

Property Details

RequestSpecificValues protected_oe property

Protected field contains all the necessary, non-global data specific to the current request

protected RequestCache RequestSpecificValues
return	RequestCache

emptybehaviors protected_oe static_oe property

Empty list of behaviors, returned by default

This just prevents an empty set from having to be created over and over

protected static List emptybehaviors
return	List