View Panel

Description

The View Panel is a composite widget which binds together a Table Layout Widget and a Search Widget. The Search Widget is a searching mechanism that retrieves items and transfers them to a Table Layout Widget to draw. The View Panel Widget is used in most of TACTIC's predefined views.

Info

Name

View Panel

Class

ViewPanelWdg

TACTIC Version Support

2.5.0 +

Required database columns

none
Implementation

The View Panel widget makes use of the TableLayoutWdg capabilities. The views available to the View Panel are identical to that of the Table Layout Widget.

Options

show_shelf

Flag to show the action shelf with main buttons.

show_gear

Flag to show the gear menu.

show_refresh

Flag to show the refresh button.

show_search

Flag to show the search box.

show_search_limit

Flag to show the search limit.

show_insert

Flag to show the insert button.

show_layout_switcher

Flag to show the layout switcher.

show_column_manager

Flag to show the column manager.

insert_view

Specify the path to a custom insert view.

edit_view

Specify the path to a custom edit view.

show_refresh

Display the refresh button on the shelf.

show_select

Flag to show row_selection checkbox.

popup

Pop the view up in a pop-up window.

layout

default, tile, static, raw, fast_table, old_table, browser, custom, tool

search_type

The type that this widget works with

view

The TACTIC name for the view. e.g. admin.test_asset_tracking

do_initial_search

Run the search on loading of the view.

simple_search_view

Specify the simple search view.

custom_filter_view

View for custom filters. Defaults to "custom_filter".

process

The process which is applicable in the UI when load view is used.

mode

simple, insert

parent_key

Provides a parent item in the form of a search_key to filter in the search. e.g. vfx/asset?project=cg&code=chr001. If the value 'self' is used, the search_key will be used as parent_key

search_key

Provides the starting search key usually meant for TEL expression.

element_names

Provides a list of column names (ie. "preview,name,description") for the view.

schema_default_view

(INTERNAL) flag to show whether this is generated straight from the schema.

order_by

The column name to order ascending by.

search_view

(INTERNAL) View for custom searches.

width

Set the default width of the table

expression

Use an expression for the search. The expression must return items.

filter

JSON data structure representing the settings for SearchWdg
Advanced

Often, the ViewPanelWdg is defined from a side bar link. It can be defined by XML as follows

<element name='summary'>
  <display class='tactic.ui.panel.ViewPanelWdg'>
    <search_type>sthpw/task</search_type>
    <view>task_summary</view>
    <simple_search_view>some_simple_search</simple_search_view>
  </display>
</element>