net.enilink.commons.ui.editor

Class PageBook

java.lang.Object

org.eclipse.swt.widgets.Widget

org.eclipse.swt.widgets.Control

org.eclipse.swt.widgets.Scrollable

org.eclipse.swt.widgets.Composite

net.enilink.commons.ui.editor.PageBook

All Implemented Interfaces:

org.eclipse.swt.graphics.Drawable

public class PageBook
extends org.eclipse.swt.widgets.Composite

PageBook is a class that is capable of stacking several composites (pages), while showing one at a time.

Field Summary

Fields inherited from class org.eclipse.swt.widgets.Composite

embeddedHandle

Fields inherited from class org.eclipse.swt.widgets.Widget

handle

Constructor Summary

Constructors

Constructor and Description
PageBook(org.eclipse.swt.widgets.Composite parent, int style) Creates a new instance in the provided parent and with the provided style.

Method Summary

Modifier and Type	Method and Description
org.eclipse.swt.widgets.Composite	createPage(Object key) Creates a new page for the provided key.
org.eclipse.swt.widgets.Composite	getContainer() Returns the page book container.
org.eclipse.swt.widgets.Control	getCurrentPage() Returns the page currently showing.
boolean	hasPage(Object key) Tests if the page under the provided key is currently in the book.
void	registerPage(Object key, org.eclipse.swt.widgets.Control page) Registers a page under the privided key to be managed by the page book.
void	removePage(Object key) Removes the page under the provided key from the page book.
void	removePage(Object key, boolean showEmptyPage) Removes the page under the provided key from the page book.
void	setBackground(org.eclipse.swt.graphics.Color color)
boolean	setFocus() Sets focus on the current page if shown.
void	setForeground(org.eclipse.swt.graphics.Color color)
void	showEmptyPage() Shows a page with no children to be used if the desire is to not show any registered page.
void	showPage(Object key) Shows the page with the provided key and hides the page previously showing.

Methods inherited from class org.eclipse.swt.widgets.Composite

changed, checkSubclass, drawBackground, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, layout, setBackgroundMode, setLayout, setLayoutDeferred, setTabList

Methods inherited from class org.eclipse.swt.widgets.Scrollable

computeTrim, getClientArea, getHorizontalBar, getScrollbarsMode, getVerticalBar

Methods inherited from class org.eclipse.swt.widgets.Control

addControlListener, addDragDetectListener, addFocusListener, addGestureListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTouchListener, addTraverseListener, computeSize, computeSize, dragDetect, dragDetect, forceFocus, getAccessible, getBackground, getBackgroundImage, getBorderWidth, getBounds, getCursor, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getOrientation, getParent, getRegion, getShell, getSize, getTextDirection, getToolTipText, getTouchEnabled, getVisible, internal_dispose_GC, internal_new_GC, isAutoScalable, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, print, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeGestureListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTouchListener, removeTraverseListener, requestLayout, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setEnabled, setFont, setLayoutData, setLocation, setLocation, setMenu, setOrientation, setParent, setRedraw, setRegion, setSize, setSize, setTextDirection, setToolTipText, setTouchEnabled, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, traverse, traverse, update

Methods inherited from class org.eclipse.swt.widgets.Widget

addDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, getListeners, getStyle, isAutoDirection, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, reskin, setData, setData, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PageBook

public PageBook(org.eclipse.swt.widgets.Composite parent,
                int style)

Creates a new instance in the provided parent and with the provided style.

Parameters:

parent - the control parent

style - the style to use

Method Detail

createPage

public org.eclipse.swt.widgets.Composite createPage(Object key)

Creates a new page for the provided key. Use the returned composite to create children in it.

Parameters:

key - the page key

Returns:

the newly created page composite

getContainer

public org.eclipse.swt.widgets.Composite getContainer()

Returns the page book container.

Returns:

the page book container

getCurrentPage

public org.eclipse.swt.widgets.Control getCurrentPage()

Returns the page currently showing.

Returns:

the current page

hasPage

public boolean hasPage(Object key)

Tests if the page under the provided key is currently in the book.

Parameters:

key - the page key

Returns:

true if page exists, false otherwise.

registerPage

public void registerPage(Object key,
                         org.eclipse.swt.widgets.Control page)

Registers a page under the privided key to be managed by the page book. The page must be a direct child of the page book container.

Parameters:

key - the page key

page - the page composite to register

See Also:

createPage(Object), getContainer()

removePage

public void removePage(Object key)

Removes the page under the provided key from the page book. Does nothing if page with that key does not exist.

Parameters:

key - the page key.

removePage

public void removePage(Object key,
                       boolean showEmptyPage)

Removes the page under the provided key from the page book. Does nothing if page with that key does not exist.

Parameters:

key - the page key.

showEmptyPage - if true, shows the empty page after page removal.

setBackground

public void setBackground(org.eclipse.swt.graphics.Color color)

Overrides:

setBackground in class org.eclipse.swt.widgets.Control

setFocus

public boolean setFocus()

Sets focus on the current page if shown.

Overrides:

setFocus in class org.eclipse.swt.widgets.Composite

setForeground

public void setForeground(org.eclipse.swt.graphics.Color color)

Overrides:

setForeground in class org.eclipse.swt.widgets.Control

showEmptyPage

public void showEmptyPage()

Shows a page with no children to be used if the desire is to not show any registered page.

showPage

public void showPage(Object key)

Shows the page with the provided key and hides the page previously showing. Does nothing if the page with that key does not exist.

Parameters:

key - the page key