Changes between Initial Version and Version 1 of Public/Docs/CinnamonClientContentsTabControls


Ignore:
Timestamp:
Sep 11, 2019, 10:15:30 AM (2 years ago)
Author:
Administrator
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • Public/Docs/CinnamonClientContentsTabControls

    v1 v1  
     1= The contents tab controls
     2There are several tab controls that show lists of content - the files and subfolders in a folder, search results or the folders directly in the session context.
     3
     4They all internally use the same specialized list view control to display the actual content lists, and thus, their configuration is quite similar.
     5
     6The following example shows the configuration of the folder contents control:
     7
     8{{{
     9<tab_control assembly="CinnamonEnterpriseClient" type="ContentsFolderControl" display="tree">
     10  <!-- tab_control may have the values for display: tree, list, all -->
     11  <custom>
     12    <node_data_provider assembly="CinnamonEnterpriseClient" type="DefaultNodeDataProvider" />
     13    <filters default="trunk">
     14      <filter assembly="CinnamonEnterpriseClient" type="AllVersionsFilter" />
     15      <filter assembly="CinnamonEnterpriseClient" type="LatestTrunkVersionsFilter" />
     16      <filter assembly="CinnamonEnterpriseClient" type="LatestBranchVersionsFilter" />
     17    </filters>
     18    <columns>
     19      <!-- currently supported: name, id, format, type, size, owner, locked, lifecycle, path -->
     20      <list_view_column type="name" width="200" sort="ascending" />
     21      <!-- name  must always be first column -->
     22      <list_view_column type="version" width="50" />
     23      <list_view_column type="format" width="50" />
     24      <list_view_column class="custom" type="revision" label="Revision" width="50" />
     25      <list_view_column type="lifecycle" width="80" />
     26      <list_view_column type="owner" width="80" />
     27      <list_view_column type="modifier" width="80" />
     28      <!--<list_view_column class="custom" type="author" label="Author" width="100" />-->
     29      <list_view_column class="custom" type="document_type" label="Document type" width="100" />
     30      <list_view_column class="custom" type="region" label="Region" width="100" />
     31      <list_view_column class="custom" type="model" label="Model" width="300" />
     32      <!-- <list_view_column type="path" width="120"/> -->
     33    </columns>
     34    <events>
     35      <key_event key="V" selection_filter="folder" ctrl="True" shift="False" alt="False" assembly="Praties" type="PasteFolderFunction" event_type="execute_method" />
     36      <key_event key="X" selection_filter="folder" ctrl="True" shift="False" alt="False" assembly="Praties" type="CutFolderFolderFunction" event_type="execute_method" />
     37      <key_event key="C" selection_filter="folder" ctrl="True" shift="False" alt="False" assembly="Praties" type="CopyFolderFolderFunction" event_type="execute_method" />
     38      <key_event key="Delete" selection_filter="folder" ctrl="False" shift="False" alt="False" assembly="CinnamonEnterpriseClient" type="DeleteListFunction" event_type="execute_method" />
     39      <key_event key="F5" selection_filter="folder" ctrl="False" shift="False" alt="False" event_type="refresh" />
     40      <key_event key="F5" selection_filter="object" ctrl="False" shift="False" alt="False" event_type="refresh" />
     41      <key_event key="F5" selection_filter="list" ctrl="False" shift="False" alt="False" event_type="refresh" />
     42      <key_event key="F5" selection_filter="nothing" ctrl="False" shift="False" alt="False" event_type="refresh" />
     43      <key_event key="X" selection_filter="object" ctrl="True" shift="False" alt="False" assembly="Praties" type="CutObjectFunction" event_type="execute_method" />
     44      <key_event key="C" selection_filter="object" ctrl="True" shift="False" alt="False" assembly="Praties" type="CopyObjectFunction" event_type="execute_method" />
     45      <key_event key="Delete" selection_filter="object" ctrl="False" shift="False" assembly="CinnamonEnterpriseClient" type="DeleteListFunction" event_type="execute_method" />
     46      <key_event key="Enter" selection_filter="object" ctrl="False" shift="False" assembly="Praties" type="ViewObjectFunction" event_type="execute_method" />
     47      <key_event key="A" selection_filter="folder" ctrl="True" shift="False" alt="False" event_type="select_all" />
     48      <key_event key="A" selection_filter="object" ctrl="True" shift="False" alt="False" event_type="select_all" />
     49      <key_event key="A" selection_filter="list" ctrl="True" shift="False" alt="False" event_type="select_all" />
     50      <key_event key="A" selection_filter="nothing" ctrl="True" shift="False" alt="False" event_type="select_all" />
     51      <key_event key="X" selection_filter="list" ctrl="True" shift="False" alt="False" assembly="Praties" type="CutListFunction" event_type="execute_method" />
     52      <key_event key="Delete" selection_filter="list" ctrl="False" shift="False" alt="False" assembly="CinnamonEnterpriseClient" type="DeleteListFunction" event_type="execute_method" />
     53      <drop_event selection_filter="folder" ctrl="false" shift="false" alt="false" mouse_button="left" event_type="execute_method" assembly="Praties" type="CutFolderFolderFunction" />
     54      <drop_event selection_filter="object" ctrl="false" shift="false" alt="false" mouse_button="left" event_type="execute_method" assembly="Praties" type="CutObjectFunction" />
     55      <drop_event selection_filter="list" ctrl="false" shift="false" alt="false" mouse_button="left" event_type="execute_method" assembly="Praties" type="CutListFunction" />
     56      <drag_event selection_filter="object" ctrl="false" shift="false" alt="false" mouse_button="left" event_type="execute_method" assembly="Praties" type="CutObjectFunction" />
     57      <drag_event selection_filter="folder" ctrl="false" shift="false" alt="false" mouse_button="left" event_type="execute_method" assembly="Praties" type="CutFolderFolderFunction" />
     58      <drag_event selection_filter="list" ctrl="false" shift="false" alt="false" mouse_button="left" event_type="execute_method" assembly="Praties" type="CutListFunction" />
     59      <drag_event selection_filter="object" ctrl="true" shift="false" alt="false" mouse_button="left" event_type="execute_method" assembly="Praties" type="CopyObjectFunction" />
     60      <drag_event selection_filter="folder" ctrl="true" shift="false" alt="false" mouse_button="left" event_type="execute_method" assembly="Praties" type="CopyFolderFolderFunction" />
     61      <drag_event selection_filter="object" ctrl="false" shift="false" alt="false" mouse_button="right" event_type="execute_method" assembly="Praties" type="CopyOrMoveObjectFunction" />
     62      <drag_event selection_filter="folder" ctrl="false" shift="false" alt="false" mouse_button="right" event_type="execute_method" assembly="Praties" type="CopyOrMoveFolderFunction" />
     63      <drag_event selection_filter="list" ctrl="false" shift="false" alt="false" mouse_button="right" event_type="execute_method" assembly="Praties" type="CopyOrMoveListFunction" />
     64    </events>
     65  </custom>
     66</tab_control>
     67}}}
     68
     69The following configuration sections are available:
     70
     71* {{{node_data_provider}}} referencing a class implementing the way how information to an object or folder is retrieved. In most cases (as in this example), a configurable default implementation is used. In some cases, though, a custom implementation can provide more specific behaviour.
     72* {{{filters}}} defining the list display options in the folder content view. By standard, the available options are:
     73 * Show latest version (default)
     74 * Show latest versions in all branches (if there are branch versions, all end branches will be shown)
     75 * Show all versions (entire list of all versions of all objects)
     76 
     77 It is possible, though, to add custom filters (like, for example, a filter that shows the latest, released versions of an object, or to remove filters.
     78
     79* {{{columns}}} defining the metadata fields that should be shown with the objects and folders. The configuration resembles the column definitions in the relations tab control.
     80* {{{events}}} defining the key and drag/drop events and the functions assigned.
     81
     82> **NOTE:** Drag & drop is under construction, but not yet available.
     83