Thomas Linder Puls: category

2016-03-04T09:48:41Z

Thomas Linder Puls: Category

2013-10-28T09:44:12Z

Thomas Linder Puls: release

2012-11-24T19:47:57Z

release

← Older revision		Revision as of 21:47, 24 November 2012
Line 1:		Line 1:
	~~{{Preliminary Documentation}}~~

	The <vp>ribbonControl</vp>		The <vp>ribbonControl</vp>

Thomas Linder Puls: Initial

2012-11-22T12:14:22Z

Initial

New page

{{Preliminary Documentation}}

The <vp>ribbonControl</vp>

== Ribbon Demo ==

The Ribbon Demo project illustrates how to develop applications using the Ribbon and Command packages of pfc/gui.

[[Image:RibbonDemo.png]]

Commands provide a convenient and abstract way of encapsulating end-user actions/operations/features.

'''Example''' A simple command that invokes a specific operation

<vip>clauses
...
ChangeOrgUnitCmd=command::new(This,"system/organization/change"),
ChangeOrgUnitCmd:menuLabel:="Organization",
ChangeOrgUnitCmd:icon:=some(icon::createFromImages(
[bitmap::createFromBinary(#binInclude(@"Icons\Organization16.png")),
bitmap::createFromBinary(#binInclude(@"Icons\Organization32.png"))])),
ChangeOrgUnitCmd:tipText:=tooltip::tip("Change Organizational Settings"),
ChangeOrgUnitCmd:run:=onCmdRun,
...</vip>

Commands feature all required properties for presentation and operation.

Command objects can be included and referenced from menus and ribbon controls. The Action popup menu is constructed as a menuCommand,

<vip>clauses
...
MenuCmd=menuCommand::new(This,"actions"),
MenuCmd:menuLabel:="Actions",
MenuCmd:style:= popupMenu,
MenuCmd:icon:=some(icon::createFromImages(
[bitmap::createFromBinary(#binInclude(@"Icons\Reports16.png")),
bitmap::createFromBinary(#binInclude(@"Icons\Reports32.png"))])),
MenuCmd:layout:= menuStatic(
[cmd(ChangeOrgUnitCmd),
separator,
cmd(OptionMenuCmd)]),
...</vip>

[[Image:RibbonDemoOrganization.png]]

Note how the command icons are used in menus as well.

Three kinds of menuCommands are supported:

;popupMenu
:A traditional menu from which user can choose a command

;toolMenu
:The menu items are considered tools. When user picks a tool the ribbon button changes to this tool such that repeative uses are simplified. Tool can be altered by opening menu and selecting another one.

;variantMenu
:The menu items are variations of a common, super command. If menu is reduced to a single variant the ribbon button looks and behaves just like an ordinary command button, i.e. no dropdown triangle and command is executed by clicking button.

Variant menus can be aggregated/gathered automatically by declaratively stating which categories of commands constitute a metaCommand. Typically this is used for actions and clipboard commands. A number of New actions may be supported by various UI components of a form. Instead of presenting all these as separate ribbon buttons a ''metaCommand'' can be defined

<vip>clauses
...
ActionNewCmd = metaCommand::new(This,"action/new"),
ActionNewCmd:category := ["action/new"],
ActionNewCmd:menuLabel:="New",
ActionNewCmd:icon:=some(icon::createFromImages(
[bitmap::createFromBinary(#binInclude(@"Icons\NewPane16.png")),
bitmap::createFromBinary(#binInclude(@"Icons\NewPane32.png"))])),
...</vip>

The ''category'' property defines the criteria that ''New'' commands should satisfy in order to be included in <vp>variantMenu</vp>. Initially our demo form supports two commands that are to be considered ''New'' commands,

<vip>clauses
...
CallinActionNewCmd:category := ["action/new"],
PersonActionNewCmd:category := ["action/new"],
...</vip>

[[Image:RibbonDemoNew.png]]

By clicking ''on/off'' button we disable one of them. The ''New'' button immediately becomes an ordinary looking command button for the only remaining variant command ''New Person''

[[Image:RibbonDemoNewPerson.png]]

If ''New CallIn'' is later re-enabled or other commands with matching ''category'' are defined the button will again appear as a menu button with dropdown option.

When Command state properties (visible, enabled, labels, icons) are changed, menus and ribbons react immediately.

[[Image:RibbonDemoStateChange.png]]

Toggle/Check buttons are supported by the <vp>checkCommand</vp>.

[[Image:RibbonDemoOnOff.png]]

A <vp>checkStateChange</vp> event is supported on these commands. The current check state can be read and set directly on Command as a property. If check state is updated all uses of this command reflects change.

The <vp>customCommand</vp> allows all pfc/gui Controls to be embedded in Ribbons. Popup menu does currently not support <vp>customCommands</vp>. The demo shows how an editControl can easily be embedded in ribbons.

=== Designer ===

The ribbon control furthermore features a rich, visual Designer. Try clicking the Design button and customize the demo ribbon to your likings.

[[Category:Tutorials]]
[[Category:GUI]]

← Older revision		Revision as of 11:48, 4 March 2016
Line 100:		Line 100:
	The ribbon control furthermore features a rich, visual Designer. Try clicking the Design button and customize the demo ribbon to your likings.		The ribbon control furthermore features a rich, visual Designer. Try clicking the Design button and customize the demo ribbon to your likings.


	~~[[Category:Tutorials]]~~
	[[Category:Controls]]		[[Category:Controls]]

← Older revision		Revision as of 11:44, 28 October 2013
Line 102:		Line 102:

	[[Category:Tutorials]]		[[Category:Tutorials]]
	[[Category:~~GUI~~]]		[[Category:Controls]]

RibbonControl - Revision history

Thomas Linder Puls: category

Thomas Linder Puls: Category

Thomas Linder Puls: release

Thomas Linder Puls: Initial