nextapp.echo.extras.app
Class Group

java.lang.Object
  nextapp.echo.app.Component
      nextapp.echo.extras.app.Group

All Implemented Interfaces:

java.io.Serializable, nextapp.echo.app.RenderIdSupport

public class Group
extends nextapp.echo.app.Component

Group component: A container which renders a border consisting of images around its content. Optionally draws a title in the top border. May contain one child component. May not contain a Pane component as a child.

Author:

n.beekman

See Also:

Serialized Form

Field Summary

static int	BOTTOM
static int	BOTTOM_LEFT
static int	BOTTOM_RIGHT
static int	LEFT
static java.lang.String	PROPERTY_BACKGROUND_IMAGE
static java.lang.String	PROPERTY_BORDER_IMAGE
static java.lang.String	PROPERTY_BORDER_INSETS
static java.lang.String	PROPERTY_INSETS
static java.lang.String	PROPERTY_TITLE
static java.lang.String	PROPERTY_TITLE_BACKGROUND_IMAGE
static java.lang.String	PROPERTY_TITLE_FONT
static java.lang.String	PROPERTY_TITLE_INSETS
static java.lang.String	PROPERTY_TITLE_POSITION
static int	RIGHT
static int	TOP
static int	TOP_LEFT
static int	TOP_RIGHT

Fields inherited from class nextapp.echo.app.Component

CHILD_VISIBLE_CHANGED_PROPERTY, CHILDREN_CHANGED_PROPERTY, ENABLED_CHANGED_PROPERTY, FOCUS_TRAVERSAL_INDEX_CHANGED_PROPERTY, FOCUS_TRAVERSAL_PARTICIPANT_CHANGED_PROPERTY, LAYOUT_DIRECTION_CHANGED_PROPERTY, LOCALE_CHANGED_PROPERTY, PROPERTY_BACKGROUND, PROPERTY_FONT, PROPERTY_FOREGROUND, PROPERTY_LAYOUT_DATA, STYLE_CHANGED_PROPERTY, STYLE_NAME_CHANGED_PROPERTY, VISIBLE_CHANGED_PROPERTY

Constructor Summary

Group()
Default constructor.

Method Summary

nextapp.echo.app.FillImage	getBackgroundImage() Returns the background image.
nextapp.echo.app.ImageReference	getBorderImage(int position) Returns the configured border image for the specified position.
nextapp.echo.app.Insets	getBorderInsets() Returns the inset margin used to provide space for the border (a zero inset would render the content over the border).
nextapp.echo.app.Insets	getInsets() Returns the inset margin around the content.
java.lang.String	getTitle() Gets the title.
nextapp.echo.app.ImageReference	getTitleBackgroundImage() Gets the background image for the title.
nextapp.echo.app.Font	getTitleFont() Gets the font for the title.
nextapp.echo.app.Insets	getTitleInsets() Gets the insets for the title.
nextapp.echo.app.Extent	getTitlePosition() Gets the title position.
void	setBackgroundImage(nextapp.echo.app.FillImage backgroundImage) Sets the background image.
void	setBorderImage(int position, nextapp.echo.app.ImageReference newValue) Sets the border image for the specified position.
void	setBorderInsets(nextapp.echo.app.Insets borderInsets) Sets the inset of the border images, used to provide space for the border (a zero inset would render the content over the border).
void	setInsets(nextapp.echo.app.Insets newValue) Sets the inset margin around the content
void	setTitle(java.lang.String title) Sets the title.
void	setTitleBackgroundImage(nextapp.echo.app.ImageReference titleBackgroundImage) Sets the background image to use for the title.
void	setTitleFont(nextapp.echo.app.Font titleFont) Sets the font to use for the title.
void	setTitleInsets(nextapp.echo.app.Insets titleInsets) Sets the insets to use for the title.
void	setTitlePosition(nextapp.echo.app.Extent titlePosition) Sets the title position.

Methods inherited from class nextapp.echo.app.Component

add, add, addPropertyChangeListener, addPropertyChangeListener, dispose, firePropertyChange, get, getApplicationInstance, getBackground, getComponent, getComponent, getComponentCount, getComponents, getEventListenerList, getFocusTraversalIndex, getFont, getForeground, getId, getIndex, getLayoutData, getLayoutDirection, getLocale, getLocalStyle, getParent, getRenderId, getRenderIndexedProperty, getRenderIndexedProperty, getRenderLocale, getRenderProperty, getRenderProperty, getStyle, getStyleName, getVisibleComponent, getVisibleComponentCount, getVisibleComponents, hasEventListenerList, indexOf, init, isAncestorOf, isEnabled, isFocusTraversalParticipant, isRegistered, isRenderEnabled, isRenderVisible, isValidChild, isValidParent, isVisible, processInput, remove, remove, removeAll, removePropertyChangeListener, removePropertyChangeListener, set, setBackground, setComponents, setEnabled, setFocusTraversalIndex, setFocusTraversalParticipant, setFont, setForeground, setId, setIndex, setLayoutData, setLayoutDirection, setLocale, setRenderId, setStyle, setStyleName, setVisible, validate, verifyInput, visibleIndexOf

Methods inherited from class java.lang.Object

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

Field Detail

TOP_LEFT

public static final int TOP_LEFT

See Also:

Constant Field Values

TOP

public static final int TOP

See Also:

Constant Field Values

TOP_RIGHT

public static final int TOP_RIGHT

See Also:

Constant Field Values

LEFT

public static final int LEFT

See Also:

Constant Field Values

RIGHT

public static final int RIGHT

See Also:

Constant Field Values

BOTTOM_LEFT

public static final int BOTTOM_LEFT

See Also:

Constant Field Values

BOTTOM

public static final int BOTTOM

See Also:

Constant Field Values

BOTTOM_RIGHT

public static final int BOTTOM_RIGHT

See Also:

Constant Field Values

PROPERTY_BACKGROUND_IMAGE

public static final java.lang.String PROPERTY_BACKGROUND_IMAGE

See Also:

Constant Field Values

PROPERTY_BORDER_IMAGE

public static final java.lang.String PROPERTY_BORDER_IMAGE

See Also:

Constant Field Values

PROPERTY_BORDER_INSETS

public static final java.lang.String PROPERTY_BORDER_INSETS

See Also:

Constant Field Values

PROPERTY_INSETS

public static final java.lang.String PROPERTY_INSETS

See Also:

Constant Field Values

PROPERTY_TITLE

public static final java.lang.String PROPERTY_TITLE

See Also:

Constant Field Values

PROPERTY_TITLE_BACKGROUND_IMAGE

public static final java.lang.String PROPERTY_TITLE_BACKGROUND_IMAGE

See Also:

Constant Field Values

PROPERTY_TITLE_FONT

public static final java.lang.String PROPERTY_TITLE_FONT

See Also:

Constant Field Values

PROPERTY_TITLE_INSETS

public static final java.lang.String PROPERTY_TITLE_INSETS

See Also:

Constant Field Values

PROPERTY_TITLE_POSITION

public static final java.lang.String PROPERTY_TITLE_POSITION

See Also:

Constant Field Values

Constructor Detail

Group

public Group()

Default constructor.

Method Detail

getBackgroundImage

public nextapp.echo.app.FillImage getBackgroundImage()

Returns the background image.

Returns:

the background image.

getBorderImage

public nextapp.echo.app.ImageReference getBorderImage(int position)

Returns the configured border image for the specified position.

Parameters:

position - the position of the image, one of the following values:

• TOP_LEFT
• TOP
• TOP_RIGHT
• LEFT
• RIGHT
• BOTTOM_LEFT
• BOTTOM
• BOTTOM_RIGHT

Returns:

the border image

getBorderInsets

public nextapp.echo.app.Insets getBorderInsets()

Returns the inset margin used to provide space for the border (a zero inset would render the content over the border).

Returns:

the border inset

See Also:

setBorderInsets(nextapp.echo.app.Insets)

getInsets

public nextapp.echo.app.Insets getInsets()

Returns the inset margin around the content.

Returns:

the inset margin

getTitle

public java.lang.String getTitle()

Gets the title.

Returns:

the title.

getTitleBackgroundImage

public nextapp.echo.app.ImageReference getTitleBackgroundImage()

Gets the background image for the title.

Returns:

the title background image.

getTitleFont

public nextapp.echo.app.Font getTitleFont()

Gets the font for the title.

Returns:

the title font.

getTitleInsets

public nextapp.echo.app.Insets getTitleInsets()

Gets the insets for the title.

Returns:

the title insets.

getTitlePosition

public nextapp.echo.app.Extent getTitlePosition()

Gets the title position.

Returns:

the title position.

setBackgroundImage

public void setBackgroundImage(nextapp.echo.app.FillImage backgroundImage)

Sets the background image.

Parameters:

backgroundImage - the background image

setBorderImage

public void setBorderImage(int position,
                           nextapp.echo.app.ImageReference newValue)

Sets the border image for the specified position.

Parameters:

position - the image position, one of the following values:

• TOP_LEFT
• TOP
• TOP_RIGHT
• LEFT
• RIGHT
• BOTTOM_LEFT
• BOTTOM
• BOTTOM_RIGHT

newValue - the new border image

setBorderInsets

public void setBorderInsets(nextapp.echo.app.Insets borderInsets)

Sets the inset of the border images, used to provide space for the border (a zero inset would render the content over the border). For example, if the left border were 6 pixels wide, the left portion of the inset should be also be configured to 6 pixels.

Parameters:

borderInsets - the new border inset

setInsets

public void setInsets(nextapp.echo.app.Insets newValue)

Sets the inset margin around the content

Parameters:

newValue - the new inset margin

setTitle

public void setTitle(java.lang.String title)

Sets the title.

Parameters:

title - the title

setTitleBackgroundImage

public void setTitleBackgroundImage(nextapp.echo.app.ImageReference titleBackgroundImage)

Sets the background image to use for the title.

Parameters:

titleBackgroundImage - the background image

setTitleFont

public void setTitleFont(nextapp.echo.app.Font titleFont)

Sets the font to use for the title.

Parameters:

titleFont - the title font

setTitleInsets

public void setTitleInsets(nextapp.echo.app.Insets titleInsets)

Sets the insets to use for the title.

Parameters:

titleInsets - the title insets

setTitlePosition

public void setTitlePosition(nextapp.echo.app.Extent titlePosition)

Sets the title position.

Parameters:

titlePosition - the title position