com.jwebmp.plugins.jqlayout.interfaces

Interface IJQLayoutDiv<J extends JQLayoutDiv<J>>

All Known Implementing Classes:

JQLayoutDiv

public interface IJQLayoutDiv<J extends JQLayoutDiv<J>>

Method Summary

Modifier and Type	Method and Description
J	addCloseButton(com.jwebmp.core.Component button) Adds the close event to the component
J	addFooter(com.jwebmp.core.base.html.HeaderText footerHeaderText) Adds the footer header
J	addFooter(JQLayoutFooterDiv<?> footerDiv) Adds the footer to the component
J	addFooter(String footerDivString) Adds the footer
J	addHeader(com.jwebmp.core.base.html.HeaderText headerDivString) Adds the header to the layout div
J	addHeader(JQLayoutHeaderDiv<?> headerDiv) Adds the Div as a header and applies the class Widget Header
J	addHeader(String headerDivString) * Adds a new header to the div and applies the Widget Header class
J	addOpenButton(com.jwebmp.core.Component button) Adds the open event to a component
J	addPin(com.jwebmp.core.Component component) Adds a Pin for this Div
J	addToggleButton(com.jwebmp.core.Component button) Adds the open event to a component
@NotNull JQLayoutArea	getArea() Gets the current assigned area
@NotNull JQLayoutContentDiv<?>	getContentDiv() Returns the current content div
@NotNull List<JQLayoutFooterDiv<?>>	getFooters() Returns the footers listing
@NotNull List<JQLayoutHeaderDiv<?>>	getHeaders() Returns a never empty list of header
@NotNull BorderLayout<?>	getLayout() Returns the layout attached to this layout div
@NotNull JQLayoutDefaultOptions	getOptions()
J	removeFooter(JQLayoutFooterDiv<?> footerDiv) Removes the footer
J	removeHeader(JQLayoutHeaderDiv<?> headerDiv) Removes the header
J	setArea(JQLayoutArea area) Sets the current assigned area
J	setContentDiv(JQLayoutContentDiv<?> contentDiv) Sets the content div of this layout
J	setFooters(List<JQLayoutFooterDiv<?>> footers) Sets the footer collection
J	setHeaders(List<JQLayoutHeaderDiv<?>> headers) Sets the headers
J	setLayout(@NotNull BorderLayout<?> layout) Sets the layout for this div

Method Detail

getHeaders

@NotNull
@NotNull List<JQLayoutHeaderDiv<?>> getHeaders()

Returns a never empty list of header

Returns:

getFooters

@NotNull
@NotNull List<JQLayoutFooterDiv<?>> getFooters()

Returns the footers listing

Returns:

setFooters

@NotNull
J setFooters(List<JQLayoutFooterDiv<?>> footers)

Sets the footer collection

Parameters:

footers -

setHeaders

@NotNull
J setHeaders(List<JQLayoutHeaderDiv<?>> headers)

Sets the headers

Parameters:

headers -

addHeader

@NotNull
J addHeader(String headerDivString)

* Adds a new header to the div and applies the Widget Header class

Parameters:

headerDivString -

addHeader

@NotNull
J addHeader(JQLayoutHeaderDiv<?> headerDiv)

Adds the Div as a header and applies the class Widget Header

Parameters:

headerDiv -

addFooter

@NotNull
J addFooter(com.jwebmp.core.base.html.HeaderText footerHeaderText)

Adds the footer header

Parameters:

footerHeaderText -

addPin

@NotNull
J addPin(com.jwebmp.core.Component component)

Adds a Pin for this Div

Parameters:

component -

Returns:

The original component

addToggleButton

@NotNull
J addToggleButton(com.jwebmp.core.Component button)

Adds the open event to a component

Parameters:

button - The component to add the open event to

addCloseButton

@NotNull
J addCloseButton(com.jwebmp.core.Component button)

Adds the close event to the component

Parameters:

button - The button to add a close event to

addFooter

@NotNull
J addFooter(JQLayoutFooterDiv<?> footerDiv)

Adds the footer to the component

Parameters:

footerDiv -

addFooter

@NotNull
J addFooter(String footerDivString)

Adds the footer

Parameters:

footerDivString -

addHeader

@NotNull
J addHeader(com.jwebmp.core.base.html.HeaderText headerDivString)

Adds the header to the layout div

Parameters:

headerDivString -

addOpenButton

@NotNull
J addOpenButton(com.jwebmp.core.Component button)

Adds the open event to a component

Parameters:

button - The component to add the open event to

removeFooter

@NotNull
J removeFooter(JQLayoutFooterDiv<?> footerDiv)

Removes the footer

Parameters:

footerDiv -

removeHeader

@NotNull
J removeHeader(JQLayoutHeaderDiv<?> headerDiv)

Removes the header

Parameters:

headerDiv -

getArea

@NotNull
@NotNull JQLayoutArea getArea()

Gets the current assigned area

Returns:

getContentDiv

@NotNull
@NotNull JQLayoutContentDiv<?> getContentDiv()

Returns the current content div

Returns:

getLayout

@NotNull
@NotNull BorderLayout<?> getLayout()

Returns the layout attached to this layout div

Returns:

setLayout

@NotNull
J setLayout(@NotNull
                     @NotNull BorderLayout<?> layout)

Sets the layout for this div

Parameters:

layout -

setContentDiv

@NotNull
J setContentDiv(JQLayoutContentDiv<?> contentDiv)

Sets the content div of this layout

Parameters:

contentDiv -

setArea

@NotNull
J setArea(JQLayoutArea area)

Sets the current assigned area

Parameters:

area -

getOptions

@NotNull
@NotNull JQLayoutDefaultOptions getOptions()