C# Class SobekCM.Library.AggregationViewer.Viewers.abstractAggregationViewer

Abstract class which all collection viewer classes extend

This class implements the iAggregationViewer interface.

Collection viewers are used when displaying collection home pages, searches, browses, and information pages.

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. For a collection-level request, an instance of the Aggregation_HtmlSubwriter class is created.
To display the requested collection view, the collection subwriter will create one or more collection viewers ( implementing this class )

Inheritance: iAggregationViewer

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

Protected Properties

Property	Type	Description
RequestSpecificValues	RequestCache
ViewBag	AggregationViewBag
emptybehaviors	List

Public Methods

Method	Description
Add_Search_Box_HTML ( TextWriter Output, Custom_Tracer Tracer ) : void	Add the HTML to be displayed in the search box
Add_Secondary_Controls ( System.Web.UI.WebControls.PlaceHolder MainPlaceHolder, Custom_Tracer Tracer ) : void	Add the HTML and controls to the section below the search box No controls are added here, although some children class override this virtual method to add controls
Add_Secondary_HTML ( TextWriter Output, Custom_Tracer Tracer ) : void	Add the HTML to be displayed below the search box No html is added here, although some children class override this virtual method to add HTML

Protected Methods

Method	Description
Add_Simple_Search_Tips ( TextWriter Output, Custom_Tracer Tracer ) : void	Writes the simple search tips out to the HTTP text writer
abstractAggregationViewer ( RequestCache RequestSpecificValues, AggregationViewBag ViewBag ) : System.Collections.Generic	Constructor for objects which implement this abstract class

Method Details

Add_Search_Box_HTML() public abstract method

Add the HTML to be displayed in the search box

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

Add_Secondary_Controls() public method

Add the HTML and controls to the section below the search box

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

public Add_Secondary_Controls ( System.Web.UI.WebControls.PlaceHolder MainPlaceHolder, Custom_Tracer Tracer ) : void
MainPlaceHolder	System.Web.UI.WebControls.PlaceHolder	Place holder to add html and controls to
Tracer	Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	void

Add_Secondary_HTML() public method

Add the HTML to be displayed below the search box

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

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

Add_Simple_Search_Tips() protected method

Writes the simple search tips out to the HTTP text writer

protected Add_Simple_Search_Tips ( TextWriter Output, Custom_Tracer Tracer ) : void
Output	System.IO.TextWriter	TextWriter writes to the HTTP Response stream
Tracer	Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	void

abstractAggregationViewer() protected method

Constructor for objects which implement this abstract class

protected abstractAggregationViewer ( RequestCache RequestSpecificValues, AggregationViewBag ViewBag ) : System.Collections.Generic
RequestSpecificValues	RequestCache	All the necessary, non-global data specific to the current request
ViewBag	AggregationViewBag	Aggregation-specific request information, such as aggregation object and any browse object requested
return	System.Collections.Generic

Property Details

RequestSpecificValues protected_oe property

Protected field contains the information specific to the current request

protected RequestCache RequestSpecificValues
return	RequestCache

ViewBag protected_oe property

Protected field contains the aggregation-specific request information

protected AggregationViewBag ViewBag
return	AggregationViewBag

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