hu.scelightapibase.gui.comp.multipage

Interface IMultiPageComp

public interface IMultiPageComp

A multi-page component.

This component is a manager component for multiple IPages.
A hierarchical tree component is displayed on the left for navigation and page list.
It also has some controls like "Previous Page" and "Next Page" to help the navigation.

Author:

Andras Belicza

See Also:

IPage, IGuiFactory.newMultiPageComp(List, IPage, javax.swing.JComponent)

Method Summary

Methods

Modifier and Type	Method and Description
void	addPage(IPage<?> page) Adds a new top-level page and rebuilds the page tree (cached page components will NOT be discarded).
javax.swing.JComponent	asComponent() Casts this instance to JComponent.
void	clearHistory() Clears the page history.
java.lang.Integer	getNavTreeMaxAutoWidth() Returns the the max auto-width of the navigation tree.
IPage<?>	getSelectedPage() Returns the currently selected page.
boolean	isNavTreeAutoResize() Tells if the navigation tree is auto-resized.
void	rebuildPageTree(boolean clearComponentCache) Rebuilds the page tree.
void	resizeNavTree() Performs a navigation tree auto-resize.
boolean	selectPage(IPage<?> page) Selects the specified page.
void	setNavTreeAutoResize(boolean navTreeAutoResize) Sets the navigation tree auto-resize property. The default value is true.
void	setNavTreeMaxAutoWidth(java.lang.Integer navTreeMaxAutoWidth) Sets the max auto-width of the navigation tree. The default value is null.
void	setPageList(java.util.List<IPage<?>> pageList) Sets the page list and rebuilds the page tree (cached page components will be discarded).

Method Detail

asComponent

javax.swing.JComponent asComponent()

Casts this instance to JComponent.

Returns:

this as a JComponent

addPage

void addPage(IPage<?> page)

Adds a new top-level page and rebuilds the page tree (cached page components will NOT be discarded).

Parameters:

page - page to be added

setPageList

void setPageList(java.util.List<IPage<?>> pageList)

Sets the page list and rebuilds the page tree (cached page components will be discarded).

Parameters:

pageList - page list to be set

clearHistory

void clearHistory()

Clears the page history.

rebuildPageTree

void rebuildPageTree(boolean clearComponentCache)

Rebuilds the page tree.

Parameters:

clearComponentCache - tells if cached components have to be discarded

selectPage

boolean selectPage(IPage<?> page)

Selects the specified page.

Parameters:

page - page to be selected

Returns:

true if the page was found and selected; false otherwise

See Also:

getSelectedPage()

getSelectedPage

IPage<?> getSelectedPage()

Returns the currently selected page.

Returns:

the currently selected page; or null if no page is selected

See Also:

selectPage(IPage)

resizeNavTree

void resizeNavTree()

Performs a navigation tree auto-resize.

Note: if navigation tree auto-resize is not enabled, this method will do nothing.

See Also:

setNavTreeAutoResize(boolean)

setNavTreeAutoResize

void setNavTreeAutoResize(boolean navTreeAutoResize)

Sets the navigation tree auto-resize property.
The default value is true.

Parameters:

navTreeAutoResize - navigation tree auto-resize property to be set

See Also:

isNavTreeAutoResize()

isNavTreeAutoResize

boolean isNavTreeAutoResize()

Tells if the navigation tree is auto-resized.

Returns:

true if the navigation tree is auto-resized; false otherwise

See Also:

setNavTreeAutoResize(boolean)

setNavTreeMaxAutoWidth

void setNavTreeMaxAutoWidth(java.lang.Integer navTreeMaxAutoWidth)

Sets the max auto-width of the navigation tree.
The default value is null.

Parameters:

navTreeMaxAutoWidth - optional max auto-width of the navigation tree to be set; a null value means no maximum

See Also:

getNavTreeMaxAutoWidth()

getNavTreeMaxAutoWidth

java.lang.Integer getNavTreeMaxAutoWidth()

Returns the the max auto-width of the navigation tree.

Returns:

the the max auto-width of the navigation tree; null means no maximum

See Also:

setNavTreeMaxAutoWidth(Integer)