Class idx.border.BorderDesign


Defined in: <idx\border\BorderDesign.js>.

Constructor Summary

Constructor Attributes Constructor Name and Description
 
idx.border.BorderDesign()
Encapsulates the meta-data used to render the various border design modes for border layouts.

Method Summary

Method Attributes Method Name and Description
 
constructor(name, leftToRight)
Constructs a BorderDesign instance with a name and a boolean indicating whether it is for left-to-right or right-to-left.
<static>  
idx.border.BorderDesign.create(name, leftToRight)
Similar to the constructor, but if a bad name is provided then null is returned.

Constructor Detail

idx.border.BorderDesign()

Encapsulates the meta-data used to render the various border design modes for border layouts. The recognized border designs are:
  • "headline" - top and bottom regions on expand to borders 
    	         +-------------------+
	         |                   |
	         |--+-------------+--|
	         |  |             |  |
	         |  |             |  |
	         |  |             |  |
	         |--+-------------+--|
	         |                   |
	         +-------------------+
  • "sidebar" - left and right regions expand to borders 
    	         +--+-------------+--+
	         |  |             |  |
	         |  |-------------|  |
	         |  |             |  |
	         |  |             |  |
	         |  |             |  |
	         |  |-------------|  |
	         |  |             |  |
	         +--+-------------+--+
  • "topline" - top region expands to borders, left & right regions expand to bottom border 
    	         +-------------------+
	         |                   |
	         |--+-------------+--|
	         |  |             |  |
	         |  |             |  |
	         |  |             |  |
	         |  |-------------|  |
	         |  |             |  |
	         +--+-------------+--+
  • "bottomline" - bottom region expands to borders, left & right regions expand to top border 
    	         +--+-------------+--+
	         |  |             |  |
	         |  |-------------|  |
	         |  |             |  |
	         |  |             |  |
	         |  |             |  |
	         |--+-------------+--|
	         |                   |
	         +-------------------+
  • "leftbar" - left region expands to borders, top & bottom regions expand to right border 
    	         +--+----------------+
	         |  |                |
	         |  |-------------+--+
	         |  |             |  |
	         |  |             |  |
	         |  |             |  |
	         |  |-------------+--+
	         |  |                |
	         +--+----------------+
  • "rightbar" - right region expands to border, top & bottom region expand to left border 
    	         +----------------+--+
	         |                |  |
	         +--+-------------|  |
	         |  |             |  |
	         |  |             |  |
	         |  |             |  |
	         +--+-------------|  |
	         |                |  |
	         +----------------+--+
  • "clockwise" - clock-wise leading edge of each region expands to border 
    	         +--+----------------+
	         |  |                |
	         |  |-------------+--+
	         |  |             |  |
	         |  |             |  |
	         |  |             |  |
	         +--+-------------|  |
	         |                |  |
	         +----------------+--+
  • "counterclock" - counter-clockwise leading edge of each region expands to border 
    	         +----------------+--+
	         |                |  |
	         +--+-------------|  |
	         |  |             |  |
	         |  |             |  |
	         |  |             |  |
	         |  |-------------+--+
	         |  |                |
	         +--+----------------+
  • "topclock" - top region expands to borders, otherwise clockwise lead edges expand to borders 
    	         +-------------------+
	         |                   |
	         +--+-------------+--+
	         |  |             |  |
	         |  |             |  |
	         |  |             |  |
	         +--+-------------|  |
	         |                |  |
	         +----------------+--+
  • "topcounter" - top region expands to borders, otherwise counter-clockwise lead edges expand to borders 
    	         +-------------------+
	         |                   |
	         +--+-------------+--+
	         |  |             |  |
	         |  |             |  |
	         |  |             |  |
	         |  |-------------+--+
	         |  |                |
	         +--+----------------+
  • "bottomclock" - bottom region expands to borders, otherwise clockwise lead edges expand to borders 
    	         +--+----------------+
	         |  |                |
	         |  |-------------+--+
	         |  |             |  |
	         |  |             |  |
	         |  |             |  |
	         +--+-------------+--+
	         |                   |
	         +-------------------+
  • "bottomcounter" - bottom region expands to borders, otherwise counter-clockwise lead edges expand to borders 
    	         +----------------+--+
	         |                |  |
	         +--+-------------|  |
	         |  |             |  |
	         |  |             |  |
	         |  |             |  |
	         +--+-------------+--+
	         |                   |
	         +-------------------+
  • "leftclock" - left region expands to borders, otherwise clockwise lead edges expand to borders 
    	         +--+----------------+
	         |  |                |
	         |  |-------------+--+
	         |  |             |  |
	         |  |             |  |
	         |  |             |  |
	         |  +-------------|  |
	         |  |             |  |
	         +--+-------------+--+
  • "leftcounter" - left region expands to borders, otherwise counter-clockwise lead edges expand to borders 
    	         +--+-------------+--+
	         |  |             |  |
	         |  +-------------|  |
	         |  |             |  |
	         |  |             |  |
	         |  |             |  |
	         |  +-------------+--+
	         |  |                |
	         +--+----------------+
  • "rightclock" - right region expands to borders, otherwise clockwise lead edges expand to borders 
    	         +--+-------------+--+
	         |  |             |  |
	         |  |-------------|  |
	         |  |             |  |
	         |  |             |  |
	         |  |             |  |
	         +--+-------------|  |
	         |                |  |
	         +----------------+--+
  • "rightcounter" - right region expands to borders, otherwise counter-clockwise lead edges expand to borders 
    	         +----------------+--+
	         |                |  |
	         +--+-------------|  |
	         |  |             |  |
	         |  |             |  |
	         |  |             |  |
	         |  |-------------|  |
	         |  |             |  |
	         +--+-------------+--+
If the right-to-left mode is specified then the following names are also recognized:
  • "leaderbar" - equivalent to "leftbar" in LTR or "rightbar" in RTL
  • "trailerbar" - equivalent to "rightbar" in LTR or "leftbar" in RTL
  • "forward" - equivalent to "clock" in LTR or "counterclock" in RTL
  • "reverse" - equivalent to "counterclock" in RTL or "clock" in RTL
  • "leaderfwd" - equivalent to "leftclock" in LTR or "rightcounter" in RTL
  • "leaderrev" - equivalent to "leftcounter" in LTR or "rightclock" in RTL
  • "trailerfwd" - equivalent to "rightclock" in LTR or "leftcounter" in RTL
  • "trailerrev" - equivalent to "rightcounter" in LTR or "leftclock" in RTL

Method Detail

constructor(name, leftToRight)

Constructs a BorderDesign instance with a name and a boolean indicating whether it is for left-to-right or right-to-left.
Parameters:
{String} name
The name of the BorderDesign (see class documentation for possible values)
{Boolean} leftToRight
If specified then the specified name may use the "leader" and "trailer" variants and a lookup is performed. If not specified then the "leader" and "trailer" names are not allowed. Set to true if for left-to-right, or false if for right-to-left.

<static> idx.border.BorderDesign.create(name, leftToRight)

Similar to the constructor, but if a bad name is provided then null is returned.
Parameters:
{String} name
The name of the border design (see class documentation for possible values).
{Boolean} leftToRight
If specified then the specified name may use the "leader" and "trailer" variants and a lookup is performed. If not specified then the "leader" and "trailer" names are not allowed.