echopoint
Class TitleBar

java.lang.Object
  nextapp.echo.Component
      nextapp.echo.Container
          echopoint.EchoPointComponent
              echopoint.TitleBar

All Implemented Interfaces:

Borderable, MouseCursorable, ReflectionSetter, java.io.Serializable, ToolTipPopUpSupport, nextapp.echo.ToolTipSupport

public class TitleBar

extends EchoPointComponent

implements Borderable

The TitleBar class provides a Component with a title, that can be used to expanded and collapsed, as well as close other components.
The TitleBar is always as wide as its container and is used by other Components to act as their title bar.
The class uses the ExpandableModel interface to keep track of whether it is expanded or not. Other Components that are using this TitleBar can react to this by expanding or collapsing themselves as appropriate.

Author:

Brad Baker

See Also:

Serialized Form

Nested Class Summary

static class

TitleBar.NestedStyleInfo Nested public static StyleInfo class.

Field Summary

static java.lang.String	ACTION_APPLICATION These constants are used by the respective image as actionCommands when the image within the title bar is pressed.
static java.lang.String	ACTION_CLOSE
static java.lang.String	ACTION_HELP
static java.lang.String	ACTION_LEFT_EXPAND
static java.lang.String	ACTION_RIGHT_EXPAND
static java.lang.String	APPLICATION_IMAGE_CHANGED_PROPERTY
static java.lang.String	BACKGROUND_IMAGE_PROPERTIES_CHANGED_PROPERTY
static java.lang.String	CLOSE_IMAGE_CHANGED_PROPERTY
static java.lang.String	CORNER_IMAGES_CHANGED_PROPERTY
static CornerImages	DEFAULT_CORNER_IMAGES
static java.lang.String	DEFAULT_TITLE the default Title for a title bar
static nextapp.echo.ImageReference	defaultApplicationImage
static nextapp.echo.ImageReference	defaultCloseImage
static nextapp.echo.ImageReference	defaultHelpImage
static nextapp.echo.ImageReference	defaultLeftCollapsedImage
static nextapp.echo.ImageReference	defaultLeftExpandedImage the default images used for the left, right and close buttons
static nextapp.echo.ImageReference	defaultRightCollapsedImage
static nextapp.echo.ImageReference	defaultRightExpandedImage
static java.lang.String	FULL_HEIGHT_CHANGED_PROPERTY
static java.lang.String	FULL_WIDTH_CHANGED_PROPERTY
static java.lang.String	HELP_IMAGE_CHANGED_PROPERTY
static java.lang.String	HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY
static java.lang.String	IS_TEXT_CLICKABLE_CHANGED_PROPERTY
static java.lang.String	LEFT_COLLAPSE_IMAGE_CHANGED_PROPERTY
static java.lang.String	LEFT_EXPAND_IMAGE_CHANGED_PROPERTY
static java.lang.String	RIGHT_COLLAPSE_IMAGE_CHANGED_PROPERTY
static java.lang.String	RIGHT_EXPAND_IMAGE_CHANGED_PROPERTY
static java.lang.String	STYLE_CORNER_IMAGES A style constant for the Corner Images property.
static java.lang.String	STYLE_EXPANDED A style constant for the Expanded property.
static java.lang.String	STYLE_FULL_HEIGHT A style constant for the Full Height property.
static java.lang.String	STYLE_FULL_WIDTH A style constant for the Full Width property.
static java.lang.String	STYLE_HORIZONTAL_ALIGNMENT A style constant for the Horizontal Alignemnt property.
static java.lang.String	STYLE_VERTICAL_ALIGNMENT A style constant for the Vertical Alignemnt property.
static int	TB_APPLICATION
static int	TB_CLOSE
static int	TB_HELP
static int	TB_LEFT_EXPAND
static int	TB_NO_IMAGES Thse constanst control what clickable images are available on the the title bar.
static int	TB_RIGHT_EXPAND
static java.lang.String	TITLE_CHANGED_PROPERTY Property Change Names
static java.lang.String	TYPE_CHANGED_PROPERTY
static java.lang.String	VERTICAL_ALIGNMENT_CHANGED_PROPERTY

Fields inherited from class echopoint.EchoPointComponent

STYLE_TOOL_TIP_TEXT, TOOL_TIP_TEXT_CHANGED_PROPERTY, toolTipPopUp

Fields inherited from class nextapp.echo.Component

BACKGROUND_CHANGED_PROPERTY, CHILDREN_CHANGED_PROPERTY, ENABLED_CHANGED_PROPERTY, FONT_CHANGED_PROPERTY, FOREGROUND_CHANGED_PROPERTY, IDENTIFIER_CHANGED_PROPERTY, listenerList, LOCALE_CHANGED_PROPERTY, MODEL_CHANGED_PROPERTY, STYLE_BACKGROUND, STYLE_FONT, STYLE_FOREGROUND, UPDATE_PROPERTY, VISIBLE_CHANGED_PROPERTY

Fields inherited from interface echopoint.positionable.Borderable

BORDER_DASHED, BORDER_DOTTED, BORDER_DOUBLE, BORDER_GROOVE, BORDER_INSET, BORDER_NONE, BORDER_OUTSET, BORDER_RIDGE, BORDER_SOLID, borderStyleSymbolics, STYLE_BORDER_COLOR, STYLE_BORDER_SIZE, STYLE_BORDER_STYLE, STYLE_BOTTOM_BORDER_COLOR, STYLE_BOTTOM_BORDER_SIZE, STYLE_BOTTOM_BORDER_STYLE, STYLE_LEFT_BORDER_COLOR, STYLE_LEFT_BORDER_SIZE, STYLE_LEFT_BORDER_STYLE, STYLE_RIGHT_BORDER_COLOR, STYLE_RIGHT_BORDER_SIZE, STYLE_RIGHT_BORDER_STYLE, STYLE_TOP_BORDER_COLOR, STYLE_TOP_BORDER_SIZE, STYLE_TOP_BORDER_STYLE

Fields inherited from interface echopoint.positionable.MouseCursorable

borderStyleSymbolics, CURSOR_AUTO, CURSOR_CROSSHAIR, CURSOR_CUSTOM_URI, CURSOR_DEFAULT, CURSOR_E_RESIZE, CURSOR_HELP, CURSOR_MOVE, CURSOR_N_RESIZE, CURSOR_NE_RESIZE, CURSOR_NW_RESIZE, CURSOR_POINTER, CURSOR_S_RESIZE, CURSOR_SE_RESIZE, CURSOR_SW_RESIZE, CURSOR_TEXT, CURSOR_W_RESIZE, CURSOR_WAIT, STYLE_MOUSE_CURSOR, STYLE_MOUSE_CURSOR_URI

Constructor Summary

TitleBar()
Constructs a TitleBar with no title

TitleBar(java.lang.String title)
Constructs a TitleBar with the given title

TitleBar(java.lang.String title, int titleBarType)
Constructs a TitleBar using the titleBarType parameter.

Method Summary

void	addActionListener(nextapp.echo.event.ActionListener l) Adds an ActionListener to the titlebar.
void	applyStyle(nextapp.echo.Style style) Applies the provided style to the component.
void	fireActionPerformed(nextapp.echo.event.ActionEvent e) Notifies all listeners that have registered for this event type.
nextapp.echo.ImageReference	getApplicationImage() Returns the image used for the application icon.
nextapp.echo.BackgroundImageProperties	getBackgroundImageProperties() Returns the BackgroundImageProperties of the TitleBar.
nextapp.echo.Color	getBorderColor()
int	getBorderSize()
int	getBorderStyle() Returns the border style of the Borderable.
nextapp.echo.Color	getBottomBorderColor()
int	getBottomBorderSize()
int	getBottomBorderStyle()
nextapp.echo.ImageReference	getCloseImage() Returns the image used for the close icon.
CornerImages	getCornerImages()
nextapp.echo.ImageReference	getHelpImage() Returns the image used for the help icon.
int	getHorizontalAlignment() Returns the horizontal alignment of the title text
nextapp.echo.Color	getLeftBorderColor()
int	getLeftBorderSize()
int	getLeftBorderStyle()
nextapp.echo.ImageReference	getLeftCollapsedImage() Returns the image used for the left icon when the titlebar is collapsed.
nextapp.echo.ImageReference	getLeftExpandedImage() Returns the image used for the left icon when the titlebar is expanded.
ExpandableModel	getModel()
nextapp.echo.Color	getRightBorderColor()
int	getRightBorderSize()
int	getRightBorderStyle()
nextapp.echo.ImageReference	getRightCollapsedImage() Returns the image used for the right icon when the titlebar is collapsed.
nextapp.echo.ImageReference	getRightExpandedImage() Returns the image used for the right icon when the titlebar is expanded.
java.lang.String	getText()
nextapp.echo.Color	getTopBorderColor()
int	getTopBorderSize()
int	getTopBorderStyle()
int	getType()
int	getVerticalAlignment() Returns the vertical alignment of the title text.
boolean	isExpanded()
boolean	isFullHeight() Returns TRUE if the TitleBar will fill its parents full height
boolean	isFullWidth() Returns TRUE if the TitleBar will fill its parents full width
boolean	isTextClickable()
void	removeActionListener(nextapp.echo.event.ActionListener l) Removes an ActionListener from the titlebar.
java.lang.Object	set(java.lang.reflect.Field field, java.lang.Object newValue) Called to save the old value of a field, set in a new value and return the old value of a field.
void	setApplicationImage(nextapp.echo.ImageReference newImage) Sets the image used for the application icon.
void	setBackgroundImageProperties(nextapp.echo.BackgroundImageProperties newValue) Sets the BackgroundImageProperties of the TitleBar
void	setBorderColor(nextapp.echo.Color newBorderColor) Sets the Color of the Borderable's border.
void	setBorderSize(int newBorderSize) Sets the size of the Borderables's border.
void	setBorderStyle(int borderStyle) Sets the border style of the Borderable.
void	setBottomBorderColor(nextapp.echo.Color borderColor) Sets the Color of the Borderable's bottom border.
void	setBottomBorderSize(int borderSize) Sets the size of the Borderables's bottom border.
void	setBottomBorderStyle(int borderStyle) Sets the border style of the Borderables's bottom border.
void	setCloseImage(nextapp.echo.ImageReference newCloseImage) Sets the image used for the close icon.
void	setCornerImages(CornerImages newValue) Sets the CornerImages used by the TitleBar This methods fires a PropertyChangeEvent with a getPropertyName() value of TitleBar.CORNER_IMAGES_CHANGED_PROPERTY
void	setExpanded(boolean isExpanded) Sets whether the TitleBar is expanded or not This methods causes the underlying ExpandableModel to change.
void	setFullHeight(boolean newFullHeight) If this is TRUE then the TitleBar will fill its parents full height
void	setFullWidth(boolean newFullWidth) If this is TRUE then the TitleBar will fill its parents full width
void	setHelpImage(nextapp.echo.ImageReference newImage) Sets the image used for the help icon.
void	setHorizontalAlignment(int newValue) Sets the horizontal alignment of the title text
void	setLeftBorderColor(nextapp.echo.Color borderColor) Sets the Color of the Borderable's left border.
void	setLeftBorderSize(int borderSize) Sets the size of the Borderables's left border.
void	setLeftBorderStyle(int borderStyle) Sets the border style of the Borderables's left border.
void	setLeftCollapsedImage(nextapp.echo.ImageReference newLeftCollapsedImage) Sets the image used for the left icon when the titlebar is collapsed.
void	setLeftExpandedImage(nextapp.echo.ImageReference newLeftExpandedImage) Sets the image used for the left icon when the titlebar is expanded.
void	setModel(ExpandableModel newModel) Sets the ExpandableModel model used by the TitleBar.
void	setRightBorderColor(nextapp.echo.Color borderColor) Sets the Color of the Borderable's right border.
void	setRightBorderSize(int borderSize) Sets the size of the Borderables's right border.
void	setRightBorderStyle(int borderStyle) Sets the border style of the Borderables's right border.
void	setRightCollapsedImage(nextapp.echo.ImageReference newRightCollapsedImage) Sets the image used for the right icon when the titlebar is collapsed.
void	setRightExpandedImage(nextapp.echo.ImageReference newRightExpandedImage) Sets the image used for the right icon when the titlebar is expanded.
void	setText(java.lang.String newTitle)
void	setTextClickable(boolean newValue) Sets whether the is the titlebar text clickable.
void	setTopBorderColor(nextapp.echo.Color borderColor) Sets the Color of the Borderable's top border.
void	setTopBorderSize(int borderSize) Sets the size of the Borderables's top border.
void	setTopBorderStyle(int borderStyle) Sets the border style of the Borderables's top border.
void	setType(int newType) Sets the type of the TitleBar.
void	setVerticalAlignment(int newValue) Sets the vertical alignment of the title text

Methods inherited from class echopoint.EchoPointComponent

getMouseCursor, getMouseCursorURI, getToolTipPopUp, getToolTipText, set, set, set, set, set, set, set, set, set, setEnabledAllChildren, setMouseCursor, setMouseCursorURI, setToolTipText, validate

Methods inherited from class nextapp.echo.Component

add, add, addHierarchyListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getComponent, getComponentCount, getComponents, getEchoInstance, getFont, getForeground, getIdentifier, getLocale, getParent, indexOf, init, isAncestorOf, isEnabled, isRegistered, isShowing, isVisible, remove, remove, removeAll, removeHierarchyListener, removePropertyChangeListener, setBackground, setEnabled, setFont, setForeground, setIdentifier, setLocale, setVisible, update

Methods inherited from class java.lang.Object

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

Field Detail

ACTION_APPLICATION

public static final java.lang.String ACTION_APPLICATION

These constants are used by the respective image as actionCommands when the image within the title bar is pressed.

See Also:

Constant Field Values

ACTION_CLOSE

public static final java.lang.String ACTION_CLOSE

See Also:

Constant Field Values

ACTION_HELP

public static final java.lang.String ACTION_HELP

See Also:

Constant Field Values

ACTION_LEFT_EXPAND

public static final java.lang.String ACTION_LEFT_EXPAND

See Also:

Constant Field Values

ACTION_RIGHT_EXPAND

public static final java.lang.String ACTION_RIGHT_EXPAND

See Also:

Constant Field Values

APPLICATION_IMAGE_CHANGED_PROPERTY

public static final java.lang.String APPLICATION_IMAGE_CHANGED_PROPERTY

See Also:

Constant Field Values

CLOSE_IMAGE_CHANGED_PROPERTY

public static final java.lang.String CLOSE_IMAGE_CHANGED_PROPERTY

See Also:

Constant Field Values

CORNER_IMAGES_CHANGED_PROPERTY

public static final java.lang.String CORNER_IMAGES_CHANGED_PROPERTY

See Also:

Constant Field Values

DEFAULT_CORNER_IMAGES

public static final CornerImages DEFAULT_CORNER_IMAGES

DEFAULT_TITLE

public static final java.lang.String DEFAULT_TITLE

the default Title for a title bar

See Also:

Constant Field Values

defaultLeftExpandedImage

public static nextapp.echo.ImageReference defaultLeftExpandedImage

the default images used for the left, right and close buttons

defaultRightCollapsedImage

public static nextapp.echo.ImageReference defaultRightCollapsedImage

defaultRightExpandedImage

public static nextapp.echo.ImageReference defaultRightExpandedImage

FULL_HEIGHT_CHANGED_PROPERTY

public static final java.lang.String FULL_HEIGHT_CHANGED_PROPERTY

See Also:

Constant Field Values

FULL_WIDTH_CHANGED_PROPERTY

public static final java.lang.String FULL_WIDTH_CHANGED_PROPERTY

See Also:

Constant Field Values

HELP_IMAGE_CHANGED_PROPERTY

public static final java.lang.String HELP_IMAGE_CHANGED_PROPERTY

See Also:

Constant Field Values

HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY

public static final java.lang.String HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY

See Also:

Constant Field Values

LEFT_COLLAPSE_IMAGE_CHANGED_PROPERTY

public static final java.lang.String LEFT_COLLAPSE_IMAGE_CHANGED_PROPERTY

See Also:

Constant Field Values

LEFT_EXPAND_IMAGE_CHANGED_PROPERTY

public static final java.lang.String LEFT_EXPAND_IMAGE_CHANGED_PROPERTY

See Also:

Constant Field Values

RIGHT_COLLAPSE_IMAGE_CHANGED_PROPERTY

public static final java.lang.String RIGHT_COLLAPSE_IMAGE_CHANGED_PROPERTY

See Also:

Constant Field Values

RIGHT_EXPAND_IMAGE_CHANGED_PROPERTY

public static final java.lang.String RIGHT_EXPAND_IMAGE_CHANGED_PROPERTY

See Also:

Constant Field Values

IS_TEXT_CLICKABLE_CHANGED_PROPERTY

public static final java.lang.String IS_TEXT_CLICKABLE_CHANGED_PROPERTY

See Also:

Constant Field Values

STYLE_CORNER_IMAGES

public static final java.lang.String STYLE_CORNER_IMAGES

A style constant for the Corner Images property. Values of this key must be of type CornerImages

See Also:

Constant Field Values

STYLE_EXPANDED

public static final java.lang.String STYLE_EXPANDED

A style constant for the Expanded property. Values of this key must be of type Boolean.

See Also:

Constant Field Values

STYLE_FULL_HEIGHT

public static final java.lang.String STYLE_FULL_HEIGHT

A style constant for the Full Height property. Values of this key must be of type Boolean.

See Also:

Constant Field Values

STYLE_FULL_WIDTH

public static final java.lang.String STYLE_FULL_WIDTH

A style constant for the Full Width property. Values of this key must be of type Boolean.

See Also:

Constant Field Values

STYLE_HORIZONTAL_ALIGNMENT

public static final java.lang.String STYLE_HORIZONTAL_ALIGNMENT

A style constant for the Horizontal Alignemnt property. Values of this key must be of type java.lang.Integer.

See Also:

Constant Field Values

STYLE_VERTICAL_ALIGNMENT

public static final java.lang.String STYLE_VERTICAL_ALIGNMENT

A style constant for the Vertical Alignemnt property. Values of this key must be of type java.lang.Integer.

See Also:

Constant Field Values

TB_APPLICATION

public static final int TB_APPLICATION

See Also:

Constant Field Values

TB_CLOSE

public static final int TB_CLOSE

See Also:

Constant Field Values

TB_HELP

public static final int TB_HELP

See Also:

Constant Field Values

TB_LEFT_EXPAND

public static final int TB_LEFT_EXPAND

See Also:

Constant Field Values

TB_NO_IMAGES

public static final int TB_NO_IMAGES

Thse constanst control what clickable images are available on the the title bar.

See Also:

Constant Field Values

TB_RIGHT_EXPAND

public static final int TB_RIGHT_EXPAND

See Also:

Constant Field Values

TITLE_CHANGED_PROPERTY

public static final java.lang.String TITLE_CHANGED_PROPERTY

Property Change Names

See Also:

Constant Field Values

TYPE_CHANGED_PROPERTY

public static final java.lang.String TYPE_CHANGED_PROPERTY

See Also:

Constant Field Values

VERTICAL_ALIGNMENT_CHANGED_PROPERTY

public static final java.lang.String VERTICAL_ALIGNMENT_CHANGED_PROPERTY

See Also:

Constant Field Values

BACKGROUND_IMAGE_PROPERTIES_CHANGED_PROPERTY

public static final java.lang.String BACKGROUND_IMAGE_PROPERTIES_CHANGED_PROPERTY

See Also:

Constant Field Values

defaultApplicationImage

public static nextapp.echo.ImageReference defaultApplicationImage

defaultCloseImage

public static nextapp.echo.ImageReference defaultCloseImage

defaultHelpImage

public static nextapp.echo.ImageReference defaultHelpImage

defaultLeftCollapsedImage

public static nextapp.echo.ImageReference defaultLeftCollapsedImage

Constructor Detail

TitleBar

public TitleBar()

Constructs a TitleBar with no title

TitleBar

public TitleBar(java.lang.String title)

Constructs a TitleBar with the given title

TitleBar

public TitleBar(java.lang.String title,
                int titleBarType)

Constructs a TitleBar using the titleBarType parameter. This can be one of the following:

• TitleBar.TB_NO_IMAGES (the default)
• TitleBar.TB_LEFT_EXPAND
• TitleBar.TB_RIGHT_EXPAND
• TitleBar.TB_CLOSE

Method Detail

addActionListener

public void addActionListener(nextapp.echo.event.ActionListener l)

Adds an ActionListener to the titlebar.

Parameters:

l - The ActionListener to be added.

applyStyle

public void applyStyle(nextapp.echo.Style style)

Applies the provided style to the component. The base nextapp.echo.Component style names can be used as well.

Specified by:

applyStyle in interface Borderable

Overrides:

applyStyle in class EchoPointComponent

See Also:

Component.applyStyle(nextapp.echo.Style)

fireActionPerformed

public void fireActionPerformed(nextapp.echo.event.ActionEvent e)

Notifies all listeners that have registered for this event type.

Parameters:

e - The ActionEvent to send.

getApplicationImage

public nextapp.echo.ImageReference getApplicationImage()

Returns the image used for the application icon.

Returns:

nextapp.echo.ImageReference

getCloseImage

public nextapp.echo.ImageReference getCloseImage()

Returns the image used for the close icon.

Returns:

nextapp.echo.ImageReference

getCornerImages

public CornerImages getCornerImages()

Returns:

the CornerImages of the TitleBar.

getHelpImage

public nextapp.echo.ImageReference getHelpImage()

Returns the image used for the help icon.

Returns:

nextapp.echo.ImageReference

getHorizontalAlignment

public int getHorizontalAlignment()

Returns the horizontal alignment of the title text

Returns:

The horizontal alignment of the text, one of the following values:

• EchoConstants.LEFT (the default)
• EchoConstants.CENTER
• EchoConstants.RIGHT

getLeftCollapsedImage

public nextapp.echo.ImageReference getLeftCollapsedImage()

Returns the image used for the left icon when the titlebar is collapsed.

Returns:

nextapp.echo.ImageReference

getLeftExpandedImage

public nextapp.echo.ImageReference getLeftExpandedImage()

Returns the image used for the left icon when the titlebar is expanded.

Returns:

nextapp.echo.ImageReference

getModel

public ExpandableModel getModel()

Returns:

the ExpandableModel model of the TitleBar.

getRightCollapsedImage

public nextapp.echo.ImageReference getRightCollapsedImage()

Returns the image used for the right icon when the titlebar is collapsed.

Returns:

nextapp.echo.ImageReference

getRightExpandedImage

public nextapp.echo.ImageReference getRightExpandedImage()

Returns the image used for the right icon when the titlebar is expanded.

Returns:

nextapp.echo.ImageReference

getText

public java.lang.String getText()

Returns:

the title text of the TitleBar.

getType

public int getType()

Returns:

the type of the TitleBar. This can be one of the following:

• TitleBar.TB_NO_IMAGES (the default)
• TitleBar.TB_LEFT_EXPAND
• TitleBar.TB_RIGHT_EXPAND
• TitleBar.TB_CLOSE
• TitleBar.TB_HELP
• TitleBar.TB_APPLICATION

getVerticalAlignment

public int getVerticalAlignment()

Returns the vertical alignment of the title text.

Returns:

The vertical alignment of the text, one of the following values:

• EchoConstants.TOP
• EchoConstants.CENTER (the default)
• EchoConstants.BOTTOM

isExpanded

public boolean isExpanded()

Returns:

the TitleBar is expanded or not

isFullHeight

public boolean isFullHeight()

Returns TRUE if the TitleBar will fill its parents full height

Returns:

boolean

isFullWidth

public boolean isFullWidth()

Returns TRUE if the TitleBar will fill its parents full width

Returns:

boolean

removeActionListener

public void removeActionListener(nextapp.echo.event.ActionListener l)

Removes an ActionListener from the titlebar.

Parameters:

l - The ActionListener to be removed.

setApplicationImage

public void setApplicationImage(nextapp.echo.ImageReference newImage)

Sets the image used for the application icon.

Parameters:

newImage - nextapp.echo.ImageReference

setCloseImage

public void setCloseImage(nextapp.echo.ImageReference newCloseImage)

Sets the image used for the close icon.

Parameters:

newCloseImage - nextapp.echo.ImageReference

setCornerImages

public void setCornerImages(CornerImages newValue)

Sets the CornerImages used by the TitleBar
This methods fires a PropertyChangeEvent with a getPropertyName() value of TitleBar.CORNER_IMAGES_CHANGED_PROPERTY

setExpanded

public void setExpanded(boolean isExpanded)

Sets whether the TitleBar is expanded or not
This methods causes the underlying ExpandableModel to change.

setFullHeight

public void setFullHeight(boolean newFullHeight)

If this is TRUE then the TitleBar will fill its parents full height

Parameters:

newFullHeight - boolean

setFullWidth

public void setFullWidth(boolean newFullWidth)

If this is TRUE then the TitleBar will fill its parents full width

Parameters:

newFullWidth - boolean

setHelpImage

public void setHelpImage(nextapp.echo.ImageReference newImage)

Sets the image used for the help icon.

Parameters:

newImage - nextapp.echo.ImageReference

setHorizontalAlignment

public void setHorizontalAlignment(int newValue)

Sets the horizontal alignment of the title text

Parameters:

newValue - The horizontal alignment of the text, one of the following values:

• EchoConstants.LEFT (the default)
• EchoConstants.CENTER
• EchoConstants.RIGHT

setLeftCollapsedImage

public void setLeftCollapsedImage(nextapp.echo.ImageReference newLeftCollapsedImage)

Sets the image used for the left icon when the titlebar is collapsed.

Parameters:

newLeftCollapsedImage - nextapp.echo.ImageReference

setLeftExpandedImage

public void setLeftExpandedImage(nextapp.echo.ImageReference newLeftExpandedImage)

Sets the image used for the left icon when the titlebar is expanded.

Parameters:

newLeftExpandedImage - nextapp.echo.ImageReference

setModel

public void setModel(ExpandableModel newModel)

Sets the ExpandableModel model used by the TitleBar.
This methods fires a PropertyChangeEvent with a getPropertyName() value of TitleBar.MODEL_CHANGED_PROPERTY

setRightCollapsedImage

public void setRightCollapsedImage(nextapp.echo.ImageReference newRightCollapsedImage)

Sets the image used for the right icon when the titlebar is collapsed.

Parameters:

newRightCollapsedImage - nextapp.echo.ImageReference

setRightExpandedImage

public void setRightExpandedImage(nextapp.echo.ImageReference newRightExpandedImage)

Sets the image used for the right icon when the titlebar is expanded.

Parameters:

newRightExpandedImage - nextapp.echo.ImageReference

setText

public void setText(java.lang.String newTitle)

setType

public void setType(int newType)

Sets the type of the TitleBar.
This can be one of the following:

• TitleBar.TB_NO_IMAGES (the default)
• TitleBar.TB_LEFT_EXPAND
• TitleBar.TB_RIGHT_EXPAND
• TitleBar.TB_CLOSE
• TitleBar.TB_HELP
• TitleBar.TB_APPLICATION

This methods fires a PropertyChangeEvent with a getPropertyName() value of TitleBar.TYPE_CHANGED_PROPERTY

setVerticalAlignment

public void setVerticalAlignment(int newValue)

Sets the vertical alignment of the title text

Parameters:

newValue - The vertical alignment of the text, one of the following values:

• EchoConstants.TOP
• EchoConstants.CENTER (the default)
• EchoConstants.BOTTOM

isTextClickable

public boolean isTextClickable()

Returns:

is the titlebar text clickable

setTextClickable

public void setTextClickable(boolean newValue)

Sets whether the is the titlebar text clickable. If it is then it will raise the ACTION_APPLICATION action event.

Parameters:

newValue - - is the titlebar text clickable

getBackgroundImageProperties

public nextapp.echo.BackgroundImageProperties getBackgroundImageProperties()

Returns the BackgroundImageProperties of the TitleBar. This may be null.

setBackgroundImageProperties

public void setBackgroundImageProperties(nextapp.echo.BackgroundImageProperties newValue)

Sets the BackgroundImageProperties of the TitleBar

getBorderColor

public nextapp.echo.Color getBorderColor()

Specified by:

getBorderColor in interface Borderable

Returns:

The Color of the Borderable's border.

See Also:

Borderable.getBorderColor()

getBorderSize

public int getBorderSize()

Specified by:

getBorderSize in interface Borderable

Returns:

The size of the Borderables's border.

See Also:

Borderable.getBorderSize()

getBorderStyle

public int getBorderStyle()

Description copied from interface: Borderable

Returns the border style of the Borderable. This will be one of the following values :

• BORDER_DOTTED - a dotted border
• BORDER_DASHED - dashed border
• BORDER_SOLID - a solid border
• BORDER_DOUBLE - a double border
• BORDER_GROOVE - a 3D grooved border
• BORDER_RIDGE - a 3D ridge border
• BORDER_INSET - a 3D inset border
• BORDER_OUTSET - a 3D outset border

Specified by:

getBorderStyle in interface Borderable

Returns:

int the current border style

See Also:

Borderable.getBorderStyle()

setBorderColor

public void setBorderColor(nextapp.echo.Color newBorderColor)

Description copied from interface: Borderable

Sets the Color of the Borderable's border. This will also set the left, top, right and bottom border color.

Specified by:

setBorderColor in interface Borderable

See Also:

Borderable.setBorderColor(nextapp.echo.Color)

setBorderSize

public void setBorderSize(int newBorderSize)

Description copied from interface: Borderable

Sets the size of the Borderables's border. This will also set the left, top, right and bottom border size.

Specified by:

setBorderSize in interface Borderable

See Also:

Borderable.setBorderSize(int)

setBorderStyle

public void setBorderStyle(int borderStyle)

Description copied from interface: Borderable

Sets the border style of the Borderable. This must be one of the following values :

• BORDER_DOTTED - a dotted border
• BORDER_DASHED - dashed border
• BORDER_SOLID - a solid border
• BORDER_DOUBLE - a double border
• BORDER_GROOVE - a 3D grooved border
• BORDER_RIDGE - a 3D ridge border
• BORDER_INSET - a 3D inset border
• BORDER_OUTSET - a 3D outset border

This will also set the left, top, right and bottom border style.

Specified by:

setBorderStyle in interface Borderable

See Also:

Borderable.setBorderStyle(int)

getLeftBorderColor

public nextapp.echo.Color getLeftBorderColor()

Specified by:

getLeftBorderColor in interface Borderable

Returns:

The Color of the Borderable's left border.

See Also:

Borderable.getLeftBorderColor()

getLeftBorderSize

public int getLeftBorderSize()

Specified by:

getLeftBorderSize in interface Borderable

Returns:

The size of the Borderables's left border.

See Also:

Borderable.getLeftBorderSize()

getLeftBorderStyle

public int getLeftBorderStyle()

Specified by:

getLeftBorderStyle in interface Borderable

Returns:

The style of the Borderables's left border.

See Also:

Borderable.getLeftBorderStyle()

setLeftBorderColor

public void setLeftBorderColor(nextapp.echo.Color borderColor)

Description copied from interface: Borderable

Sets the Color of the Borderable's left border.

Specified by:

setLeftBorderColor in interface Borderable

See Also:

Borderable.setLeftBorderColor(nextapp.echo.Color)

setLeftBorderSize

public void setLeftBorderSize(int borderSize)

Description copied from interface: Borderable

Sets the size of the Borderables's left border.

Specified by:

setLeftBorderSize in interface Borderable

See Also:

Borderable.setLeftBorderSize(int)

setLeftBorderStyle

public void setLeftBorderStyle(int borderStyle)

Description copied from interface: Borderable

Sets the border style of the Borderables's left border.

Specified by:

setLeftBorderStyle in interface Borderable

See Also:

Borderable.setLeftBorderStyle(int)

getTopBorderColor

public nextapp.echo.Color getTopBorderColor()

Specified by:

getTopBorderColor in interface Borderable

Returns:

The Color of the Borderable's top border.

See Also:

Borderable.getTopBorderColor()

getTopBorderSize

public int getTopBorderSize()

Specified by:

getTopBorderSize in interface Borderable

Returns:

The size of the Borderables's top border.

See Also:

Borderable.getTopBorderSize()

getTopBorderStyle

public int getTopBorderStyle()

Specified by:

getTopBorderStyle in interface Borderable

Returns:

The style of the Borderables's top border.

See Also:

Borderable.getTopBorderStyle()

setTopBorderColor

public void setTopBorderColor(nextapp.echo.Color borderColor)

Description copied from interface: Borderable

Sets the Color of the Borderable's top border.

Specified by:

setTopBorderColor in interface Borderable

See Also:

Borderable.setTopBorderColor(nextapp.echo.Color)

setTopBorderSize

public void setTopBorderSize(int borderSize)

Description copied from interface: Borderable

Sets the size of the Borderables's top border.

Specified by:

setTopBorderSize in interface Borderable

See Also:

Borderable.setTopBorderSize(int)

setTopBorderStyle

public void setTopBorderStyle(int borderStyle)

Description copied from interface: Borderable

Sets the border style of the Borderables's top border.

Specified by:

setTopBorderStyle in interface Borderable

See Also:

Borderable.setTopBorderStyle(int)

getRightBorderColor

public nextapp.echo.Color getRightBorderColor()

Specified by:

getRightBorderColor in interface Borderable

Returns:

The Color of the Borderable's right border.

See Also:

Borderable.getRightBorderColor()

getRightBorderSize

public int getRightBorderSize()

Specified by:

getRightBorderSize in interface Borderable

Returns:

The size of the Borderables's right border.

See Also:

Borderable.getRightBorderSize()

getRightBorderStyle

public int getRightBorderStyle()

Specified by:

getRightBorderStyle in interface Borderable

Returns:

The style of the Borderables's right border.

See Also:

Borderable.getRightBorderStyle()

setRightBorderColor

public void setRightBorderColor(nextapp.echo.Color borderColor)

Description copied from interface: Borderable

Sets the Color of the Borderable's right border.

Specified by:

setRightBorderColor in interface Borderable

See Also:

Borderable.setRightBorderColor(nextapp.echo.Color)

setRightBorderSize

public void setRightBorderSize(int borderSize)

Description copied from interface: Borderable

Sets the size of the Borderables's right border.

Specified by:

setRightBorderSize in interface Borderable

See Also:

Borderable.setRightBorderSize(int)

setRightBorderStyle

public void setRightBorderStyle(int borderStyle)

Description copied from interface: Borderable

Sets the border style of the Borderables's right border.

Specified by:

setRightBorderStyle in interface Borderable

See Also:

Borderable.setRightBorderStyle(int)

getBottomBorderColor

public nextapp.echo.Color getBottomBorderColor()

Specified by:

getBottomBorderColor in interface Borderable

Returns:

The Color of the Borderable's bottom border.

See Also:

Borderable.getBottomBorderColor()

getBottomBorderSize

public int getBottomBorderSize()

Specified by:

getBottomBorderSize in interface Borderable

Returns:

The size of the Borderables's bottom border.

See Also:

Borderable.getBottomBorderSize()

getBottomBorderStyle

public int getBottomBorderStyle()

Specified by:

getBottomBorderStyle in interface Borderable

Returns:

The style of the Borderables's bottom border.

See Also:

Borderable.getBottomBorderStyle()

setBottomBorderColor

public void setBottomBorderColor(nextapp.echo.Color borderColor)

Description copied from interface: Borderable

Sets the Color of the Borderable's bottom border.

Specified by:

setBottomBorderColor in interface Borderable

See Also:

Borderable.setBottomBorderColor(nextapp.echo.Color)

setBottomBorderSize

public void setBottomBorderSize(int borderSize)

Description copied from interface: Borderable

Sets the size of the Borderables's bottom border.

Specified by:

setBottomBorderSize in interface Borderable

See Also:

Borderable.setBottomBorderSize(int)

setBottomBorderStyle

public void setBottomBorderStyle(int borderStyle)

Description copied from interface: Borderable

Sets the border style of the Borderables's bottom border.

Specified by:

setBottomBorderStyle in interface Borderable

See Also:

Borderable.setBottomBorderStyle(int)

set

public java.lang.Object set(java.lang.reflect.Field field,
                            java.lang.Object newValue)
                     throws java.lang.Exception

Description copied from interface: ReflectionSetter

Called to save the old value of a field, set in a new value and return the old value of a field. This interface allows a field set operation to be "delegated" back into the class that has permission to perform the field set.

 public Object set(Field f, Object newValue) throws Exception {
      Object oldValue = f.get(this);
      f.set(this,newValue);
      return oldValue;
 }
 

Specified by:

set in interface ReflectionSetter

Parameters:

field - - the field to be set

newValue - - the new value to be set

Returns:

the oldValue of the field

Throws:

java.lang.Exception

See Also:

ReflectionSetter.set(Field, Object)