public class JQLayoutDefaultOptions<J extends JQLayoutDefaultOptions<J>>
extends com.jwebmp.core.htmlbuilder.javascript.JavaScriptPart<J>
| Constructor and Description |
|---|
JQLayoutDefaultOptions()
Constructs a new Layout Options object
|
| Modifier and Type | Method and Description |
|---|---|
String |
getButtonClass()
buttonClass = "ui-layout-button" (any valid className)
|
JQLayoutDiv<?> |
getContentIgnoreSelector()
contentIgnoreSelector = "ui-layout-ignore" (any valid jQuery selector string)
|
JQLayoutDiv<?> |
getContentSelector()
contentSelector = ".ui-layout-content" (any valid jQuery selector string)
|
Character |
getCustomHotkey()
customHotkey = "" (alphanumeric character OR a charCode)
|
CustomHotkeyModifier |
getCustomHotkeyModifier()
customHotkeyModifier = "SHIFT" ("CTRL", "SHIFT", "CTRL+SHIFT")
|
com.jwebmp.plugins.easingeffects.JQEasingEffects |
getFxName()
fxName = "slide" ("none", "slide", "drop", "scale", customer effect name)
|
com.jwebmp.plugins.easingeffects.JQEasingEffects |
getFxNameClose()
fxName = "slide" ("none", "slide", "drop", "scale", customer effect name)
|
com.jwebmp.plugins.easingeffects.JQEasingEffects |
getFxNameOpen()
fxName = "slide" ("none", "slide", "drop", "scale", customer effect name)
|
com.jwebmp.plugins.easingeffects.JQEasingAnimationEffectsPart<?> |
getFxSettings()
fxSettings = {} (Hash containing fx-settings)
|
com.jwebmp.plugins.easingeffects.JQEasingAnimationEffectsPart<?> |
getFxSettingsClose()
fxSettings = {} (Hash containing fx-settings)
|
com.jwebmp.plugins.easingeffects.JQEasingAnimationEffectsPart<?> |
getFxSettingsOpen()
fxSettings = {} (Hash containing fx-settings)
|
Integer |
getFxSpeed()
fxSpeed = integer - ms
|
Integer |
getFxSpeedClose()
fxSpeed = "normal" ("fast", "normal", "slow", integer - ms)
|
Integer |
getFxSpeedOpen()
fxSpeed = "normal" ("fast", "normal", "slow", integer - ms)
|
JQLayoutDiv |
getLayoutDiv()
Gets the Layout Div for which these options belong
|
@NotNull Integer |
getMaxSize()
Maximum-size limit when resizing a pane (0 = as large as pane can go)
|
@NotNull Integer |
getMinSize()
minSize = 50 (integer - pixels)
|
String |
getOnResize() |
String |
getPaneClass()
paneClass = "ui-layout-pane" (any valid className)
|
JQLayoutDiv<?> |
getPaneSelector()
paneSelector = ".ui-layout-PANE" (any valid jQuery selector string)
|
String |
getResizerClass()
resizerClass = "ui-layout-resizer" (any valid className)
|
com.jwebmp.core.htmlbuilder.css.displays.Cursors |
getResizerCursor()
resizerCursor = "resizer-p" (any valid CSS cursor)
|
Double |
getResizerDragOpacity()
resizerDragOpacity = 1 (decimal value between 0 and 1)
|
JQLayoutResponsiveOptions<?> |
getResponsive()
If the layout is responsive
|
Integer |
getSize()
size = "auto" (N/S) "200" (E/W) ("auto" or integer - pixels)
|
com.jwebmp.core.htmlbuilder.css.displays.Cursors |
getSliderCursor()
sliderCursor = "pointer" (any valid CSS cursor)
|
String |
getSlideTriggerClose()
slideTrigger_close = "mouseout" ("click", "mouseout")
|
String |
getSlideTriggerOpen()
slideTrigger_open = "click" ("click", "dblclick", "mouseover"}
|
Integer |
getSpacingClosed()
Spacing between pane and adjacent pane - when pane is 'open' or 'closed' default 6
|
Integer |
getSpacingOpen()
Spacing between pane and adjacent pane - when pane is 'open' or 'closed'
|
String |
getTogglerAlignClosed()
togglerAlign_open = "center" (position-keyword or integer - pixels) togglerAlign_closed = "center" (position-keyword or integer - pixels)
|
String |
getTogglerAlignOpen()
togglerAlign_open = "center" (position-keyword or integer - pixels) togglerAlign_closed = "center" (position-keyword or integer - pixels)
|
String |
getTogglerClass()
togglerClass = "ui-layout-toggler" (any valid className)
|
String |
getTogglerContentClosed()
togglerContent_open = "" (text or HTML) togglerContent_closed = "" (text or HTML)
|
String |
getTogglerContentOpen() |
Integer |
getTogglerLengthClosed()
togglerLength_closed = 50 (integer - pixels)
|
Integer |
getTogglerLengthOpen()
togglerLength_closed = 50 (integer - pixels)
|
Boolean |
isAnimatePaneSizing()
Enable animation on Pane
|
Boolean |
isClosable()
Pane can open and close
|
Boolean |
isEnableCursorHotkey()
enableCursorHotkey = true (true, false)
|
Boolean |
isHideTogglerOnSlide()
hideTogglerOnSlide = false (true, false)
|
Boolean |
isInitClosed()
initClosed = false (true, false)
|
Boolean |
isInitHidden()
initHidden = false (true, false)
|
Boolean |
isLivePaneResizing()
Show pane resizing or show outline
|
Boolean |
isMaskIframesOnResize()
maskIframesOnResize = true (true, false, jQuery Selector string)
|
Boolean |
isResizable()
When open, pane can be resized
|
Boolean |
isScrollToBookmarkOnLoad()
Scrolls to a bookmark This option handles of bookmarks that are passed on the URL of the page: http://www.site.com/page.html#myBookmark
|
Boolean |
isShowOverflowOnHover()
Scrolls to a bookmark This option handles of bookmarks that are passed on the URL of the page: http://www.site.com/page.html#myBookmark
|
Boolean |
isSlidable()
When closed; pane can 'slide' open over other panes - closes on mouse-out
|
J |
setAnimatePaneSizing(Boolean animatePaneSizing)
Enable animation on Pane
|
J |
setButtonClass(String buttonClass)
buttonClass = "ui-layout-button" (any valid className)
|
J |
setClosable(Boolean closable)
Pane can open and close
|
J |
setContentIgnoreSelector(JQLayoutDiv<?> contentIgnoreSelector)
contentIgnoreSelector = "ui-layout-ignore" (any valid jQuery selector string)
|
J |
setContentSelector(JQLayoutDiv<?> contentSelector)
contentSelector = ".ui-layout-content" (any valid jQuery selector string)
|
J |
setCustomHotkey(Character customHotkey)
customHotkey = "" (alphanumeric character OR a charCode)
|
J |
setCustomHotkeyModifier(CustomHotkeyModifier customHotkeyModifier)
customHotkeyModifier = "SHIFT" ("CTRL", "SHIFT", "CTRL+SHIFT")
|
J |
setEnableCursorHotkey(Boolean enableCursorHotkey)
enableCursorHotkey = true (true, false)
|
J |
setFxName(com.jwebmp.plugins.easingeffects.JQEasingEffects fxName)
fxName = "slide" ("none", "slide", "drop", "scale", customer effect name)
|
J |
setFxNameClose(com.jwebmp.plugins.easingeffects.JQEasingEffects fxNameClose)
fxName = "slide" ("none", "slide", "drop", "scale", customer effect name)
|
J |
setFxNameOpen(com.jwebmp.plugins.easingeffects.JQEasingEffects fxNameOpen)
fxName = "slide" ("none", "slide", "drop", "scale", customer effect name)
|
J |
setFxSettings(com.jwebmp.plugins.easingeffects.JQEasingAnimationEffectsPart<?> fxSettings)
fxSettings = {} (Hash containing fx-settings)
|
J |
setFxSettingsClose(com.jwebmp.plugins.easingeffects.JQEasingAnimationEffectsPart<?> fxSettingsClose)
fxSettings = {} (Hash containing fx-settings)
|
J |
setFxSettingsOpen(com.jwebmp.plugins.easingeffects.JQEasingAnimationEffectsPart<?> fxSettingsOpen)
fxSettings = {} (Hash containing fx-settings)
|
J |
setFxSpeed(Integer fxSpeed)
fxSpeed = "normal" ("fast", "normal", "slow", integer - ms)
|
J |
setFxSpeedClose(Integer fxSpeedClose)
fxSpeed = "normal" ("fast", "normal", "slow", integer - ms)
|
J |
setFxSpeedOpen(Integer fxSpeedOpen)
fxSpeed = "normal" ("fast", "normal", "slow", integer - ms)
|
J |
setHideTogglerOnSlide(Boolean hideTogglerOnSlide)
hideTogglerOnSlide = false (true, false)
|
J |
setInitClosed(Boolean initClosed)
initClosed = false (true, false)
|
J |
setInitHidden(Boolean initHidden)
initHidden = false (true, false)
|
J |
setLayoutDiv(JQLayoutDiv layoutDiv)
Sets the Layout Div for which these options belong
|
J |
setLivePaneResizing(Boolean livePaneResizing)
Show pane resizing or show outline
|
J |
setMaskIframesOnResize(Boolean maskIframesOnResize)
maskIframesOnResize = true (true, false, jQuery Selector string)
|
J |
setMaxSize(Integer maxSize)
Maximum-size limit when resizing a pane (0 = as large as pane can go)
|
J |
setMinSize(Integer minSize)
minSize = 50 (integer - pixels)
|
J |
setOnResize(String onResize) |
J |
setPaneClass(String paneClass)
paneClass = "ui-layout-pane" (any valid className)
|
J |
setPaneSelector(JQLayoutDiv<?> paneSelector)
paneSelector = ".ui-layout-PANE" (any valid jQuery selector string)
|
J |
setResizable(Boolean resizable)
When open, pane can be resized
|
J |
setResizerClass(String resizerClass)
resizerClass = "ui-layout-resizer" (any valid className)
|
J |
setResizerCursor(com.jwebmp.core.htmlbuilder.css.displays.Cursors resizerCursor)
resizerCursor = "resizer-p" (any valid CSS cursor)
|
J |
setResizerDragOpacity(Double resizerDragOpacity)
resizerDragOpacity = 1 (decimal value between 0 and 1)
|
J |
setResponsive(JQLayoutResponsiveOptions<?> responsive)
If the layout is responsive
|
J |
setScrollToBookmarkOnLoad(Boolean scrollToBookmarkOnLoad)
Scrolls to a bookmark This option handles of bookmarks that are passed on the URL of the page: http://www.site.com/page.html#myBookmark
|
J |
setShowOverflowOnHover(Boolean showOverflowOnHover)
Scrolls to a bookmark This option handles of bookmarks that are passed on the URL of the page: http://www.site.com/page.html#myBookmark
|
J |
setSize(Integer size)
size = "auto" (N/S) "200" (E/W) ("auto" or integer - pixels)
|
J |
setSlidable(Boolean slidable)
When closed; pane can 'slide' open over other panes - closes on mouse-out
|
J |
setSliderCursor(com.jwebmp.core.htmlbuilder.css.displays.Cursors sliderCursor)
sliderCursor = "pointer" (any valid CSS cursor)
|
J |
setSlideTriggerClose(String slideTriggerClose)
slideTrigger_close = "mouseout" ("click", "mouseout")
|
J |
setSlideTriggerOpen(String slideTriggerOpen)
slideTrigger_open = "click" ("click", "dblclick", "mouseover"
|
J |
setSpacingClosed(Integer spacingClosed)
Spacing between pane and adjacent pane - when pane is 'open' or 'closed' default 6
|
J |
setSpacingOpen(Integer spacingOpen)
Spacing between pane and adjacent pane - when pane is 'open' or 'closed'
|
J |
setTogglerAlignClosed(String togglerAlignClosed)
togglerAlign_open = "center" (position-keyword or integer - pixels) togglerAlign_closed = "center" (position-keyword or integer - pixels)
|
J |
setTogglerAlignOpen(String togglerAlignOpen)
togglerAlign_open = "center" (position-keyword or integer - pixels) togglerAlign_closed = "center" (position-keyword or integer - pixels)
|
J |
setTogglerClass(String togglerClass)
togglerClass = "ui-layout-toggler" (any valid className)
|
J |
setTogglerContentClosed(com.jwebmp.core.base.ComponentHierarchyBase togglerContentClosed)
togglerContent_open = "" (text or HTML) togglerContent_closed = "" (text or HTML)
|
J |
setTogglerContentOpen(com.jwebmp.core.base.ComponentHierarchyBase togglerContentOpen)
togglerContent_open = "" (text or HTML) togglerContent_closed = "" (text or HTML)
|
J |
setTogglerLengthClosed(Integer togglerLengthClosed)
togglerLength_closed = 50 (integer - pixels)
|
J |
setTogglerLengthOpen(Integer togglerLengthOpen)
/**
togglerLength_closed = 50 (integer - pixels)
|
destroy, From, From, From, From, From, FromToList, FromToList, FromToList, FromToList, FromToList, getFileTemplate, getFileTemplate, getFileTemplate, getFunctionObjectMapper, getJavascriptObjectMapper, getJavascriptObjectReader, getJavascriptType, getJsonObjectMapper, getJsonObjectReader, getReferenceId, init, isConfigured, isInitialized, isRenderEmptyBraces, objectAsString, preConfigure, render, setReferenceId, setRenderEmptyBraces, toAttributes, toString, toStringpublic JQLayoutDefaultOptions()
public String getOnResize()
public Boolean isResizable()
@NotNull public J setResizable(Boolean resizable)
resizable - public Boolean isClosable()
@NotNull public J setClosable(Boolean closable)
closable - public Boolean isSlidable()
@NotNull public J setSlidable(Boolean slidable)
slidable - public Boolean isLivePaneResizing()
@NotNull public J setLivePaneResizing(Boolean livePaneResizing)
livePaneResizing - public Boolean isAnimatePaneSizing()
@NotNull public J setAnimatePaneSizing(Boolean animatePaneSizing)
animatePaneSizing - public Boolean isShowOverflowOnHover()
@NotNull public J setShowOverflowOnHover(Boolean showOverflowOnHover)
showOverflowOnHover - public Boolean isScrollToBookmarkOnLoad()
@NotNull public J setScrollToBookmarkOnLoad(Boolean scrollToBookmarkOnLoad)
scrollToBookmarkOnLoad - public JQLayoutDiv<?> getPaneSelector()
MUST set individually for EACH PANE
Default values are: ".ui-layout-north", ".ui-layout-west", etc. Any valid jQuery selector string can be used - classNames, IDs, etc.
To allow for 'nesting' of layouts, there are rules for how pane-elements are related to the layout-container. More flexibility was added in version 1.1.2 to handle panes are nested inside a 'form' or other element.
Rules for the relationship between a pane and its container:
When an 'ID' is specified for paneSelector, the pane-element only needs to be a descendant of the container – it does NOT have to be a 'child'.
When a 'class-name' is specified for paneSelector, the pane-element must be EITHER: a child of the container, or... a child of a form-element that is a child of the container (must be the 'first form' inside the container)
@NotNull public J setPaneSelector(JQLayoutDiv<?> paneSelector)
MUST set individually for EACH PANE
Default values are: ".ui-layout-north", ".ui-layout-west", etc. Any valid jQuery selector string can be used - classNames, IDs, etc.
To allow for 'nesting' of layouts, there are rules for how pane-elements are related to the layout-container. More flexibility was added in version 1.1.2 to handle panes are nested inside a 'form' or other element.
Rules for the relationship between a pane and its container:
When an 'ID' is specified for paneSelector, the pane-element only needs to be a descendant of the container – it does NOT have to be a 'child'.
When a 'class-name' is specified for paneSelector, the pane-element must be EITHER: a child of the container, or... a child of a form-element that is a child of the container (must be the 'first form' inside the container)
paneSelector - public JQLayoutDiv<?> getContentSelector()
MUST be a 'child' of one of the panes
Selector string for INNER div/element. This div will auto-size so only it scrolls, and not the entire pane.
Same class-name could be used for divs inside all panes.
SEE Content-Scrolling below for more information.
@NotNull public J setContentSelector(JQLayoutDiv<?> contentSelector)
MUST be a 'child' of one of the panes
Selector string for INNER div/element. This div will auto-size so only it scrolls, and not the entire pane.
Same class-name could be used for divs inside all panes.
SEE Content-Scrolling below for more information.
contentSelector - public JQLayoutDiv<?> getContentIgnoreSelector()
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
@NotNull public J setContentIgnoreSelector(JQLayoutDiv<?> contentIgnoreSelector)
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
contentIgnoreSelector - public String getPaneClass()
Used for auto-generated classNames for each 'layout pane':
// default classes applied to the 'west pane'. class="ui-layout-pane ui-layout-pane-west ui-layout-pane-open ui-layout-pane-west-open"
The last two classes change when the pane is closed:
class="... ui-layout-pane-closed ui-layout-pane-west-closed"
@NotNull public J setPaneClass(String paneClass)
Used for auto-generated classNames for each 'layout pane':
// default classes applied to the 'west pane' class="ui-layout-pane ui-layout-pane-west ui-layout-pane-open ui-layout-pane-west-open"
The last two classes change when the pane is closed:
class="... ui-layout-pane-closed ui-layout-pane-west-closed"
paneClass - public String getResizerClass()
Used for auto-generated classNames for each 'resizer-bar':
class="ui-layout-resizer ui-layout-resizer-west ui-layout-resizer-open ui-layout-resizer-west-open"
The last two classes change when the pane is closed:
class="... ui-layout-resizer-closed ui-layout-resizer-west-closed"
If the pane was 'slid open', 2 additional classes are generated:
class="... ui-layout-resizer-sliding ui-layout-resizer-west-sliding"
When a pane is 'resized', the 'real resizer-bar' gets 2 additional classes:
class="... ui-layout-resizer-drag ui-layout-resizer-west-drag"
The 'cloned resizer-bar' – which is actually 'dragged' – gets 2 different styles:
class="... ui-layout-resizer-dragging ui-layout-resizer-west-dragging"
@NotNull public J setResizerClass(String resizerClass)
Used for auto-generated classNames for each 'resizer-bar':
class="ui-layout-resizer ui-layout-resizer-west ui-layout-resizer-open ui-layout-resizer-west-open"
The last two classes change when the pane is closed:
class="... ui-layout-resizer-closed ui-layout-resizer-west-closed"
If the pane was 'slid open', 2 additional classes are generated:
class="... ui-layout-resizer-sliding ui-layout-resizer-west-sliding"
When a pane is 'resized', the 'real resizer-bar' gets 2 additional classes:
class="... ui-layout-resizer-drag ui-layout-resizer-west-drag"
The 'cloned resizer-bar' – which is actually 'dragged' – gets 2 different styles:
class="... ui-layout-resizer-dragging ui-layout-resizer-west-dragging"
resizerClass - public String getTogglerClass()
Used for auto-generated classNames for each 'toggler-button':
class="ui-layout-toggler ui-layout-toggler-open ui-layout-toggler-west ui-layout-toggler-west-open"
The last two classes change when the pane is closed:
class="... ui-layout-toggler-closed ui-layout-toggler-west-closed"
The toggler is 'inside' the resizer, so can also be accessed using those classes:
CSS Rule - hide toggler while resizing .ui-layout-resizer-drag ui-layout-toggler { display: none; }
@NotNull public J setTogglerClass(String togglerClass)
Used for auto-generated classNames for each 'toggler-button':
class="ui-layout-toggler ui-layout-toggler-open ui-layout-toggler-west ui-layout-toggler-west-open"
The last two classes change when the pane is closed:
class="... ui-layout-toggler-closed ui-layout-toggler-west-closed"
The toggler is 'inside' the resizer, so can also be accessed using those classes:
/* CSS Rule - hide toggler while resizing .ui-layout-resizer-drag ui-layout-toggler { display: none; }
togglerClass - public String getButtonClass()
This is used as a prefix when generating classNames for 'custom buttons'. (Do not confuse with normal 'toggler-buttons')
FIRST, the 'type' (action) of the button is appended:
ui-layout-button-toggle ui-layout-button-open ui-layout-button-close ui-layout-button-pin
THEN, the 'pane name' of the button is appended, like:
ui-layout-button-toggle-west ui-layout-button-open-south
Here are the generated styles for a custom 'close-button' for the 'west-pane':
class="ui-layout-button-close ui-layout-button-close-west"
Pin-buttons have additional classes added for 'pin-up' and 'pin-down' states:
class="ui-layout-button-pin ui-layout-button-pin-west ui-layout-button-pin-up ui-layout-button-pin-west-up"
The last two classes change when the pane is 'pinned' (open):
class="... ui-layout-button-pin-down ui-layout-button-pin-west-down"
@NotNull public J setButtonClass(String buttonClass)
This is used as a prefix when generating classNames for 'custom buttons'. (Do not confuse with normal 'toggler-buttons')
FIRST, the 'type' (action) of the button is appended:
ui-layout-button-toggle ui-layout-button-open ui-layout-button-close ui-layout-button-pin
THEN, the 'pane name' of the button is appended, like:
ui-layout-button-toggle-west ui-layout-button-open-south
Here are the generated styles for a custom 'close-button' for the 'west-pane':
class="ui-layout-button-close ui-layout-button-close-west"
Pin-buttons have additional classes added for 'pin-up' and 'pin-down' states:
class="ui-layout-button-pin ui-layout-button-pin-west ui-layout-button-pin-up ui-layout-button-pin-west-up"
The last two classes change when the pane is 'pinned' (open):
class="... ui-layout-button-pin-down ui-layout-button-pin-west-down"
buttonClass - public Integer getSize()
Specifies the initial size of the panes - 'height' for north south panes - 'width' for east and west. If "auto", 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
@NotNull public J setSize(Integer size)
Specifies the initial size of the panes - 'height' for north south panes - 'width' for east and west. If "auto", 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
size - @NotNull public @NotNull Integer getMinSize()
Minimum-size limit when resizing a pane (0 = as small as pane can go)
@NotNull public J setMinSize(Integer minSize)
Minimum-size limit when resizing a pane (0 = as small as pane can go)
minSize - @NotNull public @NotNull Integer getMaxSize()
@NotNull public J setMaxSize(Integer maxSize)
maxSize - public Integer getSpacingClosed()
@NotNull public J setSpacingClosed(Integer spacingClosed)
spacingClosed - public Integer getSpacingOpen()
@NotNull public J setSpacingOpen(Integer spacingOpen)
spacingOpen - public com.jwebmp.core.htmlbuilder.css.displays.Cursors getResizerCursor()
MUST set individually for EACH PANE Default values are: "resize-n", "resize-w", etc.
This is the cursor when the mouse is over the 'resizer-bar'. However, if the mouse is over the 'toggler-button' inside the resizer bar, then the cursor is a 'pointer' - ie, the togglerCursor instead of the resizerCursor.
@NotNull public J setResizerCursor(com.jwebmp.core.htmlbuilder.css.displays.Cursors resizerCursor)
MUST set individually for EACH PANE Default values are: "resize-n", "resize-w", etc.
This is the cursor when the mouse is over the 'resizer-bar'. However, if the mouse is over the 'toggler-button' inside the resizer bar, then the cursor is a 'pointer' - ie, the togglerCursor instead of the resizerCursor.
resizerCursor - public Double getResizerDragOpacity()
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.
@NotNull public J setResizerDragOpacity(Double resizerDragOpacity)
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.
resizerDragOpacity - public com.jwebmp.core.htmlbuilder.css.displays.Cursors getSliderCursor()
Cursor when resizer-bar will trigger 'sliding open' - ie, when pane is 'closed'
@NotNull public J setSliderCursor(com.jwebmp.core.htmlbuilder.css.displays.Cursors sliderCursor)
Cursor when resizer-bar will trigger 'sliding open' - ie, when pane is 'closed'
sliderCursor - public Boolean isMaskIframesOnResize()
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.
If desired, you can mask only specific iframes and/or only when specific panes are resized
@NotNull public J setMaskIframesOnResize(Boolean maskIframesOnResize)
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.
If desired, you can mask only specific iframes and/or only when specific panes are resized
maskIframesOnResize - public String getSlideTriggerOpen()
@NotNull public J setSlideTriggerOpen(String slideTriggerOpen)
slideTriggerOpen - public String getSlideTriggerClose()
Trigger events to 'slide open' and 'slide closed' a pane
@NotNull public J setSlideTriggerClose(String slideTriggerClose)
Trigger events to 'slide open' and 'slide closed' a pane
slideTriggerClose - public Integer getTogglerLengthOpen()
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'
@NotNull public J setTogglerLengthOpen(Integer togglerLengthOpen)
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'
togglerLengthOpen - public Integer getTogglerLengthClosed()
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'
@NotNull public J setTogglerLengthClosed(Integer togglerLengthClosed)
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'
togglerLengthClosed - public Boolean isHideTogglerOnSlide()
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.
You could set this 'false' and use CSS to do the same thing:
@NotNull public J setHideTogglerOnSlide(Boolean hideTogglerOnSlide)
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.
You could set this 'false' and use CSS to do the same thing:
hideTogglerOnSlide - public String getTogglerAlignOpen()
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"
@NotNull public J setTogglerAlignOpen(String togglerAlignOpen)
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"
togglerAlignOpen - public String getTogglerAlignClosed()
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"
@NotNull public J setTogglerAlignClosed(String togglerAlignClosed)
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"
togglerAlignClosed - public String getTogglerContentOpen()
@NotNull public J setTogglerContentOpen(com.jwebmp.core.base.ComponentHierarchyBase togglerContentOpen)
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. The text is wrapped in a SPAN, which is then added inside the toggler DIV. The SPAN classes identify them as either 'open' or 'closed' content:
togglerContentOpen - public String getTogglerContentClosed()
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. The text is wrapped in a SPAN, which is then added inside the toggler DIV. The SPAN classes identify them as either 'open' or 'closed' content:
@NotNull public J setTogglerContentClosed(com.jwebmp.core.base.ComponentHierarchyBase togglerContentClosed)
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. The text is wrapped in a SPAN, which is then added inside the toggler DIV. The SPAN classes identify them as either 'open' or 'closed' content:
togglerContentClosed - public Boolean isEnableCursorHotkey()
If 'true', then 'cursor hotkeys' are enabled. Can be set per-pane if desired.
These default hotkeys cannot be changed - only enabled or disabled.
The cursor/arrow key must be pressed in combination with CTRL -or- SHIFT
Toggle North-pane: CTRL+Up or SHIFT+Up Toggle South-pane: CTRL+Down or SHIFT+Down Toggle West-pane: CTRL+Left or SHIFT+Left Toggle East-pane: CTRL+Right or SHIFT+Right * The SHIFT+ARROW combinations are ignored if pressed while the cursor is in a form field, allowing users to 'select text' — eg: SHIFT+Right in a TEXTAREA
@NotNull public J setEnableCursorHotkey(Boolean enableCursorHotkey)
If 'true', then 'cursor hotkeys' are enabled. Can be set per-pane if desired.
These default hotkeys cannot be changed - only enabled or disabled.
The cursor/arrow key must be pressed in combination with CTRL -or- SHIFT
Toggle North-pane: CTRL+Up or SHIFT+Up Toggle South-pane: CTRL+Down or SHIFT+Down Toggle West-pane: CTRL+Left or SHIFT+Left Toggle East-pane: CTRL+Right or SHIFT+Right * The SHIFT+ARROW combinations are ignored if pressed while the cursor is in a form field, allowing users to 'select text' — eg: SHIFT+Right in a TEXTAREA
enableCursorHotkey - public CustomHotkeyModifier getCustomHotkeyModifier()
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.
@NotNull public J setCustomHotkeyModifier(CustomHotkeyModifier customHotkeyModifier)
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.
customHotkeyModifier - public Character getCustomHotkey()
MUST set individually for EACH PANE
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.
@NotNull public J setCustomHotkey(Character customHotkey)
MUST set individually for EACH PANE
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.
customHotkey - public com.jwebmp.plugins.easingeffects.JQEasingEffects getFxName()
Animation effect for open/close. Choose a preset effect OR can specify a custom fxName as long as you also specify fxSettings
@NotNull public J setFxName(com.jwebmp.plugins.easingeffects.JQEasingEffects fxName)
Animation effect for open/close. Choose a preset effect OR can specify a custom fxName as long as you also specify fxSettings
fxName - public com.jwebmp.plugins.easingeffects.JQEasingEffects getFxNameOpen()
Animation effect for open/close. Choose a preset effect OR can specify a custom fxName as long as you also specify fxSettings
@NotNull public J setFxNameOpen(com.jwebmp.plugins.easingeffects.JQEasingEffects fxNameOpen)
Animation effect for open/close. Choose a preset effect OR can specify a custom fxName as long as you also specify fxSettings
fxNameOpen - public com.jwebmp.plugins.easingeffects.JQEasingEffects getFxNameClose()
Animation effect for open/close. Choose a preset effect OR can specify a custom fxName as long as you also specify fxSettings s
@NotNull public J setFxNameClose(com.jwebmp.plugins.easingeffects.JQEasingEffects fxNameClose)
Animation effect for open/close. Choose a preset effect OR can specify a custom fxName as long as you also specify fxSettings
fxNameClose - public Integer getFxSpeed()
Speed of animations – standard jQuery keyword like 'fast', or a millisecond value.
@NotNull public J setFxSpeed(Integer fxSpeed)
Speed of animations – standard jQuery keyword like 'fast', or a millisecond value.
fxSpeed - public Integer getFxSpeedOpen()
Speed of animations – standard jQuery keyword like 'fast', or a millisecond value.
@NotNull public J setFxSpeedOpen(Integer fxSpeedOpen)
Speed of animations – standard jQuery keyword like 'fast', or a millisecond value.
fxSpeedOpen - public Integer getFxSpeedClose()
Speed of animations – standard jQuery keyword like 'fast', or a millisecond value.
@NotNull public J setFxSpeedClose(Integer fxSpeedClose)
Speed of animations – standard jQuery keyword like 'fast', or a millisecond value.
fxSpeedClose - public com.jwebmp.plugins.easingeffects.JQEasingAnimationEffectsPart<?> getFxSettings()
You can customize the default animation settings by passing new settings, like:
$("body").layout({ fxName: "slide" , fxSettings: { duration: 500, easing: "bounceInOut" } });
@NotNull public J setFxSettings(com.jwebmp.plugins.easingeffects.JQEasingAnimationEffectsPart<?> fxSettings)
You can customize the default animation settings by passing new settings, like:
$("body").layout({ fxName: "slide" , fxSettings: { duration: 500, easing: "bounceInOut" } });
fxSettings - public com.jwebmp.plugins.easingeffects.JQEasingAnimationEffectsPart<?> getFxSettingsOpen()
You can customize the default animation settings by passing new settings, like:
$("body").layout({ fxName: "slide" , fxSettings: { duration: 500, easing: "bounceInOut" } });
@NotNull public J setFxSettingsOpen(com.jwebmp.plugins.easingeffects.JQEasingAnimationEffectsPart<?> fxSettingsOpen)
You can customize the default animation settings by passing new settings, like:
$("body").layout({ fxName: "slide" , fxSettings: { duration: 500, easing: "bounceInOut" } });
fxSettingsOpen - public com.jwebmp.plugins.easingeffects.JQEasingAnimationEffectsPart<?> getFxSettingsClose()
You can customize the default animation settings by passing new settings, like:
$("body").layout({ fxName: "slide" , fxSettings: { duration: 500, easing: "bounceInOut" } });
@NotNull public J setFxSettingsClose(com.jwebmp.plugins.easingeffects.JQEasingAnimationEffectsPart<?> fxSettingsClose)
You can customize the default animation settings by passing new settings, like:
$("body").layout({ fxName: "slide" , fxSettings: { duration: 500, easing: "bounceInOut" } });
fxSettingsClose - public Boolean isInitClosed()
If 'true', then pane is 'closed' when layout is created
@NotNull public J setInitClosed(Boolean initClosed)
If 'true', then pane is 'closed' when layout is created
initClosed - public Boolean isInitHidden()
If 'true', then pane is 'hidden' when layout is created - no resizer or spacing is visible, as if the pane does not exist!
@NotNull public J setInitHidden(Boolean initHidden)
If 'true', then pane is 'hidden' when layout is created - no resizer or spacing is visible, as if the pane does not exist!
initHidden - public final JQLayoutDiv getLayoutDiv()
@NotNull public final J setLayoutDiv(JQLayoutDiv layoutDiv)
layoutDiv - public JQLayoutResponsiveOptions<?> getResponsive()
@NotNull public J setResponsive(JQLayoutResponsiveOptions<?> responsive)
responsive - Copyright © 2019 Marc Magon. All rights reserved.