Panel Messages

Panel messages are messages displayed on the panel level. You can add, remove messages to any panel level object(forms, grids, scheduler, treegrids...) from CLAPI.

Panel messages are available since version 20.04 of the SWAT framework.

Standard types of messages

Type	Color
success	green
info	blue
warning	orange
error	red

Note

There is no default type. A message with no type would not be displayed.

Panel Messages Attributes:

Attribute	Type	Info	Default value
text	string	The text that would be displayed in the panel message.	none
type	string	Available values: info, success, warning, error	none

Note

Both attributes are required!

Panel Messages Styling:

The scss variables for colors are the same with Smart Messages

Style

.panel-msg:empty {
  display: none;
}
.panel-msg {
  padding: 20px 0px 20px 45px;
  p {
      margin: 2px 0px;
      font-family: $light_font;
  }
}
.msg-error {
  color: $msg_error_color;
}
.msg-warning {
  color: $msg_warning_color;
}
.msg-info {
  color: $msg_info_color;
}
.msg-success {
  color: $msg_success_color;
}

Panel Messages Examples:

Example of panel message on form, type info

akioma.swat.form.addPanelMessage({
    text: 'An info message',
    type: 'info'
})

Example on form with handlebars template, type error

akioma.swat.form.addPanelMessage({
    text: '{{selfno}} is not unique. Try again',
    type: 'error'
})

Example on form, delete panel message with id = 0

akioma.swat.form.removePanelMessage(0)

Example for form, clear all panel messages

akioma.swat.form.clearPanelMessage()

Example on grid with handlebars, type warning

akioma.swat.grid.addPanelMessage({
    text: 'Currency is {{currencydesc}}',
    type: 'warning'
})

Error rendering macro 'code': Invalid value specified for parameter 'com.atlassian.confluence.ext.code.render.InvalidValueException'

akioma.swat.grid.addPanelMessage({
    text: 'Customer is set to {{customerdesc}}',
    type: 'success'
})
??

Example on window, type success

akioma.swat.window.addWindowMessage({
    text: 'An window message',
    type: 'success'
})

Example on window, type warning

akioma.swat.window.addWindowMessage({
    text: 'Something went wrong',
    type: 'warning'
})

Example on window, clear all messages

akioma.swat.window.clearWindowMessage()

Example on dataview, type info

akioma.swat.dataview.addPanelMessage({
    text: 'Info message',
    type: 'info'
})

____________________________________

Example for Grid Control

var offer_largebGrid = akioma.root.dynObject.getObject('offer_largeb').controller;
// add messages
offer_largebGrid.parent.addPanelMessage({text: 'Deprecated', type: 'warning'})
offer_largebGrid.parent.addPanelMessage({text: 'There was an <u>error</u>', type: 'error'})
offer_largebGrid.parent.addPanelMessage({text: 'There was a tester', type: 'error'})
// remove one message by index
offer_largebGrid.parent.removePanelMessage(1);
// clear all messages
offer_largebGrid.parent.clearPanelMessages();

Example for Treegrid Control

var otreee = akioma.root.dynObject.getObject('itTree').controller;
otreee.parent.addPanelMessage({ text: 'Info message', type:'info' })

Example for a Form Control

var OfferHeaderData = akioma.root.dynObject.getObject('OfferHeaderData').controller;
// add messages
OfferHeaderData.parent.addPanelMessage({text: 'Deprecated', type: 'warning'})
OfferHeaderData.parent.addPanelMessage({text: 'There was an error', type: 'error'})
OfferHeaderData.parent.addPanelMessage({text: 'There was a tester', type: 'error'})
// remove one message by index
OfferHeaderData.parent.removePanelMessage(1);
// clear all messages
OfferHeaderData.parent.clearPanelMessages()

Page tree

Panel Messages