TAtlasKanban

Create constructor

constructor Create(AOwner: TComponent); override;

Creates a board 850 by 480 pixels, double-buffered, with TabStop set and the font Segoe UI 10. Assign Parent and Model.

Destroy destructor

destructor Destroy; override;

Detaches the board from its model (the model is not freed) and destroys the control.

SelectedCard property

property SelectedCard: string read FSelected;

The id of the selected card, or an empty string. Read-only; select with SelectCard, a click or the arrow keys.

LastError property

property LastError: string read FLastError;

Why the last MoveSelectedTo failed, or an empty string after a successful one. The board also paints it in red in its bottom-left corner. It keeps its value until the next MoveSelectedTo.

Model property

property Model: TAtlasKanbanModel read FModel write SetModel;

The model to show. Assigning a model clears the selection and scrolls back to the top-left corner. The board is notified when the model is freed, and Model becomes nil.

Board.Model := Model;

Align property

property Align;

Published from TControl; alClient lets the board fill its parent.

Anchors property

property Anchors;

Published from TControl.

TabStop property

property TabStop default True;

Published from TWinControl with the default changed to True, so Tab reaches the board.

Font property

property Font;

Published from TControl. Sets the typeface and size of headers and cards; the colours are fixed.

ParentFont property

property ParentFont;

Published from TControl.

OnClick event

property OnClick;

Published from TControl. Fires when the left button is released after a click, after the board has updated SelectedCard.

Board.OnClick := BoardClick;

SelectCard method

procedure SelectCard(const ID: string);

Selects the card with id ID and repaints. Raises EAtlasKanban (Unknown card) when no model is assigned or the model has no such card. The selection is not scrolled into view. It survives moves of the card and is cleared when the card is removed or Model changes.

Board.SelectCard('order-42');

MoveSelectedTo method

function MoveSelectedTo(const ColumnID: string): Boolean;

Moves the selected card to the end of column ColumnID with the model's MoveCard, and returns True when it moved. It never raises for a refused move: when nothing is selected, no model is assigned or BeforeMove declines, the result is False and LastError is Move declined; when the model raises EAtlasKanban (a full column, an unknown column), the result is False and LastError holds the message. Exceptions of other classes, for example one raised by your BeforeMove handler, are not caught. LastError is cleared at the start of every call. The mouse and the Ctrl+arrow keys use this method.

if not Board.MoveSelectedTo('done') then
  StatusBar.SimpleText := Board.LastError;

Show a board on a form and react to clicks

A form built in code with a model of three columns and a board filling the form. Clicking a card puts its id in the caption; clicking empty space clears it.

uses System.SysUtils, System.Classes, Vcl.Forms, Vcl.Controls, Atlas.Kanban;

type
  TPlanForm = class(TForm)
  private
    FModel: TAtlasKanbanModel;
    FBoard: TAtlasKanban;
    procedure BoardClick(Sender: TObject);
  public
    constructor Create(AOwner: TComponent); override;
  end;

constructor TPlanForm.Create(AOwner: TComponent);
begin
  inherited CreateNew(AOwner);
  Caption := 'Plan';
  Width := 900;
  Height := 500;
  FModel := TAtlasKanbanModel.Create(Self);
  FModel.AddColumn('todo', 'To do');
  FModel.AddColumn('doing', 'Doing', 2);
  FModel.AddColumn('done', 'Done');
  FModel.AddCard('todo', 'notes', 'Write the release notes', 'Due Friday');
  FModel.AddCard('doing', 'total', 'Fix the invoice total');
  FBoard := TAtlasKanban.Create(Self);
  FBoard.Parent := Self;
  FBoard.Align := alClient;
  FBoard.Model := FModel;
  FBoard.OnClick := BoardClick;
end;

procedure TPlanForm.BoardClick(Sender: TObject);
begin
  if FBoard.SelectedCard = '' then
    Caption := 'Plan'
  else
    Caption := 'Plan: ' + FBoard.SelectedCard;
end;

Let the board take the arrow keys

Use TKeyboardKanban instead of TAtlasKanban whenever the board should respond to the keyboard. It asks Windows for the arrow keys, so Up, Down, Left and Right select cards and Ctrl+Left and Ctrl+Right move them, even when other controls share the form. The Kanban board sample project uses it.

uses Winapi.Windows, Winapi.Messages, Atlas.Kanban;

type
  // Asks Windows for the arrow keys, so a board on a form receives them
  // instead of the form using them to move the focus.
  TKeyboardKanban = class(TAtlasKanban)
  protected
    procedure WMGetDlgCode(var Message: TWMGetDlgCode); message WM_GETDLGCODE;
  end;

procedure TKeyboardKanban.WMGetDlgCode(var Message: TWMGetDlgCode);
begin
  inherited;
  Message.Result := Message.Result or DLGC_WANTARROWS;
end;