C# Class SobekCM.Library.ItemViewer.ItemViewer_Factory

Static class is a factory that generates and returns the requested item viewer object which extends the SobekCM.Library.ItemViewer.Viewers.abstractItemViewer class.

显示文件 Open project: MarkVSullivan/SobekCM-Web-Application

Public Methods

Method	Description
Clear ( ) : void	Clears the dictionaries of item viewer prototypes, used when the cache is reset either manually or automatically
Configure_Brief_Item_Viewers ( BriefItemInfo BriefItem ) : void	Configure the viewers for a single brief item to match this user interface settings
Get_Item_Viewer ( BriefItemInfo CurrentItem, string ViewerCode ) : iItemViewerPrototyper	Gets the appropriate item viewer prototyper ( SobekCM.Library.ItemViewer.Viewer.iItemViewerPriority ) class for an individual item, based on the requested viewer code
Get_Viewer_By_ViewType ( string ViewType ) : iItemViewerPrototyper	Accepts a view type (string) from the digital resource object and returns the appropriate item viewer object which extends the SobekCM.Library.ItemViewer.Viewer.iItemViewerPriority class for rendering items to the web via HTML.
Get_Viewer_By_ViewerCode ( string ViewerCode ) : iItemViewerPrototyper	Accepts a viewer code (string) from the digital resource object and returns the appropriate item viewer object which extends the SobekCM.Library.ItemViewer.Viewer.iItemViewerPriority class for rendering items to the web via HTML.
ViewCode_From_ViewType ( string ViewType ) : string	Gets the viewer code (used in URLs and such) for a specific view type, or NULL if the current instance doesn't support that viewer type
ViewType_From_ViewerCode ( string ViewerCode ) : string	Gets the standard viewer type from a viewer code, or NULL if the current instance doesn't support that viewer code

Private Methods

Method	Description
configureItemViewers ( ) : void
configurePrototyper ( string assembly, string className ) : iItemViewerPrototyper

Method Details

Clear() public static method

Clears the dictionaries of item viewer prototypes, used when the cache is reset either manually or automatically

public static Clear ( ) : void
return	void

Configure_Brief_Item_Viewers() public static method

Configure the viewers for a single brief item to match this user interface settings

public static Configure_Brief_Item_Viewers ( BriefItemInfo BriefItem ) : void
BriefItem	BriefItemInfo	Brief item to adjust selected viewers
return	void

Get_Item_Viewer() public static method

Gets the appropriate item viewer prototyper ( SobekCM.Library.ItemViewer.Viewer.iItemViewerPriority ) class for an individual item, based on the requested viewer code

public static Get_Item_Viewer ( BriefItemInfo CurrentItem, string ViewerCode ) : iItemViewerPrototyper
CurrentItem	BriefItemInfo	The current item.
ViewerCode	string	The viewer code.
return	iItemViewerPrototyper

Get_Viewer_By_ViewType() public static method

Accepts a view type (string) from the digital resource object and returns the appropriate item viewer object which extends the SobekCM.Library.ItemViewer.Viewer.iItemViewerPriority class for rendering items to the web via HTML.

public static Get_Viewer_By_ViewType ( string ViewType ) : iItemViewerPrototyper
ViewType	string	Viewer code to retrieve
return	iItemViewerPrototyper

Get_Viewer_By_ViewerCode() public static method

Accepts a viewer code (string) from the digital resource object and returns the appropriate item viewer object which extends the SobekCM.Library.ItemViewer.Viewer.iItemViewerPriority class for rendering items to the web via HTML.

public static Get_Viewer_By_ViewerCode ( string ViewerCode ) : iItemViewerPrototyper
ViewerCode	string	Viewer code to retrieve
return	iItemViewerPrototyper

ViewCode_From_ViewType() public static method

Gets the viewer code (used in URLs and such) for a specific view type, or NULL if the current instance doesn't support that viewer type

public static ViewCode_From_ViewType ( string ViewType ) : string
ViewType	string	Standard type of the viewer to find
return	string

ViewType_From_ViewerCode() public static method

Gets the standard viewer type from a viewer code, or NULL if the current instance doesn't support that viewer code

public static ViewType_From_ViewerCode ( string ViewerCode ) : string
ViewerCode	string	Viewer code to look for viewer
return	string