C# Class SobekCM.Library.HTML.abstractHtmlSubwriter

Abstract class which all HTML subwriters must extend. This class contains some of the basic HTML-writing helper values and contains some of the values used by many of the subclasses. HTML subwriters are the top level writing classes employed by the Html_MainWriter.

Datei anzeigen Open project: MarkVSullivan/SobekCM-Web-Application Class Usage Examples

Protected Properties

Property	Type	Description
RequestSpecificValues	RequestCache
emptybehaviors	List

Public Methods

Method	Description
Add_Banner ( TextWriter Output, string Banner_Division_Name, string Web_Page_Title, Navigation_Object CurrentMode, Web_Skin_Object HTML_Skin, Item_Aggregation Hierarchy_Object ) : void	Adds the banner to the response stream from either the html web skin or from the current item aggreagtion object, depending on flags in the web skin object This is called by several html subwriters that otherwise tell this class to suppress writing the banner
Add_Footer ( TextWriter Output ) : void	Add the footer to the output
Add_Header ( TextWriter Output ) : void	Add the header to the output
Write_Additional_HTML ( TextWriter Output, Custom_Tracer Tracer ) : void	Writes additional HTML to the output stream just before the main place holder but after the TocPlaceHolder in the itemNavForm form.
Write_Final_HTML ( TextWriter Output, Custom_Tracer Tracer ) : void	Writes final HTML after all the forms
Write_HTML ( TextWriter Output, Custom_Tracer Tracer ) : bool	Writes the HTML generated by this abstract html subwriter directly to the response stream
Write_Internal_Header_HTML ( TextWriter Output, User_Object Current_User ) : void	Adds the internal header HTML for this specific HTML writer
Write_ItemNavForm_Closing ( TextWriter Output, Custom_Tracer Tracer ) : void	Writes final HTML to the output stream after all the placeholders and just before the itemNavForm is closed.
Write_ItemNavForm_Opening ( TextWriter Output, Custom_Tracer Tracer ) : void	Writes the html to the output stream open the itemNavForm, which appears just before the TocPlaceHolder
Write_Within_HTML_Head ( TextWriter Output, Custom_Tracer Tracer ) : void	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
Get_Browse_Info ( Navigation_Object Current_Mode, Item_Aggregation Aggregation_Object, string Base_Directory, Custom_Tracer Tracer, SobekCM.Core.Aggregations.Item_Aggregation_Child_Page &Browse_Object, SobekCM.Core.Results.Search_Results_Statistics &Complete_Result_Set_Info, List &Paged_Results, HTML_Based_Content &Browse_Info_Display_Text ) : bool	Gets the browse or info object and any other needed data for display ( text to display) This attempts to pull the objects from the cache. If unsuccessful, it builds the objects from the database and hands off to the CachedDataManager to store in the cache
Get_Collection ( Navigation_Object Current_Mode, Custom_Tracer Tracer, Item_Aggregation &Aggregation_Object ) : bool	Gets the item aggregation and search fields for the current item aggregation This attempts to pull the objects from the cache. If unsuccessful, it builds the objects from the database and hands off to the CachedDataManager to store in the cache.
Get_Top_Level_Collection ( Navigation_Object Current_Mode, Custom_Tracer Tracer, Item_Aggregation &Aggregation_Object ) : bool	Gets the item aggregation and search fields for the current item aggregation This attempts to pull the objects from the cache. If unsuccessful, it builds the objects from the database and hands off to the CachedDataManager to store in the cache.
Write_Internal_Header_Search_Box ( TextWriter Output ) : void	Adds the internal header search box to the current output stream
abstractHtmlSubwriter ( RequestCache RequestSpecificValues ) : System	Base constructor

Private Methods

Method	Description
set_web_skin_from_aggregation ( Navigation_Object Current_Mode, Item_Aggregation Aggregation_Object ) : void

Method Details

Add_Banner() public static method

Adds the banner to the response stream from either the html web skin or from the current item aggreagtion object, depending on flags in the web skin object

This is called by several html subwriters that otherwise tell this class to suppress writing the banner

public static Add_Banner ( TextWriter Output, string Banner_Division_Name, string Web_Page_Title, Navigation_Object CurrentMode, Web_Skin_Object HTML_Skin, Item_Aggregation Hierarchy_Object ) : void
Output	System.IO.TextWriter	Stream to which to write the HTML for the banner
Banner_Division_Name	string	Name for the wrapper division around the banner
Web_Page_Title	string	Web page title to add behind the banner image
CurrentMode	SobekCM.Core.Navigation.Navigation_Object	Mode / navigation information for the current request
HTML_Skin	SobekCM.Core.Skins.Web_Skin_Object	HTML Web skin which controls the overall appearance of this digital library
Hierarchy_Object	SobekCM.Core.Aggregations.Item_Aggregation	Current item aggregation object to display
return	void

Add_Footer() public method

Add the footer to the output

public Add_Footer ( TextWriter Output ) : void
Output	System.IO.TextWriter	Stream to which to write the HTML for this footer
return	void

Add_Header() public method

Add the header to the output

public Add_Header ( TextWriter Output ) : void
Output	System.IO.TextWriter	Stream to which to write the HTML for this header
return	void

Get_Browse_Info() protected static method

Gets the browse or info object and any other needed data for display ( text to display)

This attempts to pull the objects from the cache. If unsuccessful, it builds the objects from the database and hands off to the CachedDataManager to store in the cache

protected static Get_Browse_Info ( Navigation_Object Current_Mode, Item_Aggregation Aggregation_Object, string Base_Directory, Custom_Tracer Tracer, SobekCM.Core.Aggregations.Item_Aggregation_Child_Page &Browse_Object, SobekCM.Core.Results.Search_Results_Statistics &Complete_Result_Set_Info, List &Paged_Results, HTML_Based_Content &Browse_Info_Display_Text ) : bool
Current_Mode	SobekCM.Core.Navigation.Navigation_Object	Mode / navigation information for the current request
Aggregation_Object	SobekCM.Core.Aggregations.Item_Aggregation	Item Aggregation object
Base_Directory	string	Base directory location under which the the CMS/info source file will be found
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
Browse_Object	SobekCM.Core.Aggregations.Item_Aggregation_Child_Page	[OUT] Stores all the information about this browse or info
Complete_Result_Set_Info	SobekCM.Core.Results.Search_Results_Statistics	[OUT] Information about the entire set of results
Paged_Results	List	[OUT] List of search results for the requested page of results
Browse_Info_Display_Text	SobekCM.Core.WebContent.HTML_Based_Content	[OUT] Static HTML-based content to be displayed if this is browing a staticly created html source file
return	bool

Get_Collection() protected static method

Gets the item aggregation and search fields for the current item aggregation

This attempts to pull the objects from the cache. If unsuccessful, it builds the objects from the database and hands off to the CachedDataManager to store in the cache.

protected static Get_Collection ( Navigation_Object Current_Mode, Custom_Tracer Tracer, Item_Aggregation &Aggregation_Object ) : bool
Current_Mode	SobekCM.Core.Navigation.Navigation_Object	Mode / navigation information for the current request
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
Aggregation_Object	SobekCM.Core.Aggregations.Item_Aggregation	[OUT] Fully-built object for the current aggregation object
return	bool

Get_Top_Level_Collection() protected static method

Gets the item aggregation and search fields for the current item aggregation

This attempts to pull the objects from the cache. If unsuccessful, it builds the objects from the database and hands off to the CachedDataManager to store in the cache.

protected static Get_Top_Level_Collection ( Navigation_Object Current_Mode, Custom_Tracer Tracer, Item_Aggregation &Aggregation_Object ) : bool
Current_Mode	SobekCM.Core.Navigation.Navigation_Object	Mode / navigation information for the current request
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
Aggregation_Object	SobekCM.Core.Aggregations.Item_Aggregation	[OUT] Fully-built object for the current aggregation object
return	bool

Write_Additional_HTML() public method

Writes additional HTML to the output stream just before the main place holder but after the TocPlaceHolder in the itemNavForm form.

public Write_Additional_HTML ( TextWriter Output, Custom_Tracer Tracer ) : void
Output	System.IO.TextWriter	Stream to directly write to
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	void

Write_Final_HTML() public method

Writes final HTML after all the forms

public Write_Final_HTML ( TextWriter Output, Custom_Tracer Tracer ) : void
Output	System.IO.TextWriter	Stream to directly write to
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

Writes the HTML generated by this abstract html subwriter directly to the response stream

public abstract Write_HTML ( TextWriter Output, Custom_Tracer Tracer ) : bool
Output	System.IO.TextWriter	Stream to which to write the HTML for this subwriter
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Write_Internal_Header_HTML() public method

Adds the internal header HTML for this specific HTML writer

public Write_Internal_Header_HTML ( TextWriter Output, User_Object Current_User ) : void
Output	System.IO.TextWriter	Stream to which to write the HTML for the internal header information
Current_User	SobekCM.Core.Users.User_Object	Currently logged on user, to determine specific rights
return	void

Write_Internal_Header_Search_Box() protected method

Adds the internal header search box to the current output stream

protected Write_Internal_Header_Search_Box ( TextWriter Output ) : void
Output	System.IO.TextWriter	Output stream to write the html for the internal header search box to
return	void

Write_ItemNavForm_Closing() public method

Writes final HTML to the output stream after all the placeholders and just before the itemNavForm is closed.

public Write_ItemNavForm_Closing ( TextWriter Output, Custom_Tracer Tracer ) : void
Output	System.IO.TextWriter	Stream to which to write the text for this main writer
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

Writes the html to the output stream open the itemNavForm, which appears just before the TocPlaceHolder

public Write_ItemNavForm_Opening ( TextWriter Output, Custom_Tracer Tracer ) : void
Output	System.IO.TextWriter	Stream to directly write to
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
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 ) : void
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	void

abstractHtmlSubwriter() protected method

Base constructor

protected abstractHtmlSubwriter ( 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 the information 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