C# 클래스 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 )
상속: iMySobek_Admin_Viewer
파일 보기 프로젝트 열기: MarkVSullivan/SobekCM-Web-Application 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
RequestSpecificValues RequestCache
emptybehaviors List

공개 메소드들

메소드 설명
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

보호된 메소드들

메소드 설명
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

메소드 상세

Add_Controls() 공개 메소드

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
리턴 void

Add_Popup_HTML() 공개 메소드

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
리턴 void

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

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
리턴 void

Write_ItemNavForm_Closing() 공개 메소드

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
리턴 void

Write_ItemNavForm_Opening() 공개 메소드

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
리턴 void

Write_Item_Type_Top() 보호된 메소드

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
리턴 void

Write_Item_Type_Top() 보호된 메소드

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
리턴 void

Write_Within_HTML_Head() 공개 메소드

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
리턴 bool

abstract_MySobekViewer() 보호된 메소드

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
리턴 System

프로퍼티 상세

RequestSpecificValues 보호되어 있는 프로퍼티

Protected field contains all the necessary, non-global data specific to the current request
protected RequestCache RequestSpecificValues
리턴 RequestCache

emptybehaviors 보호되어 있는 정적으로 프로퍼티

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
리턴 List