Difference between revisions of "Page Header"

From Lianjapedia
Jump to: navigation, search
(→‎Notes on Client Support)
 
(38 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
''Under construction''
 
−
 
 
==Visible==
 
==Visible==
−
Header visible (True | False).
+
The Header '''Visible''' attribute determines whether the Page Header is visible or not.
 +
 
 +
[[#Notes on Client Support|Notes on Client Support]]
 +
 
 +
==Custom header==
 +
The '''Custom header''' attribute determines whether the page header is rendered using the [[#Custom header display delegate|Custom header display delegate]] or not.
 +
 
 +
[[#Notes on Client Support|Notes on Client Support]]
 +
 
 +
==Custom header display delegate==
 +
The '''Custom header display delegate''' attribute specifies the name of a procedure/function that will render the page header when [[#Custom header|Custom header]] is true.
 +
 
 +
[[#Notes on Client Support|Notes on Client Support]]
  
 
==Caption==
 
==Caption==
−
Header caption.
+
The Header '''Caption''' attribute specifies the text to be displayed in the center of the Page Header.
 +
* The Page Header Caption attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page").caption]].
 +
* Note that the Page '''Name''' is used in the [[Working with the Lianja Object Model|Lianja Object Model]] and the Page '''Title''' is used in Page navigation displays.
  
−
The Page Header Caption attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page").caption]].
+
[[#Notes on Client Support|Notes on Client Support]]
  
 
==Height==
 
==Height==
−
Header height.
+
The Header '''Height''' attribute specifies its height in pixels.
 +
 
 +
[[#Notes on Client Support|Notes on Client Support]]
  
 
==Background color==
 
==Background color==
−
Header background color.
+
The Header '''Background color''' attribute specifies its background color.  This is only used if '''Gradient colors''' is False and no '''Header image''' is specified.
−
* See [[Colors]]
+
* See [[Colors]].
 +
 
 +
[[#Notes on Client Support|Notes on Client Support]]
  
 
==Foreground color==
 
==Foreground color==
−
Header foreground color.
+
The Header '''Foreground color''' attribute specifies its foreground color.
−
* See [[Colors]]
+
* See [[Colors]].
 +
 
 +
[[#Notes on Client Support|Notes on Client Support]]
  
 
==Header bottom border==
 
==Header bottom border==
−
Display Header bottom border (True | False).
+
The '''Header bottom border''' attribute determines whether a border should be displayed at the bottom of the Header.
 +
 
 +
[[#Notes on Client Support|Notes on Client Support]]
  
 
==Header bottom border color==
 
==Header bottom border color==
−
Header bottom border color.
+
The '''Header bottom border color''' attribute determines the color of the '''Header bottom border''' if displayed.
−
* See [[Colors]]
+
* See [[Colors]].
 +
 
 +
[[#Notes on Client Support|Notes on Client Support]]
  
 
==Header image==
 
==Header image==
−
The image for the Header (png | jpg | gif).
+
The '''Header image''' attribute specifies a background image for the Header (png | jpg | gif).
−
Use app:/imagename.ext for app specific images.
+
* This is only displayed if '''Gradient colors''' is False.
 +
 
 +
[[#Notes on Client Support|Notes on Client Support]]
  
 
==Gradient colors==
 
==Gradient colors==
−
Render the Header background color as a gradient (True | False).
+
The '''Gradient colors''' attribute determines whether the Header background should be rendered with gradient colors.
−
* See [[Gradients]]
+
* See [[Gradients]].
 +
 
 +
[[#Notes on Client Support|Notes on Client Support]]
  
 
==Gradient type==
 
==Gradient type==
−
Specify the gradient type.
+
The '''Gradient type''' attribute specifies the gradient type to be used if '''Gradient colors''' is True.
−
* See [[Gradients]]
+
* See [[Gradients]].
 +
 
 +
[[#Notes on Client Support|Notes on Client Support]]
  
 
==Gradient start color==
 
==Gradient start color==
−
Gradient start color.
+
The '''Gradient start color''' attribute specifies the start color to be used if '''Gradient colors''' is True.
−
* See [[Gradients]]
+
* See [[Gradients]].
 +
 
 +
[[#Notes on Client Support|Notes on Client Support]]
  
 
==Gradient end color==
 
==Gradient end color==
−
Gradient end color.
+
The '''Gradient end color''' attribute specifies the end  color to be used if '''Gradient colors''' is True.
−
* See [[Gradients]]
+
* See [[Gradients]].
 +
 
 +
[[#Notes on Client Support|Notes on Client Support]]
  
 
==Hide header icon==
 
==Hide header icon==
−
Hide the header icon in the page Header (True | False).
+
 
 +
[[{{ns:file}}:header_icons.png|450px|thumb|left|link={{filepath:header_icons.png}}|Page Header: icons]]
 +
 
 +
 
 +
 
 +
 
 +
Check or uncheck the attributes to hide or show the icons in the Page Header.
 +
 
 +
<br clear=all>
 +
 
 +
The '''Hide the header icon''' attribute determines whether the header icon should be hidden.
 +
 
 +
[[#Notes on Client Support|Notes on Client Support]]
 +
 
 +
==Hide database switcher==
 +
The '''Hide database switcher''' determines whether the database switcher should be hidden.
 +
* From v6.3.
 +
* See [[Database Tenancies#Database Switcher|Database Switcher]].
  
 
==Hide search box==
 
==Hide search box==
−
Hide the search box in the page Header (True | False).
+
The '''Hide search box''' determines whether the search box should be hidden.
 +
* See [[#Hide_header_icon|screenshot above]].
 +
* See [[Instant Search]].
 +
 
 +
[[#Notes on Client Support|Notes on Client Support]]
  
 
==Minimum search text length==
 
==Minimum search text length==
−
Minimum number of characters to type in the search box before search is made.
+
The '''Minimum search text length''' attribute specifies the number of characters that need to be typed in the search box before the search is made.
 +
* See [[Instant Search]].
 +
 
 +
[[#Notes on Client Support|Notes on Client Support]]
  
 
==Hide notifications icon==
 
==Hide notifications icon==
−
Hide the notifications icon in the page Header (True | False).
+
The '''Hide notifications icon''' attribute determines whether the notifications icon should be hidden.
 +
* See [[#Hide_header_icon|screenshot above]].
 +
 
 +
[[#Notes on Client Support|Notes on Client Support]]
 +
 
 +
==Hide search icon==
 +
The '''Hide search icon''' attribute determines whether the custom search icon should be hidden.
 +
* See [[#Hide_header_icon|screenshot above]].
 +
* See [[Custom Search]].
 +
 
 +
[[#Notes on Client Support|Notes on Client Support]]
 +
 
 +
==Show Custom search dialog==
 +
The '''Show Custom search dialog''' attribute determines whether the Query Builder custom search dialog should be displayed when the custom search icon in the page header is clicked.
 +
* See [[QueryBuilder#Using_the_Query_Builder_in_Sections|Using the Query Builder in Pages]]
 +
 
 +
[[#Notes on Client Support|Notes on Client Support]]
 +
 
 +
==Show custom search dialog panel==
 +
The '''Show Custom search dialog panel''' attribute determines whether the Query Builder custom search dialog panel should be displayed when the custom search icon in the page header is clicked.
 +
* See [[QueryBuilder#Using_the_Query_Builder_in_Sections|Using the Query Builder in Pages]]
 +
 
 +
[[#Notes on Client Support|Notes on Client Support]]
 +
 
 +
==Columns==
 +
The '''Columns''' attribute determines whether the table columns listed in the Query Builder when the custom search icon in the page header is clicked.
 +
* See [[QueryBuilder#Using_the_Query_Builder_in_Pages|Using the Query Builder in Pages]]
 +
 
 +
[[#Notes on Client Support|Notes on Client Support]]
  
 
==Hide fullscreen icon==
 
==Hide fullscreen icon==
−
Hide the fullscreen icon in the page Header (True | False).
+
The '''Hide fullscreen icon''' attribute determines whether the fullscreen icon should be hidden.
 +
* See [[#Hide_header_icon|screenshot above]].
 +
 
 +
[[#Notes on Client Support|Notes on Client Support]]
  
 
==Hide share icon==
 
==Hide share icon==
−
Hide the share icon in the page Header (True | False).
+
The '''Hide share icon''' attribute determines whether the share icon should be hidden.
 +
* See [[#Hide_header_icon|screenshot above]].
 +
 
 +
[[#Notes on Client Support|Notes on Client Support]]
  
 
==Hide home icon==
 
==Hide home icon==
−
Hide the home icon in the page Header (True | False).
+
The '''Hide home icon''' attribute determines whether the home icon should be hidden.
 +
* See [[#Hide_header_icon|screenshot above]].
 +
 
 +
[[#Notes on Client Support|Notes on Client Support]]
 +
 
 +
==Hide print icon==
 +
The '''Hide print icon''' attribute determines whether the print icon should be hidden.
 +
* From v4.2.
 +
 
 +
[[#Notes on Client Support|Notes on Client Support]]
 +
 
 +
==Hide hamburger menu==
 +
The '''Hide hamburger menu''' attribute determines whether the hamburger menu icon should be hidden at runtime.
 +
* See [[#Hide_header_icon|screenshot above]].
 +
* See also [[Page_Menu#Hide_hamburger_menu|Page Menu: Hide hamburger menu]]
 +
 
 +
[[#Notes on Client Support|Notes on Client Support]]
 +
 
 +
==Hide navigation history icons==
 +
The '''Hide navigation history icons''' attribute determines whether the navigation history icons should be hidden.  This overrides a True '''Show navigation history''' [[App Settings|App Setting]].  
 +
* See [[#Hide_header_icon|screenshot above]].
 +
* See also [[Page_Menu#Hide_navigation_history_icons|Page Menu: Hide navigation history icons]]
  
 
[[#Notes on Client Support|Notes on Client Support]]
 
[[#Notes on Client Support|Notes on Client Support]]
Line 72: Line 183:
 
==Notes on Client Support==
 
==Notes on Client Support==
 
{| class="wikitable" width="100%"
 
{| class="wikitable" width="100%"
−
!width="20%"|Attribute
+
!width="30%"|Attribute
−
!width="80%"|Notes
+
!width="70%"|Notes
 
|-
 
|-
−
|valign="top"|Visible||
+
|valign="top"|Visible||-
 
|-
 
|-
−
|valign="top"|Caption||
+
|valign="top"|Custom header||-
 +
|-
 +
|valign="top"|Custom header display delegate||The delegate must be written in JavaScript on the Web/Mobile client.
 +
|-
 +
|valign="top"|Caption||-
 
|-
 
|-
 
|valign="top"|Height||The Header Height is adjustable on the Desktop client only.
 
|valign="top"|Height||The Header Height is adjustable on the Desktop client only.
 
|-
 
|-
−
|valign="top"|Background color||
+
|valign="top"|Background color||The Background color is supported on the Desktop client only.
 +
|-
 +
|valign="top"|Foreground color||The Foreground color is supported on the Desktop client only.
 +
|-
 +
|valign="top"|Header bottom border||The Header bottom border is always displayed on the Web/Mobile client.
 +
|-
 +
|valign="top"|Header bottom border color||valign="top"|The Header bottom border color is adjustable on the Desktop client only.  On the Web/Mobile client it is orange.
 +
|-
 +
|valign="top"|Header image||The Header image is displayed on the Desktop client only.
 +
|-
 +
|valign="top"|Gradient colors||Gradient colors are supported on the Desktop client only.
 +
|-
 +
|valign="top"|Gradient type||The Gradient type is supported on the Desktop client only.
 +
|-
 +
|valign="top"|Gradient start color||The Gradient start color is supported on the Desktop client only.
 
|-
 
|-
−
|valign="top"|Foreground color||
+
|valign="top"|Gradient end color||The Gradient end color is supported on the Desktop client only.
 
|-
 
|-
−
|valign="top"|Header bottom border||
+
|valign="top"|Hide header icon||The header icon is always hidden on the Web/Mobile client.
 
|-
 
|-
−
|valign="top"|Header bottom border color||
+
|valign="top"|Hide search box||-
 
|-
 
|-
−
|valign="top"|Header image||
+
|valign="top"|Minimum search text length||valign="top"|The Minimum search text length is supported on the Desktop client only.  On the Web/Mobile client, the search starts from the first character entered.
 
|-
 
|-
−
|valign="top"|Gradient colors||
+
|valign="top"|Hide notifications icon||The notifications icon is always hidden on the Web/Mobile client.
 
|-
 
|-
−
|valign="top"|Gradient type||
+
|valign="top"|Hide search icon||-
 
|-
 
|-
−
|valign="top"|Gradient start color||
+
|valign="top"|Show Custom search dialog||-
 
|-
 
|-
−
|valign="top"|Gradient end color||
+
|valign="top"|Show custom search dialog panel||-
 
|-
 
|-
−
|valign="top"|Hide header icon||
+
|valign="top"|Columns||The Columns attribute is supported on the Desktop client only.
 
|-
 
|-
−
|valign="top"|Hide search box||
+
|valign="top"|Hide fullscreen icon||The fullscreen icon is always hidden on the Web/Mobile client.
 
|-
 
|-
−
|valign="top"|Minimum search text length||
+
|valign="top"|Hide share icon||The share icon is always hidden on all clients.
 
|-
 
|-
−
|valign="top"|Hide notifications icon||
+
|valign="top"|Hide home icon||-
 
|-
 
|-
−
|valign="top"|Hide fullscreen icon||
+
|valign="top"|Hide print icon||-
 
|-
 
|-
−
|valign="top"|Hide share icon||
+
|valign="top"|Hide hamburger menu||-
 
|-
 
|-
−
|valign="top"|Hide home icon||
+
|valign="top"|Hide the navigation history icons||Hiding the navigation history icons is supported on the Desktop client only.
 
|-
 
|-
 
|}
 
|}
  
 
[[Category:Attribute Categories]]
 
[[Category:Attribute Categories]]
 +
[[Category:Pages]]
 +
[[Category:PageAnatomy]]

Latest revision as of 09:24, 13 June 2023

Visible

The Header Visible attribute determines whether the Page Header is visible or not.

Notes on Client Support

Custom header

The Custom header attribute determines whether the page header is rendered using the Custom header display delegate or not.

Notes on Client Support

Custom header display delegate

The Custom header display delegate attribute specifies the name of a procedure/function that will render the page header when Custom header is true.

Notes on Client Support

Caption

The Header Caption attribute specifies the text to be displayed in the center of the Page Header.

Notes on Client Support

Height

The Header Height attribute specifies its height in pixels.

Notes on Client Support

Background color

The Header Background color attribute specifies its background color. This is only used if Gradient colors is False and no Header image is specified.

Notes on Client Support

Foreground color

The Header Foreground color attribute specifies its foreground color.

Notes on Client Support

Header bottom border

The Header bottom border attribute determines whether a border should be displayed at the bottom of the Header.

Notes on Client Support

Header bottom border color

The Header bottom border color attribute determines the color of the Header bottom border if displayed.

Notes on Client Support

Header image

The Header image attribute specifies a background image for the Header (png | jpg | gif).

  • This is only displayed if Gradient colors is False.

Notes on Client Support

Gradient colors

The Gradient colors attribute determines whether the Header background should be rendered with gradient colors.

Notes on Client Support

Gradient type

The Gradient type attribute specifies the gradient type to be used if Gradient colors is True.

Notes on Client Support

Gradient start color

The Gradient start color attribute specifies the start color to be used if Gradient colors is True.

Notes on Client Support

Gradient end color

The Gradient end color attribute specifies the end color to be used if Gradient colors is True.

Notes on Client Support

Hide header icon

Page Header: icons



Check or uncheck the attributes to hide or show the icons in the Page Header.


The Hide the header icon attribute determines whether the header icon should be hidden.

Notes on Client Support

Hide database switcher

The Hide database switcher determines whether the database switcher should be hidden.

Hide search box

The Hide search box determines whether the search box should be hidden.

Notes on Client Support

Minimum search text length

The Minimum search text length attribute specifies the number of characters that need to be typed in the search box before the search is made.

Notes on Client Support

Hide notifications icon

The Hide notifications icon attribute determines whether the notifications icon should be hidden.

Notes on Client Support

Hide search icon

The Hide search icon attribute determines whether the custom search icon should be hidden.

Notes on Client Support

Show Custom search dialog

The Show Custom search dialog attribute determines whether the Query Builder custom search dialog should be displayed when the custom search icon in the page header is clicked.

Notes on Client Support

Show custom search dialog panel

The Show Custom search dialog panel attribute determines whether the Query Builder custom search dialog panel should be displayed when the custom search icon in the page header is clicked.

Notes on Client Support

Columns

The Columns attribute determines whether the table columns listed in the Query Builder when the custom search icon in the page header is clicked.

Notes on Client Support

Hide fullscreen icon

The Hide fullscreen icon attribute determines whether the fullscreen icon should be hidden.

Notes on Client Support

Hide share icon

The Hide share icon attribute determines whether the share icon should be hidden.

Notes on Client Support

Hide home icon

The Hide home icon attribute determines whether the home icon should be hidden.

Notes on Client Support

Hide print icon

The Hide print icon attribute determines whether the print icon should be hidden.

  • From v4.2.

Notes on Client Support

Hide hamburger menu

The Hide hamburger menu attribute determines whether the hamburger menu icon should be hidden at runtime.

Notes on Client Support

Hide navigation history icons

The Hide navigation history icons attribute determines whether the navigation history icons should be hidden. This overrides a True Show navigation history App Setting.

Notes on Client Support

Notes on Client Support

Attribute Notes
Visible -
Custom header -
Custom header display delegate The delegate must be written in JavaScript on the Web/Mobile client.
Caption -
Height The Header Height is adjustable on the Desktop client only.
Background color The Background color is supported on the Desktop client only.
Foreground color The Foreground color is supported on the Desktop client only.
Header bottom border The Header bottom border is always displayed on the Web/Mobile client.
Header bottom border color The Header bottom border color is adjustable on the Desktop client only. On the Web/Mobile client it is orange.
Header image The Header image is displayed on the Desktop client only.
Gradient colors Gradient colors are supported on the Desktop client only.
Gradient type The Gradient type is supported on the Desktop client only.
Gradient start color The Gradient start color is supported on the Desktop client only.
Gradient end color The Gradient end color is supported on the Desktop client only.
Hide header icon The header icon is always hidden on the Web/Mobile client.
Hide search box -
Minimum search text length The Minimum search text length is supported on the Desktop client only. On the Web/Mobile client, the search starts from the first character entered.
Hide notifications icon The notifications icon is always hidden on the Web/Mobile client.
Hide search icon -
Show Custom search dialog -
Show custom search dialog panel -
Columns The Columns attribute is supported on the Desktop client only.
Hide fullscreen icon The fullscreen icon is always hidden on the Web/Mobile client.
Hide share icon The share icon is always hidden on all clients.
Hide home icon -
Hide print icon -
Hide hamburger menu -
Hide the navigation history icons Hiding the navigation history icons is supported on the Desktop client only.
Retrieved from "https://www.lianja.com/doc/index.php?title=Page_Header&oldid=25903"