TIWCGJQLayoutPanelOptions Class

Initializes a new instance of the TIWCGJQLayoutPanelOptions class. (Overrides TIWCGJSon.CreateSingle(TPersistent,string).)

When this is enabled, the layout will apply basic styles directly to resizers & buttons. This is intended for quick mock-ups, so that you can 'see' your layout immediately.

This is used as a prefix when generating classNames for 'custom buttons'

Can a pane be closed?

Selector string for INNER divs/elements. These elements will be 'ignored' when calculations are done to auto-size the content element. This may be necessary if there are elements inside the pane that are absolutely-positioned and intended to 'overlay' other elements. Same class-name could be used for elements inside all panes

If a hotkey is specified, it is automatically enabled. It does not matter whether 'cursor hotkeys' are also enabled – those are separate. You can specify any of the following values: letter from A to Z number from 0 to 9 Javascript charCode value for the key The customHotkeys option must be set separately for each pane, but the customHotkeyModifier option can be set once, as the 'default' for all panes.

Custom hotkeys must be pressed in combination with either the CTRL or SHIFT key - or both together. Use this option to choose which modifier-key(s) to use with the customHotKey. If this option is missing or invalid, "CTRL+SHIFT" is assumed. NOTE: The ALT key cannot be used because it is not detected by some browsers.

If 'true', then 'cursor hotkeys' are enabled. Can be set per-pane if desired. These default hotkeys cannot be changed - only enabled or disabled.

See author documentation.

Animation effect for open/close.

You can customize the default animation settings by passing new settings: See author documentation

Speed of animations – standard jQuery keyword like 'fast', or a millisecond value.

If true, the toggler-button is hidden when a pane is 'slid-open'. This makes sense because the user only needs to 'mouse-off' to close the pane.

If 'true', then pane is 'closed' when layout is created

If 'true', then pane is 'hidden' when layout is created - no resizer or spacing is visible, as if the pane does not exist!

When enabled, layout will 'mask' iframes on the page when the resizer-bar is 'dragged' to resize a pane. This solved problems related to dragging an element over an iframe.

Maximum-size limit when resizing a pane (0 = as large as pane can go)

Minimum-size limit when resizing a pane (0 = as small as pane can go)

Callback function name - activate when pane is 'closed'

Callback function name - activate when pane is 'closed'

Callback function name - activate when pane is 'closed'

Callback function name - activate when pane is 'closed'

Callback function name - activate when pane is 'opened'

Callback function name - activate when pane is 'opened'

Callback function name - activate when pane is 'resized' - either manually or as a result of the container resizing.

Callback function name - activate when pane is 'resized' - either manually or as a result of the container resizing.

Callback function name - activate when pane is 'opened'

Callback function name - activate when pane is 'opened'

Represents property PanelType.

When open, can a pane be resized?

Used for auto-generated classNames for each 'resizer-bar'

Opacity of resizer bar when 'dragging' to resize a pane. This value is passed to the ui.draggable widget Leave this set to '1' if you want to use CSS to control opacity. Otherwise you must use !important to override the specified opacity.

Tip when resizer-bar can be 'dragged' to resize a pane

This option handles of bookmarks that are passed on the URL of the page: http://www.site.com/page.html#myBookmark The default functionality of bookmarks is broken when using a layout because the position and scrolling of pane elements are altered after the page loads. Enabling this option (enabled by default) causes the bookmark to be re-applied after the layout is created, causing the 'pane' containing the bookmark/anchor to be scrolled to bring it into view. This option should be left enabled in most cases, but if content in the layout-panes is never bookmarked, then you could disabled it.

If 'true', then when moused-over, the pane's zIndex is raised and overflow is set to 'visible'. This allows pop-ups and drop-downs to overlap adjacent panes. WARNING: Enable this only for panes that do not scroll!

Specifies the initial size of the panes - 'height' for north & south panes - 'width' for east and west. If "0", then pane will size to fit its content - most useful for north/south panes (to auto-fit your banner or toolbar), but also works for east/west panes. You normally will want different sizes for the panes, but a 'default size' can be set

When closed, can a pane 'slide open' over adjacent panes?

Cursor when resizer-bar will trigger 'sliding open' - ie, when pane is 'closed'

Tip when the resizer-bar will trigger 'sliding open'

Trigger events to 'slide open' and 'slide closed' a pane

Trigger events to 'slide open' and 'slide closed' a pane

Spacing between pane and adjacent pane - when pane is 'open' or 'closed'

Spacing between pane and adjacent pane - when pane is 'open' or 'closed'

Alignment of toggler button inside the resizer-bar when pane is 'open' or 'closed'. A positive integer means a pixel offset from top or left A negative integer means a pixel offset from bottom or right Position-Keywords: "left", "center", "right", "top", "middle", "bottom"

Alignment of toggler button inside the resizer-bar when pane is 'open' or 'closed'. A positive integer means a pixel offset from top or left A negative integer means a pixel offset from bottom or right Position-Keywords: "left", "center", "right", "top", "middle", "bottom"

Used for auto-generated classNames for each 'toggler-button'

Usually a background-image is set in CSS to customize a toggler-button. However, you can also put text inside a toggler by using these options.

See author documentation.

Usually a background-image is set in CSS to customize a toggler-button. However, you can also put text inside a toggler by using these options.

See author documentation.

Length of toggler-button when pane is 'open' or 'closed'. Length means 'width' for north/south togglers, and 'height' for east/west togglers. "100%" OR -1 means 'full height/width of resizer bar' - 0 means 'hidden'

Length of toggler-button when pane is 'open' or 'closed'. Length means 'width' for north/south togglers, and 'height' for east/west togglers. "100%" OR -1 means 'full height/width of resizer bar' - 0 means 'hidden'

Tip on toggler when pane is 'open' or 'closed'.

Tip on toggler when pane is 'open' or 'closed'.

True - trigger onopen OR onclose callbacks when layout initializes

Represents method ClosePanel.

Represents method HidePanel.

Represents method jsClosePanel.

Represents method jsHidePanel.

Represents method jsOpenPanel.

Represents method jsResizeContent.

Represents method jsShowPanel(boolean).

Represents method jsSizePanel(Integer).

Represents method jsTogglePanel.

Represents method OpenPanel.

Represents method ResizeContent.

Represents method ShowPanel(boolean).

Represents method SizePanel(Integer).

Represents method TogglePanel.