javax.rad.genui.container
Class UISplitPanel

java.lang.Object
  javax.rad.genui.UIResource<C>
      javax.rad.genui.UIComponent<C>
          javax.rad.genui.UIContainer<ISplitPanel>
              javax.rad.genui.container.UISplitPanel

All Implemented Interfaces:

ITranslatable, ISplitPanel, IComponent, IContainer, IResource, INamedObject, ITranslator

public class UISplitPanel
extends UIContainer<ISplitPanel>
implements ISplitPanel

Platform and technology independent SplitPanel. It is designed for use with AWT, Swing, SWT, JSP, JSF, ... .

Field Summary

Fields inherited from class javax.rad.genui.UIContainer

allComponents, components

Fields inherited from class javax.rad.genui.UIComponent

bTranslate, lLastTranslationModified, parent, popupMenu

Fields inherited from class javax.rad.genui.UIResource

uiResource

Fields inherited from interface javax.rad.ui.container.ISplitPanel

DIVIDER_BOTTOM_RIGHT, DIVIDER_RELATIVE, DIVIDER_TOP_LEFT, FIRST_COMPONENT, SECOND_COMPONENT, SPLIT_LEFT_RIGHT, SPLIT_TOP_BOTTOM

Constructor Summary

	UISplitPanel() Creates a new instance of UISplitPanel.
	UISplitPanel(int pOrientation) Creates a new instance of UISplitPanel with the given orientation.
	UISplitPanel(int pOrientation, int pAlignment) Creates a new instance of UISplitPanel with the given orientation and alignment.
protected	UISplitPanel(ISplitPanel pPanel) Creates a new instance of UISplitPanel with the given split panel.
protected	UISplitPanel(ISplitPanel pPanel, int pOrientation, int pAlignment) Creates a new instance of UISplitPanel with the given split panel, orientation and divider alignment.

Method Summary

void	add(IComponent pComponent, java.lang.Object pConstraints, int pIndex) Adds the specified IComponent to this container with the specified constraints at the specified index.
int	getDividerAlignment() Gets the divider alignment.
int	getDividerPosition() Gets the position of the divider.
IComponent	getFirstComponent() Returns the component to the left (or above) the divider.
int	getOrientation() Returns the orientation.
IComponent	getSecondComponent() Returns the component to the right (or below) the divider.
void	remove(int pIndex) Removes the IComponent, specified by index, from this container.
void	setDividerAlignment(int pDividerAlignment) Sets the divider alignment.
void	setDividerPosition(int pDividerPosition) Sets the position of the divider.
void	setFirstComponent(IComponent pComponent) Sets the component to the left (or above) the divider.
void	setOrientation(int pOrientation) Sets the orientation, or how the splitter is divided.
void	setSecondComponent(IComponent pComponent) Sets the component to the right (or below) the divider.

Methods inherited from class javax.rad.genui.UIContainer

add, add, add, addInternal, addNotify, beforeAddNotify, checkAdd, contains, getComponent, getComponentCount, getComponents, getInsets, getLayout, getUIResourceContainer, indexOf, remove, removeAll, removeInternal, removeNotify, setLayout, setUIResourceContainer, setZOrder, updateTranslation

Methods inherited from class javax.rad.genui.UIComponent

capture, createComponentName, createComponentNamePrefix, debug, doEventKey, doTriggerPopMenu, equals, error, eventComponentMoved, eventComponentResized, eventFocusGained, eventFocusLost, eventKey, eventKeyPressed, eventKeyReleased, eventKeyTyped, eventMouseClicked, eventMouseEntered, eventMouseExited, eventMousePressed, eventMouseReleased, getBackground, getBounds, getComponentUIResource, getCurrentTranslation, getCursor, getDefaultName, getEventSource, getExistingNames, getFactory, getFont, getForeground, getLocation, getLocationOffset, getLocationRelativeTo, getMaximumSize, getMinimumSize, getName, getParent, getPopupMenu, getPreferredSize, getResource, getRootName, getSize, getStyle, getTabIndex, getToolTipText, getTranslation, getUIComponent, hashCode, incrementNameIfExists, info, invokeAndWait, invokeAndWait, invokeInThread, invokeInThread, invokeLater, invokeLater, isBackgroundSet, isBeforeNotified, isCursorSet, isEnabled, isFocusable, isFontSet, isForegroundSet, isMaximumSizeSet, isMinimumSizeSet, isNotified, isPreferredSizeSet, isTranslationChanged, isTranslationEnabled, isVisible, requestFocus, setBackground, setBounds, setBounds, setCursor, setDefaultName, setEnabled, setEventSource, setFocusable, setFont, setForeground, setLocation, setLocation, setLocationRelativeTo, setMaximumSize, setMaximumSize, setMinimumSize, setMinimumSize, setName, setParent, setPopupMenu, setPreferredSize, setPreferredSize, setRootName, setSize, setSize, setStyle, setTabIndex, setToolTipText, setTranslation, setTranslationEnabled, setUIComponent, setVisible, translate

Methods inherited from class javax.rad.genui.UIResource

eventResourceChanged, eventResourceChanged, fireResourceChanged, getObject, getObjectNames, getUIResource, hasResourceHandler, putObject, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.rad.ui.IContainer

add, add, add, getComponent, getComponentCount, getLayout, indexOf, remove, removeAll, setLayout

Methods inherited from interface javax.rad.ui.IComponent

capture, eventComponentMoved, eventComponentResized, eventFocusGained, eventFocusLost, eventKeyPressed, eventKeyReleased, eventKeyTyped, eventMouseClicked, eventMouseEntered, eventMouseExited, eventMousePressed, eventMouseReleased, getBackground, getBounds, getCursor, getEventSource, getFactory, getFont, getForeground, getLocation, getLocationRelativeTo, getMaximumSize, getMinimumSize, getName, getParent, getPreferredSize, getSize, getStyle, getTabIndex, getToolTipText, isBackgroundSet, isCursorSet, isEnabled, isFocusable, isFontSet, isForegroundSet, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isVisible, requestFocus, setBackground, setBounds, setCursor, setEnabled, setEventSource, setFocusable, setFont, setForeground, setLocation, setLocationRelativeTo, setMaximumSize, setMinimumSize, setName, setParent, setPreferredSize, setSize, setStyle, setTabIndex, setToolTipText, setVisible

Methods inherited from interface javax.rad.ui.IResource

getResource

Constructor Detail

UISplitPanel

public UISplitPanel()

Creates a new instance of UISplitPanel.

See Also:

ISplitPanel

UISplitPanel

public UISplitPanel(int pOrientation)

Creates a new instance of UISplitPanel with the given orientation.

Parameters:

pOrientation - the orientation

See Also:

setOrientation(int)

UISplitPanel

public UISplitPanel(int pOrientation,
                    int pAlignment)

Creates a new instance of UISplitPanel with the given orientation and alignment.

Parameters:

pOrientation - the orientation

pAlignment - the divider alignment

See Also:

setOrientation(int), setDividerAlignment(int)

UISplitPanel

protected UISplitPanel(ISplitPanel pPanel)

Creates a new instance of UISplitPanel with the given split panel.

Parameters:

pPanel - the split panel

See Also:

ISplitPanel

UISplitPanel

protected UISplitPanel(ISplitPanel pPanel,
                       int pOrientation,
                       int pAlignment)

Creates a new instance of UISplitPanel with the given split panel, orientation and divider alignment.

Parameters:

pPanel - the split panel

pOrientation - the orientation

pAlignment - the divider alignment

See Also:

ISplitPanel

Method Detail

getOrientation

public int getOrientation()

Returns the orientation.

Specified by:

getOrientation in interface ISplitPanel

Returns:

an integer giving the orientation

See Also:

ISplitPanel.setOrientation(int)

setOrientation

public void setOrientation(int pOrientation)

Sets the orientation, or how the splitter is divided. The options are:

• SPLIT_TOP_BOTTOM (above/below orientation of components)
• SPLIT_LEFT_RIGHT (left/right orientation of components)

Specified by:

setOrientation in interface ISplitPanel

Parameters:

pOrientation - an integer specifying the orientation

getFirstComponent

public IComponent getFirstComponent()

Returns the component to the left (or above) the divider.

Specified by:

getFirstComponent in interface ISplitPanel

Returns:

the IComponent displayed in that position

setFirstComponent

public void setFirstComponent(IComponent pComponent)

Sets the component to the left (or above) the divider.

Specified by:

setFirstComponent in interface ISplitPanel

Parameters:

pComponent - the IComponent to display in that position

getSecondComponent

public IComponent getSecondComponent()

Returns the component to the right (or below) the divider.

Specified by:

getSecondComponent in interface ISplitPanel

Returns:

the Component displayed in that position

setSecondComponent

public void setSecondComponent(IComponent pComponent)

Sets the component to the right (or below) the divider.

Specified by:

setSecondComponent in interface ISplitPanel

Parameters:

pComponent - the IComponent to display in that position

add

public void add(IComponent pComponent,
                java.lang.Object pConstraints,
                int pIndex)

Adds the specified IComponent to this container with the specified constraints at the specified index. Also notifies the layout manager to add the component to the this container's layout using the specified constraints object.

Specified by:

add in interface IContainer

Overrides:

add in class UIContainer<ISplitPanel>

Parameters:

pComponent - the IComponent to be added

pConstraints - an object expressing layout contraints for this

pIndex - the position in the container's list at which to insert the IComponent; -1 means insert at the end component

See Also:

IComponent

remove

public void remove(int pIndex)

Removes the IComponent, specified by index, from this container. This method also notifies the layout manager to remove the component from this container's layout via the removeLayoutComponent method.

Specified by:

remove in interface IContainer

Overrides:

remove in class UIContainer<ISplitPanel>

Parameters:

pIndex - the index of the IComponent to be removed

See Also:

IContainer.add(javax.rad.ui.IComponent), IContainer.getComponentCount()

getDividerPosition

public int getDividerPosition()

Gets the position of the divider.

Specified by:

getDividerPosition in interface ISplitPanel

Returns:

the position of the divider.

setDividerPosition

public void setDividerPosition(int pDividerPosition)

Sets the position of the divider.

Specified by:

setDividerPosition in interface ISplitPanel

Parameters:

pDividerPosition - the position of the divider.

getDividerAlignment

public int getDividerAlignment()

Gets the divider alignment.

Specified by:

getDividerAlignment in interface ISplitPanel

Returns:

the divider alignment: ISplitPanel.DIVIDER_TOP_LEFT, ISplitPanel.DIVIDER_BOTTOM_RIGHT, ISplitPanel.DIVIDER_RELATIVE

setDividerAlignment

public void setDividerAlignment(int pDividerAlignment)

Sets the divider alignment.

Specified by:

setDividerAlignment in interface ISplitPanel

Parameters:

pDividerAlignment - the divider alignment: ISplitPanel.DIVIDER_TOP_LEFT, ISplitPanel.DIVIDER_BOTTOM_RIGHT, ISplitPanel.DIVIDER_RELATIVE