TJamFileList Class

Component for listing files from different folders and for performing a file search.

Class Hierarchy

Syntax

Pascal

TJamFileList = class(TJamCustomFileList, IThumbnailViewer);

File

JAMControls

Remarks

TJamFileList can be used to list files and folders from different directories in one list. You can use the Add method to add files or folders to the list.

Additionally file multithreaded searches similar to the Windows file search can be performed. The settings of the search can be controlled using the SearchOptions property, the search can be started using the Search method and will be performed in an own thread.

Public Methods

TJamBaseShellListView Class

	Name	Description
	Create	Creates an instances of a TJamBaseShellListView component
	Destroy	Destroys an instance of a TJamBaseShellListView component

TJamCustomFileList Class

	Name	Description
	Create	Constructor of an instances of a TJamCustomFileList component
	Destroy	Destructor of an instances of a TJamCustomFileList component

TJamFileList Class

	Name	Description
	Create	Creates an instance of a TJamFileList component
	Destroy	Destroys an instance of a TJamFileList component

public

	Name	Description
	SetThumbnailBitmap	This is SetThumbnailBitmap, a member of class IThumbnailViewer.

ICheckBoxViewer Interface

	Name	Description
	ApplyCheckState	This is ApplyCheckState, a member of class ICheckBoxViewer.

IIconViewer Interface

	Name	Description
	SetIcon	This is SetIcon, a member of class IIconViewer.

IPathExistsViewer Interface

	Name	Description
	UpdateItemAfterCheck	This is UpdateItemAfterCheck, a member of class IPathExistsViewer.

IJamShellControl Interface

	Name	Description
	ShellLink	The TJamShellLink instance to which the current control connected.
	FileChanged	This method is called by the ShellLink instance if the currently selected item has changed.
	FullRefresh	This method indicates that the callee should perform a full refresh of its contents. This will usually be an entrie reload of the displyed items.
	getShellLink	Setter method for the ShellLink property.
	GoUp	This method indicates that the callee should go up one level and siplay the contents of the current folder's parent folder.
	PathChanged	This method is called by the ShellLink instance if the currently displayed folder has changed.
	SelectAll	This method indicates that the callee should select all item it currently displays.
	setShellLink	Getter method for the ShellLink property.
	SmartRefresh	This method indicates that the callee should perform a quick refresh of its contents. It is tolerable that changes in metadata are not detected. Removed and deleted items hsould be detected. The runtime of this method should be significantly faster thatn the one of the FullRefresh method.

TJamBaseShellListView Class

	Name	Description
	AutoSizeColumn	This has to be overwritten by the deriving class. Adjust the size of the given column so that it fills the remaining horizontal space.
	DoubleBuffered	Determines whether the control's image is rendered directly to the window or painted to an in-memory bitmap first.
	AutoAdjustColumnWidths	Auto adjust the widths of all columns.
	GetColumnOrderArray	Use this function to get an Array of Integers that contains the internal order of the columns. This is helpful if you changed the order during runtime and e.g. want to fill the subitems.
	GetColumnPosition	Returns the current column index for a given SHColumnId.
	GetDragImages	This is GetDragImages, a member of class TJamBaseShellListView.
	GetVisibleColumns	Use this function to get an array of currently visible columns.
	IsColumnVisible	Returns whether the given SHColumnId is currently visible or not.
	SetColumnVisibility	Set the visibility of a column.
	ShowBackgroundMenu	This has to be overwritten by the deriving class.
	ShowContextMenu	This is ShowContextMenu, a member of class TJamBaseShellListView.

TJamCustomFileList Class

	Name	Description
	Columns	Gets the collection of all column headers that appear in the control.
	Items	Contains the list of items displayed by the list view.
	Paths	Returns a list with the full paths of all items.
	ReverseSortOrder	Indicates if sort order is normal or reverse.
	SelCount	Specifies the number of selected items in the list view.
	Selected	Returns the index of the selected item.
	SelectedPath	Returns the full path for the selected item.
	SelectedPaths	Returns a list with the full paths for the selected items.
	SortColumn	The column according to which the listed objects are sorted.
	Add	This is Add, a member of class TJamCustomFileList.
	AddStrings	Add a list object to the list.
	CheckAll	Checks all items in the list
	Clear	Removes all items from the FileList
	DeleteItem	Removes an item from the list view and frees the associated memory.
	FullRefresh	Refreshes all connected controls.
	GetFullPath	Use this function to get the full path of an item of the list.
	InvokeContextMenuCommand	Executes a command of the context menu of the current object.
	IsItemInList	Checks whether an item with the given filename can be found in the list.
	ReturnItemInList	Returns the item that is associated to the filename, if it is in the list, otherwise nil.
	SelectAll	Selects all items of the list.
	ShowContextMenu	Show the context menu for the selected items.
	SmartRefresh	Pereforms a quick refresh.
	UnCheckAll	Sets the Checked state of all Items to "unchecked" (false).

TJamFileList Class

	Name	Description
	SelectedFileCount	Returns the count of the selected files.
	SelectedFileSize	Returns the size of the selected files.
	TotalFileCount	Returns the count of all files.
	TotalFileSize	Returns the size of all files.
	Add	With this function you can add a file or folder to the list.
	CreateWnd	This is CreateWnd, a member of class TJamFileList.
	GetColumnPosition	Returns the index for the given TShColumnId.
	Search	Starts the search for files.
	SetColumnVisibility	Set the visibility of a column.
	Stop	Call this method to stop the file search in the assigned path.

published

TJamBaseShellListView Class

	Name	Description
	IconSpacing	Let's you control the spacing between the large icons and thumbnails. The small icons should not be affected by this property.
	OnCreateColumns	This event is triggered after the columns were created
	ParentFont	This is ParentFont, a member of class TJamBaseShellListView.
	ReadOnly	Prevents operations that change the file system from being executed.
	ShellContextMenu	Automatically display the shell context menu.
	UseSystemStyles	Use the same styles as the Windows Explorer.
	Version	The version number of the ShellBrower controls.

TJamCustomFileList Class

	Name	Description
	Align	Gets or sets the alignment of items in the control.
	Anchors	Gets or sets the edges of the container to which a control is bound and determines how a control is resized with its parent.
	BorderStyle	Gets or sets the border style of the control.
	Checkboxes	Turns on/off checkboxes for file and folder selection.
	Color	Specifies the background color of the control.
	Constraints	This is Constraints, a member of class TJamCustomFileList.
	Ctl3D	This is Ctl3D, a member of class TJamCustomFileList.
	Details	Choose if details of the listed objects should be shown.
	DragCursor	This is DragCursor, a member of class TJamCustomFileList.
	DragKind	This is DragKind, a member of class TJamCustomFileList.
	DragMode	This is DragMode, a member of class TJamCustomFileList.
	Enabled	Controls whether the control responds to mouse, keyboard, and timer events.
	FlatScrollBars	Specifies whether the list view's scroll bars are flat.
	Font	Controls the attributes of text written on or in the control. Make sure to turn off UseSystemFont before editing this control! Otherwise the changes will not persist.
	FullDrag	Specifies whether headers are repainted when they are dragged.
	GridLines	Determines whether grid lines appear between the rows and columns containing the items and subitems in the control.
	HideSelection	Determines whether the list view gives a visual indication of which item is selected when focus shifts to another control.
	Hint	This is Hint, a member of class TJamCustomFileList.
	HotTrack	Specifies whether list items are highlighted when the mouse passes over them.
	IconOptions	This is IconOptions, a member of class TJamCustomFileList.
	ImeMode	Gets or sets the Input Method Editor (IME) mode of the control.
	ImeName	This is ImeName, a member of class TJamCustomFileList.
	MultiSelect	Determines whether the user can select more than one list item at a time.
	OleDragDrop	Allow drag and drop operations with the Explorer.
	OnAddItem	This event is fired if a file is to be added to the listview.
	OnAddPath	OnAddPath occurs, whenever a new path is added to the listview.
	OnAdvancedCustomDraw	This is OnAdvancedCustomDraw, a member of class TJamCustomFileList.
	OnAdvancedCustomDrawItem	This is OnAdvancedCustomDrawItem, a member of class TJamCustomFileList.
	OnAdvancedCustomDrawSubItem	This is OnAdvancedCustomDrawSubItem, a member of class TJamCustomFileList.
	OnBeforeShellCommand	This event occurs, before a context menu command is executed.
	OnBeforeShellDrop	Allows you to prevent unwanted shell drops.
	OnChange	This is OnChange, a member of class TJamCustomFileList.
	OnChanging	This is OnChanging, a member of class TJamCustomFileList.
	OnCheckStateChanged	This event is fired, if the state of a checkbox was changed by the user.
	OnClick	Occurs when the user clicks the control.
	OnColumnClick	This is OnColumnClick, a member of class TJamCustomFileList.
	OnColumnDragged	Occurs when a column is dragged to a new position.
	OnColumnRightClick	This is OnColumnRightClick, a member of class TJamCustomFileList.
	OnCompare	This is OnCompare, a member of class TJamCustomFileList.
	OnContextPopup	This is OnContextPopup, a member of class TJamCustomFileList.
	OnCustomDraw	This is OnCustomDraw, a member of class TJamCustomFileList.
	OnCustomDrawItem	This is OnCustomDrawItem, a member of class TJamCustomFileList.
	OnCustomDrawSubItem	This is OnCustomDrawSubItem, a member of class TJamCustomFileList.
	OnDblClick	Occurs when the user double-clicks the left mouse button when the mouse pointer is over the control.
	OnDeletion	This is OnDeletion, a member of class TJamCustomFileList.
	OnDragDrop	This is OnDragDrop, a member of class TJamCustomFileList.
	OnDragOver	This is OnDragOver, a member of class TJamCustomFileList.
	OnDrawItem	This is OnDrawItem, a member of class TJamCustomFileList.
	OnEdited	This is OnEdited, a member of class TJamCustomFileList.
	OnEditing	This is OnEditing, a member of class TJamCustomFileList.
	OnEndDock	This is OnEndDock, a member of class TJamCustomFileList.
	OnEndDrag	This is OnEndDrag, a member of class TJamCustomFileList.
	OnEnter	This is OnEnter, a member of class TJamCustomFileList.
	OnExit	This is OnExit, a member of class TJamCustomFileList.
	OnGetImageIndex	This is OnGetImageIndex, a member of class TJamCustomFileList.
	OnInfoTip	This is OnInfoTip, a member of class TJamCustomFileList.
	OnInsert	This is OnInsert, a member of class TJamCustomFileList.
	OnKeyDown	Occurs when a user presses any key while the control has focus.
	OnKeyPress	Occurs when key pressed.
	OnKeyUp	Occurs when a user presses any key while the control has focus.
	OnMouseDown	This is OnMouseDown, a member of class TJamCustomFileList.
	OnMouseEnter	Occurs when the mouse pointer moves over the control.
	OnMouseLeave	Occurs when the mouse pointer moves off from over the control.
	OnMouseMove	This is OnMouseMove, a member of class TJamCustomFileList.
	OnMouseUp	This is OnMouseUp, a member of class TJamCustomFileList.
	OnOperation	The OnOperation event occurs after a shell operation like pasting or dragging and dropping files was performed.
	OnResize	Occurs immediately after the control is resized.
	OnSelectItem	This is OnSelectItem, a member of class TJamCustomFileList.
	OnStartDock	This is OnStartDock, a member of class TJamCustomFileList.
	OnStartDrag	This is OnStartDrag, a member of class TJamCustomFileList.
	ParentColor	This is ParentColor, a member of class TJamCustomFileList.
	ParentCtl3D	This is ParentCtl3D, a member of class TJamCustomFileList.
	ParentShowHint	This is ParentShowHint, a member of class TJamCustomFileList.
	PopupMenu	This is PopupMenu, a member of class TJamCustomFileList.
	RowSelect	Determines whether an entire row in the list view can be selected.
	ScrollBars	Determines whether the JamFileList control has scroll bars.
	ShowColumnHeaders	Determines whether the column headers are displayed.
	ShowHint	This is ShowHint, a member of class TJamCustomFileList.
	ShowOverlayIcons	If set to false, no overlay icons will be shown, which improves the performance of the control.
	StateImages	This is StateImages, a member of class TJamCustomFileList.
	TabOrder	This is TabOrder, a member of class TJamCustomFileList.
	TabStop	This is TabStop, a member of class TJamCustomFileList.
	UseSystemFont	Set this property to true if you want the component to utilize the default system font.
	Visible	Determines whether the component appears onscreen.

TJamFileList Class

	Name	Description
	AllowDropToBackground	If this property is set to true, the user is allowed to drop items onto the background in order to add them to the displayed list of files.
	AllowDuplicates	This is AllowDuplicates, a member of class TJamFileList.
	AutomaticRefresh	Receives notifications about changes in the shell and performs refreshes automatically.
	AutoSizeColumn	This has to be overwritten by the deriving class. Adjust the size of the given column so that it fills the remaining horizontal space.
	CheckIfExists	Offers the possibility to add files and folders, which do not exist in the file system.
	CopyMode	Use CopyMode to control the Drag'n'Drop behaviour.
	DoubleBuffered	Determines whether the control's image is rendered directly to the window or painted to an in-memory bitmap first.
	IconsBasedOnFileExtension	If set to true, Icons will be determined based on their file extensions only. This is usually faster, in certains cases like EXE files the icons will differ from those shown in Windows Explorer.
	OnCanResize	This is OnCanResize, a member of class TJamFileList.
	OnEndSearch	The OnEndSearch event occurs when a search is completed.
	OnSearchProgress	The OnSearchProgress event occurs during a file search for each file.
	OnThumbnailUpdated	The OnThumbnailUpdated event occurs, when a thumbnail is updated.
	ParentDoubleBuffered	This is ParentDoubleBuffered, a member of class TJamFileList.
	SearchOptions	Collection of search details.
	ShellLink	Connects this component to a TJamShellLink in order to synchronize several shell controls.
	ShowExtraLargeIcons	Shows extra large icons.
	ShowJumboIcons	Shows jumbo icons.
	ThumbnailBorderColor	Specifies the background color of the control.
	ThumbnailHeight	Indicates the vertical size (in pixels) of the jpeg image.
	Thumbnails	Switches the thumbnail mode on and off.
	ThumbnailWidth	Indicates the horizontal size (in pixels) of the jpeg image.
	ViewStyle	Determines how the list items are displayed.

Links

Members, public, published

Contents | Index | Home