ePages 7.27.0 - DE_EPAGES/Presentation/API/Object/TrayBuilder.pm

Package DE_EPAGES::Presentation::API::Object::TrayBuilder

Builder for new object tray introduced in 6.17.0

Functions

addColumnHeader
getHeaderList
new

addColumnHeader

Add a new coulmn header to list.

Syntax
$Builder->addColumnHeader($Id, $aFlags, $IsSortable, $TranslationKey)
Input
$Id (string)
unique name to identify this column
$aFlags (string)

  • $IsSelectable - column will be decorated with checkbox in gui - boolean
  • $IsSortable - column will be decorated with sort icon in gui - boolean
  • $IsLinkable - show column as text - boolean
  • $IsRightAligned - set alignment to right - boolean
| array.ref.
# $TranslationKey | optional - key used localization will result in {foo},
if dictionary don't know 'foo'. set undef to omit headline text
$TranslationPackage (string)
optional - overwrite default translation package for this column
Return
$self (DE_EPAGES::Presentation::API::Object::TrayBuilder)
self reference

getHeaderList

Returns list of column header. See addColumnHeader

Syntax
$aHeader = $Builder->getHeaderList()
Return
$aHeader (array.ref)
list of hashes:
  • id - unique id - string
  • name - localized name - string
  • isSelectable - can column be used to select items - boolean
  • isSortable - can column be used to sort items - boolean

new

Constructor of TrayBuilder object.

Syntax
$Builder = DE_EPAGES::Presentation::API::Object::TrayBuilder->new($hOptions);
Example
$Builder = DE_EPAGES::Presentation::API::Object::TrayBuilder->new( {
     LanguageID         => $LanguageID,
     TranslationPackage => 'DE_EPAGES::Presentation'
    }
);
Input
$hOptions (hash.ref.)

  • LanguageID | required for translation column names | integer
  • TranslationPackage | required for translation column names | string
Return
$Builder (DE_EPAGES::Presentation::API::Object::TrayBuilder)
builder object