com.jwebmp.plugins.jqlayout.interfaces

Interface IJQLayout<J extends IJQLayout<J>>

All Known Implementing Classes:

BorderLayout

public interface IJQLayout<J extends IJQLayout<J>>

Method Summary

Modifier and Type	Method and Description
@NotNull JQLayoutAddSlideToggleButtonFeature	createAddSlideToggleButton(JQLayoutArea pane, com.jwebmp.core.Component pinButton)
@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)
@NotNull JQLayoutSlideOpenLayoutDivFeature	createSlideOpenFeature(JQLayoutArea pane)
@NotNull JQLayoutSlideToggleLayoutDivFeature	createSlideToggleButton(JQLayoutArea pane)
@NotNull JQLayoutAddToggleButtonFeature	createToggleButton(com.jwebmp.core.Component component, JQLayoutArea pane) Creates a toggle button for the given pane on the component.
@NotNull JQLayoutDiv	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
J	setCenter(JQLayoutDiv centerDiv) Sets the center pane
J	setEast(JQLayoutDiv<?> eastDiv) Sets the center pane
J	setFullScreen(boolean fullScreen)
J	setNorth(JQLayoutDiv<?> centerDiv)
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

Method Detail

getCenter

@NotNull
@NotNull JQLayoutDiv getCenter()

Returns the center pane

Returns:

A Layout pane on the center div

setCenter

@NotNull
J setCenter(JQLayoutDiv centerDiv)

Sets the center pane

Parameters:

centerDiv - The new center panel

createToggleButton

@NotNull
@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

Parameters:

component -

pane -

Returns:

getPane

JQLayoutDiv getPane(JQLayoutArea area)

Gets the layout div for a pane

Parameters:

area -

Returns:

getNorth

JQLayoutDiv<?> getNorth()

Returns the center pane

Returns:

A Layout pane on the center div

setNorth

@NotNull
J setNorth(JQLayoutDiv<?> centerDiv)

getWest

@NotNull
@NotNull JQLayoutDiv<?> getWest()

Returns the center pane

Returns:

A Layout pane on the center div

setWest

@NotNull
J setWest(JQLayoutDiv<?> westDiv)

Sets the center pane

Parameters:

westDiv - The new center panel

getSouth

JQLayoutDiv<?> getSouth()

Returns the south pane

Returns:

A Layout pane on the center div

setSouth

@NotNull
J setSouth(JQLayoutDiv<?> southDiv)

Sets the south pane

Parameters:

southDiv - The new center panel

getEast

@NotNull
@NotNull JQLayoutDiv<?> getEast()

Returns the center pane

Returns:

A Layout pane on the center div

setEast

J setEast(JQLayoutDiv<?> eastDiv)

Sets the center pane

Parameters:

eastDiv - The new center panel

createSlideToggleButton

@NotNull
@NotNull JQLayoutSlideToggleLayoutDivFeature createSlideToggleButton(JQLayoutArea pane)

createAddSlideToggleButton

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

getOptions

@NotNull
@NotNull JQLayoutOptions getOptions()

Returns the layout options

Returns:

createPinButton

@NotNull
@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

Parameters:

component -

pane -

Returns:

createSlideCloseFeature

@NotNull
@NotNull JQLayoutSlideCloseLayoutDivFeature createSlideCloseFeature(JQLayoutArea pane)

createSlideOpenFeature

@NotNull
@NotNull JQLayoutSlideOpenLayoutDivFeature createSlideOpenFeature(JQLayoutArea pane)

createCloseButton

@NotNull
@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

Parameters:

component -

pane -

Returns:

createOpenButton

@NotNull
@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

Parameters:

component -

pane -

Returns:

getVariableID

@NotNull
@NotNull String getVariableID()

Returns the variable ID

Returns:

setVariableID

J setVariableID(@NotNull
                @NotNull String variableID)

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

Parameters:

variableID -

setFullScreen

@NotNull
J setFullScreen(boolean fullScreen)