com.alee.extended.tab

Class SplitData<T extends DocumentData>

java.lang.Object

com.alee.extended.tab.SplitData<T>

All Implemented Interfaces:

StructureData<T>

public final class SplitData<T extends DocumentData>
extends java.lang.Object
implements StructureData<T>

Data for single split pane within document pane. It basically contains split pane and links to two other elements contained within split pane.

See Also:

How to use WebDocumentPane, WebDocumentPane

Field Summary

Fields

Modifier and Type	Field and Description
protected StructureData	first First split element.
protected StructureData	last Last split element.
protected int	orientation Split orientation.
protected WebSplitPane	splitPane Actual split component.

Constructor Summary

Constructors

Constructor and Description
SplitData(WebDocumentPane<T> documentPane, int orientation, StructureData first, StructureData last) Constructs new SplitData.

Method Summary

Modifier and Type	Method and Description
void	changeOrientation() Changes split orientation.
protected WebSplitPane	createSplit(int orientation, StructureData first, StructureData last) Returns new split component.
PaneData<T>	findClosestPane() Returns closest PaneData.
java.awt.Component	getComponent() Returns actual component behind this structure element.
double	getDividerLocation() Returns proportional split divider location.
WebDocumentPane	getDocumentPane() Returns parent WebDocumentPane.
StructureData	getFirst() Returns first split element.
StructureData	getLast() Returns last split element.
int	getOrientation() Returns split orientation.
WebSplitPane	getSplitPane() Returns actual split component.
void	replace(StructureData element, StructureData replacement) Replaces specified element with new one.
void	setDividerLocation(double location) Sets proportional split divider location.
void	setFirst(StructureData first) Sets first split element.
void	setLast(StructureData last) Sets last split element.
void	setOrientation(int orientation) Sets split orientation.
void	swapSides() Swaps side components.
protected void	updateSplitPaneCustomizer(WebDocumentPane<T> documentPane) Updates split customizer.

Methods inherited from class java.lang.Object

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

Field Detail

splitPane

protected final WebSplitPane splitPane

Actual split component.

orientation

protected int orientation

Split orientation.

first

protected StructureData first

First split element.

last

protected StructureData last

Last split element.

Constructor Detail

SplitData

public SplitData(WebDocumentPane<T> documentPane,
                 int orientation,
                 StructureData first,
                 StructureData last)

Constructs new SplitData.

Parameters:

documentPane - parent WebDocumentPane

orientation - split orientation

first - first split element

last - last split element

Method Detail

createSplit

protected WebSplitPane createSplit(int orientation,
                                   StructureData first,
                                   StructureData last)

Returns new split component.

Parameters:

orientation - split orientation

first - first split element

last - last split element @return new split component

Returns:

new split component

updateSplitPaneCustomizer

protected void updateSplitPaneCustomizer(WebDocumentPane<T> documentPane)

Updates split customizer.

Parameters:

documentPane - parent WebDocumentPane

getComponent

public java.awt.Component getComponent()

Description copied from interface: StructureData

Returns actual component behind this structure element.

Specified by:

getComponent in interface StructureData<T extends DocumentData>

Returns:

actual component behind this structure element

findClosestPane

public PaneData<T> findClosestPane()

Description copied from interface: StructureData

Returns closest PaneData. Used to provide default active pane.

Specified by:

findClosestPane in interface StructureData<T extends DocumentData>

Returns:

closest PaneData

getDocumentPane

public WebDocumentPane getDocumentPane()

Returns parent WebDocumentPane.

Returns:

parent WebDocumentPane

getSplitPane

public WebSplitPane getSplitPane()

Returns actual split component.

Returns:

actual split component

getOrientation

public int getOrientation()

Returns split orientation.

Returns:

split orientation

setOrientation

public void setOrientation(int orientation)

Sets split orientation.

Parameters:

orientation - new split orientation

changeOrientation

public void changeOrientation()

Changes split orientation.

swapSides

public void swapSides()

Swaps side components.

getDividerLocation

public double getDividerLocation()

Returns proportional split divider location.

Returns:

proportional split divider location

setDividerLocation

public void setDividerLocation(double location)

Sets proportional split divider location.

Parameters:

location - new proportional split divider location

getFirst

public StructureData getFirst()

Returns first split element.

Returns:

first split element

setFirst

public void setFirst(StructureData first)

Sets first split element.

Parameters:

first - new first split element

getLast

public StructureData getLast()

Returns last split element.

Returns:

last split element

setLast

public void setLast(StructureData last)

Sets last split element.

Parameters:

last - new last split element

replace

public void replace(StructureData element,
                    StructureData replacement)

Replaces specified element with new one.

Parameters:

element - element to replace

replacement - element replacement