public interface IMultiPageComp
This component is a manager component for multiple IPage
s.
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.
IPage
,
IGuiFactory.newMultiPageComp(List, IPage, javax.swing.JComponent)
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).
|
javax.swing.JComponent asComponent()
JComponent
.this
as a JComponent
void addPage(IPage<?> page)
page
- page to be addedvoid setPageList(java.util.List<IPage<?>> pageList)
pageList
- page list to be setvoid clearHistory()
void rebuildPageTree(boolean clearComponentCache)
clearComponentCache
- tells if cached components have to be discardedboolean selectPage(IPage<?> page)
page
- page to be selectedgetSelectedPage()
IPage<?> getSelectedPage()
null
if no page is selectedselectPage(IPage)
void resizeNavTree()
Note: if navigation tree auto-resize is not enabled, this method will do nothing.
setNavTreeAutoResize(boolean)
void setNavTreeAutoResize(boolean navTreeAutoResize)
true
.navTreeAutoResize
- navigation tree auto-resize property to be setisNavTreeAutoResize()
boolean isNavTreeAutoResize()
setNavTreeAutoResize(boolean)
void setNavTreeMaxAutoWidth(java.lang.Integer navTreeMaxAutoWidth)
null
.navTreeMaxAutoWidth
- optional max auto-width of the navigation tree to be set; a null
value means no maximumgetNavTreeMaxAutoWidth()
java.lang.Integer getNavTreeMaxAutoWidth()
null
means no maximumsetNavTreeMaxAutoWidth(Integer)
This API documentation is public and is intended for / allowed to be used by anyone.
Scelight home page: https://sites.google.com/site/scelight/
Scelight is a trademark of András Belicza. Copyright © András Belicza, 2013-2015. All rights reserved.