C# 클래스 SobekCM.Library.ResultsViewer.abstract_ResultsViewer

Abstract class which implements the iResultsViewer interface and which all subsequent results viewer classes must extend
상속: iResultsViewer
파일 보기 프로젝트 열기: MarkVSullivan/SobekCM-Web-Application

보호된 프로퍼티들

프로퍼티 타입 설명
CurrentUserMask int
PagedResults List
RequestSpecificValues RequestCache
ResultsStats SobekCM.Core.Results.Search_Results_Statistics
Results_Per_Page int

공개 메소드들

메소드 설명
Add_HTML ( System.Web.UI.WebControls.PlaceHolder MainPlaceHolder, Custom_Tracer Tracer ) : void

Adds the controls for this result viewer to the place holder on the main form

StartRow ( int CalculatedLastRow ) : int

Returns the index for the first row to be displayed on the current page, and performs validation against the calculated last row to ensure correctness

보호된 메소드들

메소드 설명
Add_Issue_Tree ( System.Web.UI.WebControls.PlaceHolder MainPlaceHolder, iSearch_Title_Result TitleRow, int CurrentResultRow, string CalculatedTextRedirectStem, string BaseURL ) : void

Builds the tree view control for all the issues related to a single result title and adds the tree view to the provided place holder

This only adds the root node for the tree. Any further computations and tree-creation are left for the tree node populate event when the user requests any issue information.

abstract_ResultsViewer ( RequestCache RequestSpecificValues, SobekCM.Core.Results.Search_Results_Statistics ResultsStats, List PagedResults ) : System

Constructor for a new instance of the abstract_ResultsViewer class

비공개 메소드들

메소드 설명
compute_image_redirect_stem ( ) : string
compute_text_redirect_stem ( ) : string
treeView1_TreeNodePopulate ( object Sender, System.Web.UI.WebControls.TreeNodeEventArgs E ) : void

Event handler loads the nodes on request to the serial hierarchy trees when the user requests them by expanding a node

메소드 상세

Add_HTML() 공개 추상적인 메소드

Adds the controls for this result viewer to the place holder on the main form
public abstract Add_HTML ( System.Web.UI.WebControls.PlaceHolder MainPlaceHolder, Custom_Tracer Tracer ) : void
MainPlaceHolder System.Web.UI.WebControls.PlaceHolder Main place holder ( "mainPlaceHolder" ) in the itemNavForm form into which the the bulk of the result viewer's output is displayed
Tracer SobekCM.Tools.Custom_Tracer Trace object keeps a list of each method executed and important milestones in rendering
리턴 void

Add_Issue_Tree() 보호된 메소드

Builds the tree view control for all the issues related to a single result title and adds the tree view to the provided place holder
This only adds the root node for the tree. Any further computations and tree-creation are left for the tree node populate event when the user requests any issue information.
protected Add_Issue_Tree ( System.Web.UI.WebControls.PlaceHolder MainPlaceHolder, iSearch_Title_Result TitleRow, int CurrentResultRow, string CalculatedTextRedirectStem, string BaseURL ) : void
MainPlaceHolder System.Web.UI.WebControls.PlaceHolder Main place holder ( "mainPlaceHolder" ) in the itemNavForm form into which the results are being built for display
TitleRow iSearch_Title_Result Title row for this title to be displayed, from the dataset of results
CurrentResultRow int Counter indicates which result number this is within the current page of results
CalculatedTextRedirectStem string Redirect string specifically for textual items, which includes the search terms to pass to the final item viewer
BaseURL string Writer-adjusted base_url ( i.e., may include /l at the end if logged in currently )
리턴 void

StartRow() 공개 메소드

Returns the index for the first row to be displayed on the current page, and performs validation against the calculated last row to ensure correctness
public StartRow ( int CalculatedLastRow ) : int
CalculatedLastRow int Calculated last row to be displayed, to be used for validation purposes
리턴 int

abstract_ResultsViewer() 보호된 메소드

Constructor for a new instance of the abstract_ResultsViewer class
protected abstract_ResultsViewer ( RequestCache RequestSpecificValues, SobekCM.Core.Results.Search_Results_Statistics ResultsStats, List PagedResults ) : System
RequestSpecificValues RequestCache All the necessary, non-global data specific to the current request
ResultsStats SobekCM.Core.Results.Search_Results_Statistics Statistics about the results to display including the facets
PagedResults List Actual pages of results
리턴 System

프로퍼티 상세

CurrentUserMask 보호되어 있는 프로퍼티

Protected field contains the current user IP restriction mask, used to determine if this use has access to IP restricted items
protected int CurrentUserMask
리턴 int

PagedResults 보호되어 있는 프로퍼티

protected List PagedResults
리턴 List

RequestSpecificValues 보호되어 있는 프로퍼티

Values specific to the current HTML request
protected RequestCache RequestSpecificValues
리턴 RequestCache

ResultsStats 보호되어 있는 프로퍼티

protected Search_Results_Statistics,SobekCM.Core.Results ResultsStats
리턴 SobekCM.Core.Results.Search_Results_Statistics

Results_Per_Page 보호되어 있는 프로퍼티

Number of results included in each page of results
protected int Results_Per_Page
리턴 int