com.yospace.yae.yogi
Class YogiPaneletDisplay

java.lang.Object
  |
  +--com.yospace.yae.yogi.YogiComponent
        |
        +--com.yospace.yae.yogi.YogiWindow
              |
              +--com.yospace.yae.yogi.YogiPaneletDisplay

All Implemented Interfaces:

PopupModalRoot

public class YogiPaneletDisplay

extends YogiWindow

implements PopupModalRoot

A YogiComponent which constitutes the view of the Panelet model. A YogiPaneletDisplay has a relevant state property, which is used by the Panelet when searching for a relevant view when the state of the Panelet is changed.
YogiPaneletDisplay is a type of YogiWindow, and therefore has a content pane, and can have title and menu bars associated with it. It is also a PopupModalRoot, and so popups whose component parent are contained by this component might disable this component (and therefore its children) when they are shown.

Field Summary

static int

PROPERTY_RELEVANT_STATE Property identifer for the relevant state.

Fields inherited from class com.yospace.yae.yogi.YogiWindow

PROPERTY_CONTENT_PANE, PROPERTY_MENU_BAR, PROPERTY_TITLE_BAR

Fields inherited from class com.yospace.yae.yogi.YogiComponent

ALIGN_CENTER, ALIGN_LEFT, ALIGN_RIGHT, BORDER_DOTTED, BORDER_NONE, BORDER_PLAIN, BORDER_ROUNDED, BORDER_SOLID, COLOR_BACKGROUND, COLOR_BORDER, COLOR_FOREGROUND, FOCUS_DEFAULT, FOCUS_OFF, FOCUS_ON, PROPERTY_ALIGN, PROPERTY_BORDER_STYLE, PROPERTY_BOUNDS, PROPERTY_COLOR, PROPERTY_CONTEXT_ENABLED, PROPERTY_ENABLED, PROPERTY_FOCUS, PROPERTY_FOCUS_INDEX, PROPERTY_FOCUS_TRAVERSABLE, PROPERTY_FONT, PROPERTY_HOTKEY, PROPERTY_LOCATION, PROPERTY_OPAQUE, PROPERTY_SIZE, PROPERTY_VISIBLE, PROPERTY_X_INSET, PROPERTY_Y_INSET

Constructor Summary

YogiPaneletDisplay()
Sets this panelet display to being a focus domain root, and as having a STATE_UNDEFINED relevant state.

Method Summary

RadioButtonGroup	addNewRadioButtonGroup(java.lang.String name) Adds a new radio button group to the current set of groups associated with the PaneletDisplay, if a group with the given name has not already been added.
YogiComponent	getParent() Overrides inherited method to always return null, thus stopping the application writer from accessing components outside of the confines of the Panelet display.
RadioButtonGroup	getRadioButtonGroup(java.lang.String name) Gets the named radio button group from this PaneletDisplay's collection.
java.util.Hashtable	getRadioButtonGroups() Gets the Hashtable which contains all radio button groups associated with this PaneletDisplay.
int	getRelevantState() Accessor method for the relevant state associated with the panelet display.
int	parseState(java.lang.String stateString) For a given String, selects a state value (from the set defined in Panelet).
void	setRelevantState(int newState) Setter for the relevant state for this panelet display, i.e.

Methods inherited from class com.yospace.yae.yogi.YogiWindow

add, addMenu, getContentPane, getMenu, getMenu, getMenuBar, getTitleBar, remove, remove, removeMenu, removeMenus, setContentPane, setMenuBar, setTitleBar

Methods inherited from class com.yospace.yae.yogi.YogiComponent

_debugPrintComponents, addPropertyChangeListener, bringForwards, bringInFrontOf, bringToFront, contains, containsComponent, ensureVisible, ensureVisible, findComponentAt, findCurrentFocus, findFirstFocus, findFocusDomainRoot, findFocusDomainRootImpl, findHotkeyComponent, findNextFocus, fireActionPerformedEvent, firePropertyChangeEvent, getAlign, getBorderStyle, getBounds, getColor, getColors, getComponent, getComponent, getComponentCount, getComponentIndex, getComponents, getFocusBounds, getFocusIndex, getFont, getGlobalLocation, getHeight, getHotkey, getId, getParent, getTreeLock, getUI, getWidth, getX, getXInset, getY, getYInset, hasFocus, isActive, isContextEnabled, isEnabled, isFocusDomainRoot, isFocusTraversable, isOpaque, isVisible, keyPressed, keyReleased, keyRepeated, paint, paintBackground, paintBorder, paintForeground, pointerDragged, pointerPressed, pointerReleased, removeAll, removePropertyChangeListener, repaint, repaint, repaintAfterRebounding, requestFocus, requestFocus, sendBackwards, sendBehind, sendToBack, setActionListener, setActive, setAlign, setBorderStyle, setBounds, setColor, setColors, setContextEnabled, setDefaultColor, setEnabled, setFocusDomainRoot, setFocusIndex, setFocusTraversable, setFont, setHotkey, setId, setLocation, setNoFocus, setOpaque, setProperty, setSize, setUI, setVisible, setXInset, setYInset, updateUI

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_RELEVANT_STATE

public static final int PROPERTY_RELEVANT_STATE

Property identifer for the relevant state.

Constructor Detail

YogiPaneletDisplay

public YogiPaneletDisplay()

Sets this panelet display to being a focus domain root, and as having a STATE_UNDEFINED relevant state.

Method Detail

getParent

public YogiComponent getParent()

Overrides inherited method to always return null, thus stopping the application writer from accessing components outside of the confines of the Panelet display.

Overrides:

getParent in class YogiComponent

Returns:

null.

setRelevantState

public void setRelevantState(int newState)

Setter for the relevant state for this panelet display, i.e. the state of the panelet that is relevant to this UI. The state must be one of STATE_MINIMIZED, STATE_COMPACT, STATE_MAXIMIZED.

Parameters:

newState - the new state which is relevant to this panelet display.

getRelevantState

public int getRelevantState()

Accessor method for the relevant state associated with the panelet display.

Returns:

the relevant state of the panelet display.

parseState

public int parseState(java.lang.String stateString)

For a given String, selects a state value (from the set defined in Panelet). This method only checks the first three letters of the state String. Thus, if the String is given as "minimaximized" then the state will be set as minimized.

Parameters:

stateString - the String representation of the desired state.

Returns:

the int equivalent of that state.

addNewRadioButtonGroup

public RadioButtonGroup addNewRadioButtonGroup(java.lang.String name)

Adds a new radio button group to the current set of groups associated with the PaneletDisplay, if a group with the given name has not already been added. The groups are stored keyed on the id, and thus each radio button group within a PaneletDisplay namespace must have a unique (non-null) id String.

Parameters:

name - the name to give the new radio button group.

Returns:

the newly created and added radio button group, or, if the name is null, or a group already exists with that name in the collection, null is returned.

getRadioButtonGroup

public RadioButtonGroup getRadioButtonGroup(java.lang.String name)

Gets the named radio button group from this PaneletDisplay's collection.

Parameters:

name - the Id of the radio button group to retrieve.

Returns:

the radio button group with the given name, if found. If the named group is not found, null is returned.

getRadioButtonGroups

public java.util.Hashtable getRadioButtonGroups()

Gets the Hashtable which contains all radio button groups associated with this PaneletDisplay.

Returns:

the Hashtable of groups. null if no groups exist.