com.jwebmp.plugins.jqlayout.components

Class BorderLayout<J extends BorderLayout<J>>

java.lang.Object

com.jwebmp.core.base.ComponentBase<J>

com.jwebmp.core.base.ComponentDependancyBase<J>

com.jwebmp.core.base.ComponentFeatureBase<F,J>

com.jwebmp.core.base.ComponentEventBase<F,E,J>

com.jwebmp.core.base.ComponentHTMLBase<F,E,J>

com.jwebmp.core.base.ComponentHTMLAttributeBase<A,F,E,J>

com.jwebmp.core.base.ComponentDataBindingBase<A,F,E,J>

com.jwebmp.core.base.ComponentThemeBase<A,F,E,J>

com.jwebmp.core.base.ComponentHierarchyBase<C,A,F,E,J>

com.jwebmp.core.base.ComponentStyleBase<C,A,F,E,J>

com.jwebmp.core.Component<C,A,F,E,J>

com.jwebmp.core.base.html.Div<com.jwebmp.core.base.interfaces.IComponentHierarchyBase,com.jwebmp.core.base.html.attributes.NoAttributes,com.jwebmp.core.base.html.interfaces.GlobalFeatures,com.jwebmp.core.base.html.interfaces.events.GlobalEvents,J>

com.jwebmp.core.base.html.DivSimple<J>

com.jwebmp.plugins.jqlayout.JQLayoutContentDiv<J>

com.jwebmp.plugins.jqlayout.components.BorderLayout<J>

All Implemented Interfaces:

com.jwebmp.core.base.html.interfaces.children.AreaChildren<com.jwebmp.core.base.interfaces.IComponentHierarchyBase,J>, com.jwebmp.core.base.html.interfaces.children.BodyChildren<com.jwebmp.core.base.interfaces.IComponentHierarchyBase,J>, com.jwebmp.core.base.html.interfaces.children.ImageMapChildren<com.jwebmp.core.base.interfaces.IComponentHierarchyBase,J>, com.jwebmp.core.base.html.interfaces.children.ListItemChildren<com.jwebmp.core.base.interfaces.IComponentHierarchyBase,J>, com.jwebmp.core.base.html.interfaces.GlobalChildren, com.jwebmp.core.base.html.interfaces.LayoutHandler, com.jwebmp.core.base.html.interfaces.LifeCycle, com.jwebmp.core.base.interfaces.IComponentBase<J>, com.jwebmp.core.base.interfaces.IComponentDataBindingBase<J>, com.jwebmp.core.base.interfaces.IComponentDependancyBase<J>, com.jwebmp.core.base.interfaces.IComponentEventBase<com.jwebmp.core.base.html.interfaces.events.GlobalEvents,J>, com.jwebmp.core.base.interfaces.IComponentFeatureBase<com.jwebmp.core.base.html.interfaces.GlobalFeatures,J>, com.jwebmp.core.base.interfaces.IComponentHierarchyBase<com.jwebmp.core.base.interfaces.IComponentHierarchyBase,J>, com.jwebmp.core.base.interfaces.IComponentHTMLAttributeBase<com.jwebmp.core.base.html.attributes.NoAttributes,J>, com.jwebmp.core.base.interfaces.IComponentHTMLBase<J>, com.jwebmp.core.base.interfaces.IComponentStyleBase<J>, com.jwebmp.core.base.interfaces.IComponentThemeBase, com.jwebmp.core.base.interfaces.ICssStructure<J>, IJQLayout<J>, JQLayoutDivChildren<com.jwebmp.core.base.interfaces.IComponentHierarchyBase,J>, Serializable, Cloneable, Comparable<J>, Comparator<J>

public class BorderLayout<J extends BorderLayout<J>>
extends JQLayoutContentDiv<J>
implements IJQLayout<J>

Another name for the JQuery UI Layout

Since:

22 Dec 2016

Version:

1.0

Author:

GedMarc

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BorderLayout() Sets a component as a border layout container

Method Summary

Modifier and Type	Method and Description
IJQLayout	asMe() Returns a clean version of this components options
@NotNull JQLayoutAddSlideToggleButtonFeature	createAddSlideToggleButton(JQLayoutArea pane, com.jwebmp.core.Component pinButton) Creates a toggle button that uses the animation for the given pane on the component.
@NotNull JQLayoutCloseLayoutDivFeature	createCloseButton(com.jwebmp.core.Component component, JQLayoutArea pane) Creates a toggle button for the given pane on the component.
@NotNull JQLayoutOpenLayoutDivFeature	createOpenButton(com.jwebmp.core.Component component, JQLayoutArea pane) Creates a toggle button for the given pane on the component.
@NotNull JQLayoutAddPinButtonFeature	createPinButton(com.jwebmp.core.Component component, JQLayoutArea pane) Creates a toggle button for the given pane on the component.
@NotNull JQLayoutSlideCloseLayoutDivFeature	createSlideCloseFeature(JQLayoutArea pane) Creates a toggle button for the given pane on the component.
@NotNull JQLayoutSlideOpenLayoutDivFeature	createSlideOpenFeature(JQLayoutArea pane) Creates a toggle button for the given pane on the component.
@NotNull JQLayoutSlideToggleLayoutDivFeature	createSlideToggleButton(JQLayoutArea pane) Creates a toggle button that uses the animation for the given pane on the component.
@NotNull JQLayoutAddToggleButtonFeature	createToggleButton(com.jwebmp.core.Component component, JQLayoutArea pane) Creates a toggle button for the given pane on the component.
@NotNull JQLayoutDiv<? extends com.jwebmp.core.base.interfaces.IComponentHierarchyBase>	getCenter() Returns the center pane
@NotNull JQLayoutDiv<?>	getEast() Returns the center pane
JQLayoutDiv<?>	getNorth() Returns the center pane
@NotNull JQLayoutOptions<?>	getOptions() Returns the layout options
JQLayoutDiv	getPane(JQLayoutArea area) Gets the layout div for a pane
JQLayoutDiv<?>	getSouth() Returns the south pane
@NotNull String	getVariableID() Returns the variable ID
@NotNull JQLayoutDiv<?>	getWest() Returns the center pane
boolean	isFullScreen()
void	preConfigure() Configures the feature
J	setCenter(JQLayoutDiv centerDiv) Sets the center pane
J	setEast(JQLayoutDiv<?> eastDiv) Sets the center pane
J	setFullScreen(boolean fullScreen)
J	setID(String id)
J	setNorth(JQLayoutDiv<?> northDiv) Sets the north pane
J	setSouth(JQLayoutDiv<?> southDiv) Sets the south pane
J	setVariableID(@NotNull String variableID) Sets the variable ID.
J	setWest(JQLayoutDiv<?> westDiv) Sets the center pane

Methods inherited from class com.jwebmp.core.Component

add, add, asCSS

Methods inherited from class com.jwebmp.core.base.ComponentStyleBase

addCSSEntry, asStyleBase, destroy, equals, getCss, getCssName, getCssTypeHashMap, hashCode, removeCSSEntry, renderCss, renderCss, setCss, setCssName

Methods inherited from class com.jwebmp.core.base.ComponentHierarchyBase

add, addClass, addClass, addClass, addClass, addTheme, asHierarchyBase, cloneComponent, containsClass, findChild, findEvent, findParent, getAngularObjectsAll, getChildren, getChildrenHierarchy, getChildrenHierarchy, getChildrenHierarchy, getClasses, getCssReferencesAll, getEventsAll, getFeaturesAll, getJavascriptReferencesAll, getPage, getParent, getQueriesAll, getVariablesAll, hasChildren, isNewLineForClosingTag, readChildrenPropertyFirstResult, remove, removeClass, removeClass, renderAfterChildren, renderBeforeChildren, renderChildren, renderClasses, renderJavascriptAll, setChildren, setClasses, setPage, setParent, setTiny, toString, wrap

Methods inherited from class com.jwebmp.core.base.ComponentThemeBase

asThemeBase, getThemes

Methods inherited from class com.jwebmp.core.base.ComponentDataBindingBase

addDto, asAngularBase, bind, cloak, getDto, getJsonObjects

Methods inherited from class com.jwebmp.core.base.ComponentHTMLAttributeBase

addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addStyle, addStyle, asAttributeBase, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttributes, isInvertColonRender, isRenderIDAttibute, removeAttribute, removeAttribute, removeAttribute, renderAttributes, setInvertColonRender, setRenderIDAttribute

Methods inherited from class com.jwebmp.core.base.ComponentHTMLBase

asTagBase, getCurrentTabIndents, getCurrentTabIndentString, getInlineClosingTag, getTag, getText, isClosingTag, isInlineClosingTag, isNewLineForRawText, isRenderTextBeforeChildren, renderAfterTag, renderBeforeTag, renderHTML, setClosingTag, setCurrentTabIndents, setInlineClosingTag, setNewLineForClosingTag, setNewLineForRawText, setRenderTextBeforeChildren, setTag, toString, toString, toTinyString

Methods inherited from class com.jwebmp.core.base.ComponentEventBase

addEvent, asEventBase, checkAssignedFunctions, getEvents, getEventsFor, getEventTypes, removeEvent, setEventType

Methods inherited from class com.jwebmp.core.base.ComponentFeatureBase

addFeature, addQuery, addVariable, asFeatureBase, assignFunctionsToComponent, compare, compareTo, getComponent, getFeatures, getName, getPriority, getQueries, getSortOrder, getVariables, isJavascriptRenderedElsewhere, isRenderAfterLoad, removeFeature, removeVariable, renderJavascript, scriptAvailable, setComponent, setJavascriptRenderedElsewhere, setName, setPriority, setRenderAfterLoad, setSortOrder

Methods inherited from class com.jwebmp.core.base.ComponentDependancyBase

addCssReference, addJavaScriptReference, asDependancyBase, getCssReferences, getCssReferencesAll, getJavascriptReferences, getJavascriptReferencesAll, removeCssReference, removeJavaScriptReference

Methods inherited from class com.jwebmp.core.base.ComponentBase

asBase, getClassCanonicalName, getComponentClass, getComponentType, getID, getID, getJQueryID, getNewLine, getProperties, getProperty, getText, getText, hasProperty, init, isConfigured, isInitialized, isTiny, isTouched, setComponentType, setConfigured, setInitialized, setProperties, setText, setText, setTouched

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.jwebmp.core.base.interfaces.IComponentHierarchyBase

add, add, addClass, addClass, addClass, addClass, addTheme, asAngularBase, asAttributeBase, asBase, asDependancyBase, asEventBase, asFeatureBase, asTagBase, asThemeBase, getAngularObjectsAll, getChildren, getChildrenHierarchy, getChildrenHierarchy, getChildrenHierarchy, getClasses, getCssReferencesAll, getEventsAll, getJavascriptReferencesAll, getPage, getParent, getQueriesAll, getVariablesAll, hasChildren, remove, removeClass, removeClass, renderJavascriptAll, setClasses, setPage, setParent, setTiny, toString, toString

Methods inherited from interface com.jwebmp.core.base.html.interfaces.GlobalChildren

destroy, init, isConfigured, isInitialized

Methods inherited from interface com.jwebmp.core.base.interfaces.IComponentEventBase

asBase, asDependancyBase, asFeatureBase

Methods inherited from interface com.jwebmp.core.base.html.interfaces.LifeCycle

init, isConfigured, isInitialized

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Detail

BorderLayout

public BorderLayout()

Sets a component as a border layout container

Method Detail

setID

@NotNull
public J setID(String id)

Specified by:

setID in interface com.jwebmp.core.base.interfaces.IComponentBase<J extends BorderLayout<J>>

Specified by:

setID in interface com.jwebmp.core.base.interfaces.IComponentHierarchyBase<com.jwebmp.core.base.interfaces.IComponentHierarchyBase,J extends BorderLayout<J>>

Specified by:

setID in interface com.jwebmp.core.base.interfaces.IComponentStyleBase<J extends BorderLayout<J>>

Overrides:

setID in class com.jwebmp.core.base.ComponentHTMLAttributeBase<com.jwebmp.core.base.html.attributes.NoAttributes,com.jwebmp.core.base.html.interfaces.GlobalFeatures,com.jwebmp.core.base.html.interfaces.events.GlobalEvents,J extends BorderLayout<J>>

getOptions

@NotNull
public @NotNull JQLayoutOptions<?> getOptions()

Returns the layout options

Specified by:

getOptions in interface com.jwebmp.core.base.interfaces.IComponentFeatureBase<com.jwebmp.core.base.html.interfaces.GlobalFeatures,J extends BorderLayout<J>>

Specified by:

getOptions in interface IJQLayout<J extends BorderLayout<J>>

Overrides:

getOptions in class com.jwebmp.core.base.ComponentFeatureBase<com.jwebmp.core.base.html.interfaces.GlobalFeatures,J extends BorderLayout<J>>

Returns:

preConfigure

public void preConfigure()

Configures the feature

Specified by:

preConfigure in interface com.jwebmp.core.base.html.interfaces.GlobalChildren

Specified by:

preConfigure in interface com.jwebmp.core.base.html.interfaces.LifeCycle

Specified by:

preConfigure in interface com.jwebmp.core.base.interfaces.IComponentBase<J extends BorderLayout<J>>

Overrides:

preConfigure in class com.jwebmp.core.base.ComponentHierarchyBase<com.jwebmp.core.base.interfaces.IComponentHierarchyBase,com.jwebmp.core.base.html.attributes.NoAttributes,com.jwebmp.core.base.html.interfaces.GlobalFeatures,com.jwebmp.core.base.html.interfaces.events.GlobalEvents,J extends BorderLayout<J>>

getCenter

@NotNull
public final @NotNull JQLayoutDiv<? extends com.jwebmp.core.base.interfaces.IComponentHierarchyBase> getCenter()

Returns the center pane

Specified by:

getCenter in interface IJQLayout<J extends BorderLayout<J>>

Returns:

A Layout pane on the center div

setCenter

@NotNull
public J setCenter(JQLayoutDiv centerDiv)

Sets the center pane

Specified by:

setCenter in interface IJQLayout<J extends BorderLayout<J>>

Parameters:

centerDiv - The new center panel

createToggleButton

@NotNull
public @NotNull JQLayoutAddToggleButtonFeature createToggleButton(com.jwebmp.core.Component component,
                                                                           JQLayoutArea pane)

Creates a toggle button for the given pane on the component.

The feature is added to the component

Specified by:

createToggleButton in interface IJQLayout<J extends BorderLayout<J>>

Parameters:

component -

pane -

Returns:

getPane

public JQLayoutDiv getPane(JQLayoutArea area)

Gets the layout div for a pane

Specified by:

getPane in interface IJQLayout<J extends BorderLayout<J>>

Parameters:

area -

Returns:

getNorth

public JQLayoutDiv<?> getNorth()

Returns the center pane

Specified by:

getNorth in interface IJQLayout<J extends BorderLayout<J>>

Returns:

A Layout pane on the center div

setNorth

@NotNull
public J setNorth(JQLayoutDiv<?> northDiv)

Sets the north pane

Specified by:

setNorth in interface IJQLayout<J extends BorderLayout<J>>

Parameters:

northDiv - The new center panel

getWest

@NotNull
public @NotNull JQLayoutDiv<?> getWest()

Returns the center pane

Specified by:

getWest in interface IJQLayout<J extends BorderLayout<J>>

Returns:

A Layout pane on the center div

setWest

@NotNull
public J setWest(JQLayoutDiv<?> westDiv)

Sets the center pane

Specified by:

setWest in interface IJQLayout<J extends BorderLayout<J>>

Parameters:

westDiv - The new center panel

getSouth

public JQLayoutDiv<?> getSouth()

Returns the south pane

Specified by:

getSouth in interface IJQLayout<J extends BorderLayout<J>>

Returns:

A Layout pane on the center div

setSouth

@NotNull
public J setSouth(JQLayoutDiv<?> southDiv)

Sets the south pane

Specified by:

setSouth in interface IJQLayout<J extends BorderLayout<J>>

Parameters:

southDiv - The new center panel

getEast

@NotNull
public @NotNull JQLayoutDiv<?> getEast()

Returns the center pane

Specified by:

getEast in interface IJQLayout<J extends BorderLayout<J>>

Returns:

A Layout pane on the center div

setEast

public J setEast(JQLayoutDiv<?> eastDiv)

Sets the center pane

Specified by:

setEast in interface IJQLayout<J extends BorderLayout<J>>

Parameters:

eastDiv - The new center panel

createSlideToggleButton

@NotNull
public @NotNull JQLayoutSlideToggleLayoutDivFeature createSlideToggleButton(JQLayoutArea pane)

Creates a toggle button that uses the animation for the given pane on the component.

The feature is added to the component

Specified by:

createSlideToggleButton in interface IJQLayout<J extends BorderLayout<J>>

Parameters:

pane -

Returns:

createAddSlideToggleButton

@NotNull
public @NotNull JQLayoutAddSlideToggleButtonFeature createAddSlideToggleButton(JQLayoutArea pane,
                                                                                        com.jwebmp.core.Component pinButton)

Creates a toggle button that uses the animation for the given pane on the component.

The feature is added to the component

Specified by:

createAddSlideToggleButton in interface IJQLayout<J extends BorderLayout<J>>

Parameters:

pane -

Returns:

createPinButton

@NotNull
public @NotNull JQLayoutAddPinButtonFeature createPinButton(com.jwebmp.core.Component component,
                                                                     JQLayoutArea pane)

Creates a toggle button for the given pane on the component.

The feature is added to the component

Specified by:

createPinButton in interface IJQLayout<J extends BorderLayout<J>>

Parameters:

pane -

Returns:

createSlideCloseFeature

@NotNull
public @NotNull JQLayoutSlideCloseLayoutDivFeature createSlideCloseFeature(JQLayoutArea pane)

Creates a toggle button for the given pane on the component.

The feature is added to the component

Specified by:

createSlideCloseFeature in interface IJQLayout<J extends BorderLayout<J>>

Parameters:

pane -

Returns:

createSlideOpenFeature

@NotNull
public @NotNull JQLayoutSlideOpenLayoutDivFeature createSlideOpenFeature(JQLayoutArea pane)

Creates a toggle button for the given pane on the component.

The feature is added to the component

Specified by:

createSlideOpenFeature in interface IJQLayout<J extends BorderLayout<J>>

Parameters:

pane -

Returns:

createCloseButton

@NotNull
public @NotNull JQLayoutCloseLayoutDivFeature createCloseButton(com.jwebmp.core.Component component,
                                                                         JQLayoutArea pane)

Creates a toggle button for the given pane on the component.

The feature is added to the component

Specified by:

createCloseButton in interface IJQLayout<J extends BorderLayout<J>>

Parameters:

component -

pane -

Returns:

createOpenButton

@NotNull
public @NotNull JQLayoutOpenLayoutDivFeature createOpenButton(com.jwebmp.core.Component component,
                                                                       JQLayoutArea pane)

Creates a toggle button for the given pane on the component.

The feature is added to the component

Specified by:

createOpenButton in interface IJQLayout<J extends BorderLayout<J>>

Parameters:

component -

pane -

Returns:

getVariableID

@NotNull
public @NotNull String getVariableID()

Returns the variable ID

Specified by:

getVariableID in interface IJQLayout<J extends BorderLayout<J>>

Returns:

setVariableID

public final J setVariableID(@NotNull
                             @NotNull String variableID)

Sets the variable ID. Adds 'lay_' in front and takes all hyphens (-) into underscores (_)

Specified by:

setVariableID in interface IJQLayout<J extends BorderLayout<J>>

Parameters:

variableID -

isFullScreen

public boolean isFullScreen()

setFullScreen

@NotNull
public J setFullScreen(boolean fullScreen)

Specified by:

setFullScreen in interface IJQLayout<J extends BorderLayout<J>>

asMe

public IJQLayout asMe()

Returns a clean version of this components options

Returns: