C# Class ACAT.Extensions.Default.FunctionalAgents.FileBrowserAgent.FileBrowserScanner

Datei anzeigen Open project: brlima94/acat-localization Class Usage Examples

Public Methods

Method	Description
CheckWidgetEnabled ( CheckEnabledArgs arg ) : bool	Invoked to check if a scanner button should be enabled. Uses context to determine the 'enabled' state.
ClearFilter ( ) : void	Clears the search filter
FileBrowserScanner ( ) : System	Initializes a new instance of the class.
GetInvoker ( ) : ExtensionInvoker	Returns the extension invoker object
Initialize ( StartupArg startupArg ) : bool	Initializes the class
IsFilterEmpty ( ) : bool	Returns if there is a search filter
OnFocusChanged ( WindowActivityMonitorInfo monitorInfo ) : void	Not used
OnPause ( ) : void	Pauses scanning
OnQueryPanelChange ( PanelRequestEventArgs eventArg ) : bool	not needed
OnResume ( ) : void	Resumes scanning
OnRunCommand ( string command, bool &handled ) : void	Not used
OnWidgetActuated ( Widget widget, bool &handled ) : void	Invoked when the user makes a selection
SetTargetControl ( Form parent, Widget widget ) : void	Not needed
createStatusBar ( ) : void	Creates a status bar for the scanner
sanitizeFileExtensions ( String extensions ) : void	Normalizes the file extension, check for period etc.

Protected Methods

Method	Description
Dispose ( bool disposing ) : void	Clean up any resources being used.
OnFormClosing ( FormClosingEventArgs e ) : void	Clean up

Private Methods

Method	Description
FileBrowserScanner_FormClosing ( object sender, FormClosingEventArgs e ) : void	Release resources and stop threads/timers
FileBrowserScanner_KeyDown ( object sender, KeyEventArgs e ) : void	Key down handler
FileBrowserScanner_Load ( object sender, EventArgs e ) : void	The form has loaded. Initialze it.
FileBrowserScanner_LocationChanged ( object sender, EventArgs e ) : void	IF there is an alphabet scanner, keep it docked with this form
FileBrowserScanner_Shown ( object sender, EventArgs e ) : void	Set focus to this scanner
InitializeComponent ( ) : void	Required method for Designer support - do not modify the contents of this method with the code editor.
Instance_EvtScannerClosed ( object sender, ScannerCloseEventArg arg ) : void	Event handler for when a scanner closes. Reposition this scanner to its default position
Instance_EvtScannerShow ( object sender, ScannerShowEventArg arg ) : void	Invoked when the companian scanner is shown. Dock this scanner with the companian.
SearchFilter_TextChanged ( object sender, EventArgs e ) : void	The search filter changed. Reload the file list
SortOrderIcon_Click ( object sender, EventArgs e ) : void	User click on the button to resort
WndProc ( Message &m ) : void
_keyboardActuator_EvtKeyPress ( object sender, KeyPressEventArgs e ) : void	Key press handler. Process the ESC key to quit
actuateWidget ( Widget widget, bool &handled ) : void	Actuates a widget - performs associated action
dockToScanner ( Form scanner ) : void	Docks this scanner to the companian scanner
enableWatchdogs ( ) : void	Make sure the scanner stays focused
filterFiles ( List fileList, String includeExtension, String excludeExtension, String filter ) : List	Filter files based on the extensions to include and exclude
getAllFiles ( String folders, SortOrder order ) : List	Get all the files from the specified folders. Sort them depending on the current sort order
getFileOperationFromUser ( FileInfo fileInfo ) : FileOperation	Prompt the user to make a selection on what to do with the selected file. Open it or delete it.
getMeasuredString ( Graphics graphics, Font font, int width, String inputString ) : String	Returns string that graphically fits into the specified width. If it doesn't, curtails the string and adds ellipses
gotoNextPage ( ) : void	Display the next pageful of files
gotoPreviousPage ( ) : void	Display the previous pageful of files
handleDeleteFile ( FileInfo fileInfo ) : void	Delete the file
handleFileOperation ( FileOperation operation, FileInfo fileInfo ) : void	Perform action on the file
handleWidgetSelection ( Widget widget, bool &handled ) : void	Handle actuation of a widget - navigate, select file etc depending on what the widget represents
highlightOff ( ) : void	Turn all highlighting off
includeFile ( FileInfo fileInfo, String includeExtension, String excludeExtension, String filter ) : bool	Checks whether the specifed file should be selected or not
loadFiles ( ) : void	Look at filters, load files from the specified folders
onFileSelected ( FileInfo fileInfo ) : bool	User selected a file from the list. If reqd, ask the user if she wants to open or delete the file
refreshFileList ( ) : void	Refreshes the list of files in the UI
removeWatchdogs ( ) : void	Remove all the watchdogs
setFormStyles ( CreateParams createParams ) : CreateParams	Set the style of the form
subscribeToEvents ( ) : void	Subscribes to the various events
switchSortOrder ( ) : void	Resort the file list and refresh it in the display
updateButtonBar ( ) : void	Updates the icons in the button bar depending on the context
updateStatusBar ( ) : void	Updates the status bar with the current sort order

Method Details

CheckWidgetEnabled() public method

Invoked to check if a scanner button should be enabled. Uses context to determine the 'enabled' state.

public CheckWidgetEnabled ( CheckEnabledArgs arg ) : bool
arg	CheckEnabledArgs	info about the scanner button
return	bool

ClearFilter() public method

Clears the search filter

public ClearFilter ( ) : void
return	void

Dispose() protected method

Clean up any resources being used.

protected Dispose ( bool disposing ) : void
disposing	bool	true if managed resources should be disposed; otherwise, false.
return	void

FileBrowserScanner() public method

Initializes a new instance of the class.

public FileBrowserScanner ( ) : System
return	System

GetInvoker() public method

Returns the extension invoker object

public GetInvoker ( ) : ExtensionInvoker
return	ExtensionInvoker

Initialize() public method

Initializes the class

public Initialize ( StartupArg startupArg ) : bool
startupArg	StartupArg	arguments
return	bool

IsFilterEmpty() public method

Returns if there is a search filter

public IsFilterEmpty ( ) : bool
return	bool

OnFocusChanged() public method

Not used

public OnFocusChanged ( WindowActivityMonitorInfo monitorInfo ) : void
monitorInfo	WindowActivityMonitorInfo	Info about focused element
return	void

OnFormClosing() protected method

Clean up

protected OnFormClosing ( FormClosingEventArgs e ) : void
e	FormClosingEventArgs	event args
return	void

OnPause() public method

Pauses scanning

public OnPause ( ) : void
return	void

OnQueryPanelChange() public method

not needed

public OnQueryPanelChange ( PanelRequestEventArgs eventArg ) : bool
eventArg	PanelRequestEventArgs	arg
return	bool

OnResume() public method

Resumes scanning

public OnResume ( ) : void
return	void

OnRunCommand() public method

Not used

public OnRunCommand ( string command, bool &handled ) : void
command	string
handled	bool
return	void

OnWidgetActuated() public method

Invoked when the user makes a selection

public OnWidgetActuated ( Widget widget, bool &handled ) : void
widget	Widget	widget selected
handled	bool	was it handled?
return	void

SetTargetControl() public method

Not needed

public SetTargetControl ( Form parent, Widget widget ) : void
parent	Form
widget	Widget
return	void

createStatusBar() public method

Creates a status bar for the scanner

public createStatusBar ( ) : void
return	void

sanitizeFileExtensions() public method

Normalizes the file extension, check for period etc.

public sanitizeFileExtensions ( String extensions ) : void
extensions	String	list of extensions
return	void