QFQ

Ziel¶

• Bestehende Standard Form Button anpassen.
• Zusaetzliche Custom Buttons.
• Buttons sind Teil einer Buttongroup oder Standalone.
• Anpassung der Position innerhalb der Button-group-reihe.
• Anwenungsbeispiel:
  • Ein Delete Button soll nur unter gewissen Umstaenden aktiv sein
  • Ein Delete Button soll unterschiedliche Tooltips/Quetions bereitstellen (Content abhaengig, je nachdem welcher Record geladen ist).
  • Es soll ein 'Switch-User' Button angeboten werden.

• Buttons sollten ueber und/oder unter dem Form positioniert sein koennen, links und/oder rechts ausgerichtet sein koennen.

Vorschlaege fuer die neuen Keywords¶

btnTopRight
btnBottomRight

formTopLeftButton...|formTailButton
formTopLeftBtn...|formTailBtn
ftlb ... ftrb ... fblb ... fbrb ..
topLeftBtn...|tailBtn
formLeftAbove

btnRight
btnLeft

formHeadBtn...|formFooterBtn...
headBtn...|footerBtn...
formBelow

• CR: btnTopRight ist mein Favorit
  • + Einigermassen kurz und praegnant.
  • - 'btn' ist eine Abkuerzung.
  • - aus dem Begriff geht nicht hevor das die Buttons Teil eines Formulars sind - allerdings ist das implizit gegeben, da sie in einem Form definiert werden.

Wrapping¶

Ziel:

• Wrapping fuer Row und und innerhalb der Row fuer Left & Right.
• Reihenfolge und ButtonGroups innerhalb von Left & Right kann angepasst werden.

# Wrap Buttons Top Row
btnTopWrap=<div class="row"><div class="col-md-12">|</div></div>
# Wrap Buttons Top Left
btnTopLeftWrap=<div class="btn-toolbar" role="toolbar">|<div>
# Wrap Buttons Top Right
btnTopRightWrap=<div class="btn-toolbar pull-right" role="toolbar">|</div>

# Default. Buttons mit einem '+' sind in einer BtnGroup.
btnTopLeftOrder= 1+2+3,4,5,6+7,...
btnTopRightOrder=FormView+FormElementEdit+FormEdit+Copy,Save+Close,Delete,New

Standard und Custom Buttons¶

• Die eckigen Klammern zeigen ein Array an - das ist etwas neues fuer QFQ (koennte auch fuer sqlBefore|After|Update|Insert|Delete verwendet werden).

# Standard Buttons - 
btnTopRight[FormView|FormElementEdit|FormEdit|Copy|Save|Close|Delete|New]=

# Custom Buttoms
btnCustom[1]=
btnCustom[2]=

btnFooterOrder=
btnFooterWrap=
...

Defaults via QFQ Config¶

Neu werden alle Form-Standard-Buttons in der QFQ Config definiert - via '_link' Notation.

• btnTopWrap, btnTopLeftWrap, btnTopRightWrap, btnTopLeftOrder, btnTopRightOrder
• btnTopRight[FormView|FormElementEdit|FormEdit|Copy|Save|Close|Delete|New]
• btnTopLeft[FormView|FormElementEdit|FormEdit|Copy|Save|Close|Delete|New]

• btnBottomWrap, btnBottomLeftWrap, btnBottomRightWrap, btnBottomLeftOrder, btnBottomRightOrder
• btnBottomRight[FormView|FormElementEdit|FormEdit|Copy|Save|Close|Delete|New]
• btnBottomLeft[FormView|FormElementEdit|FormEdit|Copy|Save|Close|Delete|New]

Deprecated¶

• saveButtonText,saveButtonTooltip,saveButtonClass,saveButtonGlyphIcon,saveButtonActive
• newButtonText,newButtonTooltip,newButtonClass,newButtonGlyphIcon
• deleteButtonText,deleteButtonTooltip,deleteButtonClass,deleteButtonGlyphIcon
• closeButtonText,closeButtonTooltip,closeButtonClass,closeButtonGlyphIcon

Bei einem Upgrade auf die neue Version werden alle Forms untersucht und eine Warnung ausgegebenen falls deprecated gefunden wird. Anschliessend kann manuell angepasst werden.

• Beispiel: Der Eintrag Form.parameter.buttonSaveText=Speichern wird ersetzt durch Form.parameter.btnTopRight[Save]=p:_apiSave|G:glyphicon-ok|b|s|t:Speichern.
• Wuenschenswert: eine QFQ Notation die partiell Parameter in einer einem QFQ Link setzen kann, ohne das man alles (aus dem Default) angegeben muss - in dem Faell waere Form.parameter.btnTopRight[Save]=+t:Speichern (das '+' ist nicht sicher)

Ausnahme: submitButtonText¶

• Es soll einfach bleiben mit einem einfachen Parameter den Save Button unter das Form zu bekommen.
• Der Parameter submitButtonText soll erhalten bleiben. Ist 'submitButtonText' gesetzt (es wird ein save button unter dem Form angezeigt), werden die Defaults aus der System Config neu gesetzt.
• Sind die Defaults aus der System Config wichtig und sollen erhalten bleiben: submitButtonText nicht verwenden und alles explizit setzen (ist ein Kompromiss).

# Wrap Buttons Bottom Row
btnBottomWrap=<div class="row"><div class="col-md-12">|</div></div>
# Wrap Buttons Top Left
btnBottomLeftWrap=<div class="col-md-3">|<div>
# Wrap Buttons Top Right
btnBottomRightWrap=<div class="col-md-9">|<div>
# Save Button aktivieren
btnBottomRightOrder=Save
btnBottom[Save]=p:...

Anmerkungen¶

Varianten um einen Standardbutton auszublenden:

• Checkbox 'New' im FormEditor disablen, oder
• Definition loeschen: btnTopRight[New]=, oder
• Aus btnTopRightOrder das New entfernen.

By default sind btnFooter* und btnTopLeft* leer.

Spezielle Funktionalitaeten¶

• Button 'Save' hat die 'visualize mark dirty' Eigenschaft (data-class-on-change) - wird durch den QFQ Client in Echtzeit gesetzt.
• Button 'Delete' ist disabled wenn ein Form im 'New-Mode' ist.
• Button 'FormView' ist disabled wenn es 'RequiredNew' oder 'RequiredEdit' Angaben gibt.

Order Notation¶

1. Variante

* btnTopRightOrder = 1, {{btnTopRight:DE}} , 2 

* Custom Buttons
btnTopRight[1]= {{p:{{pageSlug:T}}?r=...|s|b|E}} AS _link
btnTopRight[2]= {{p:{{pageSlug:T}}?r=...|s|b|G:ok}} AS _link

2. Variante

* btnTopRightOrder = < 1 hier kommt der Button and der linke Seite von den default order.

* Custom Buttons
btnTopRight[1]= {{p:{{pageSlug:T}}?r=...|s|b|E}} AS _link
btnTopRight[2]= {{p:{{pageSlug:T}}?r=...|s|b|G:ok}} AS _link

Macht es Sinn, Custom buttons allgemein zu halten?

btnCustom[1] = {{p:{{pageSlug:T}}?r=...|s|b|E}} AS _link
btnCustom[key] = = {{p:{{pageSlug:T}}?r=...|s|b|E}} AS _link

btnTopRightOrder = 1,{{btnTopRight:DE}}+key
btnTopLeftOrder = 1+key