Overview  Package   Class  Use  Deprecated  Index
Home >> All >> [ echopoint overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

echopoint
Class TitleBar  

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

All Implemented Interfaces:

echopoint.positionable.Borderable, echopoint.util.reflect.ReflectionSetter, java.io.Serializable, ToolTipPopUpSupport, nextapp.echo.ToolTipSupport

---

public class TitleBar

extends EchoPointComponent

implements echopoint.positionable.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.

---

Nested Class Summary
static class	TitleBar.NestedStyleInfo           Nested public static StyleInfo class.
private  class	TitleBar.PropertyChangeForwarder

 

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
private  nextapp.echo.ImageReference	applicationImage
static java.lang.String	BACKGROUND_IMAGE_PROPERTIES_CHANGED_PROPERTY
private  nextapp.echo.BackgroundImageProperties	backgroundImageProperties
static java.lang.String	BORDER_COLOR_CHANGED_PROPERTY
static java.lang.String	BORDER_SIZE_CHANGED_PROPERTY
private  nextapp.echo.Color	borderColor
private  int	borderSize
private  int	borderStyle
static java.lang.String	CLOSE_IMAGE_CHANGED_PROPERTY
private  nextapp.echo.ImageReference	closeImage
static java.lang.String	CORNER_IMAGES_CHANGED_PROPERTY
private  CornerImages	cornerImages
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
private  boolean	fullHeight
private  boolean	fullWidth
static java.lang.String	HELP_IMAGE_CHANGED_PROPERTY
private  nextapp.echo.ImageReference	helpImage
static java.lang.String	HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY
private  int	horizontalAlignment
static java.lang.String	IS_TEXT_CLICKABLE_CHANGED_PROPERTY
private  boolean	isTextClickable
static java.lang.String	LEFT_COLLAPSE_IMAGE_CHANGED_PROPERTY
static java.lang.String	LEFT_EXPAND_IMAGE_CHANGED_PROPERTY
private  nextapp.echo.ImageReference	leftCollapsedImage
private  nextapp.echo.ImageReference	leftExpandedImage
private  echopoint.model.ExpandableModel	model
private  TitleBar.PropertyChangeForwarder	propertyChangeForwarder
static java.lang.String	RIGHT_COLLAPSE_IMAGE_CHANGED_PROPERTY
static java.lang.String	RIGHT_EXPAND_IMAGE_CHANGED_PROPERTY
private  nextapp.echo.ImageReference	rightCollapsedImage
private  nextapp.echo.ImageReference	rightExpandedImage
static java.lang.String	STYLE_BORDER_COLOR           A style constant for the Border Color property.
static java.lang.String	STYLE_BORDER_SIZE           A style constant for the Border Size 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
private  java.lang.String	title
static java.lang.String	TITLE_CHANGED_PROPERTY           Property Change Names
private  int	type
static java.lang.String	TYPE_CHANGED_PROPERTY
static java.lang.String	VERTICAL_ALIGNMENT_CHANGED_PROPERTY
private  int	verticalAlignment

 

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, TAB_INDEX_CHANGED_PROPERTY, UPDATE_PROPERTY, VISIBLE_CHANGED_PROPERTY

 

Fields inherited from interface echopoint.positionable.Borderable

BORDER_CHANGED_PROPERTY, BORDER_DASHED, BORDER_DOTTED, BORDER_DOUBLE, BORDER_GROOVE, BORDER_INSET, BORDER_NONE, BORDER_OUTSET, BORDER_RIDGE, BORDER_SOLID, borderStyleSymbolics, STYLE_BORDER_STYLE

 

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 TitleBar.
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.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.
echopoint.model.ExpandableModel	getModel()
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()
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 border Color of the TitleBar.
void	setBorderSize(int newBorderSize)           Sets the border size of the TitleBar.
void	setBorderStyle(int borderStyle)           Sets the border style of the TitleBar.
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	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(echopoint.model.ExpandableModel newModel)           Sets the ExpandableModel model used by the TitleBar.
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	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

getToolTipPopUp, getToolTipText, set, set, set, set, set, set, set, set, set, setEnabledAllChildren, 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, getTabIndex, indexOf, init, isAncestorOf, isEnabled, isFocused, isRegistered, isShowing, isVisible, remove, remove, removeAll, removeHierarchyListener, removePropertyChangeListener, setBackground, setEnabled, setFocused, setFont, setForeground, setIdentifier, setLocale, setTabIndex, 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

---

BORDER_COLOR_CHANGED_PROPERTY

public static final java.lang.String BORDER_COLOR_CHANGED_PROPERTY

See Also:

Constant Field Values

---

BORDER_SIZE_CHANGED_PROPERTY

public static final java.lang.String BORDER_SIZE_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_BORDER_COLOR

public static final java.lang.String STYLE_BORDER_COLOR

A style constant for the Border Color property. Values of this key must be of type nextapp.echo.Color.

See Also:

Constant Field Values

---

STYLE_BORDER_SIZE

public static final java.lang.String STYLE_BORDER_SIZE

A style constant for the Border Size property. Values of this key must be of type Integer.

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

---

borderColor

private nextapp.echo.Color borderColor

---

borderSize

private int borderSize

---

borderStyle

private int borderStyle

---

closeImage

private nextapp.echo.ImageReference closeImage

---

cornerImages

private CornerImages cornerImages

---

fullHeight

private boolean fullHeight

---

fullWidth

private boolean fullWidth

---

helpImage

private nextapp.echo.ImageReference helpImage

---

applicationImage

private nextapp.echo.ImageReference applicationImage

---

horizontalAlignment

private int horizontalAlignment

---

leftCollapsedImage

private nextapp.echo.ImageReference leftCollapsedImage

---

isTextClickable

private boolean isTextClickable

---

backgroundImageProperties

private nextapp.echo.BackgroundImageProperties backgroundImageProperties

---

propertyChangeForwarder

private TitleBar.PropertyChangeForwarder propertyChangeForwarder

---

leftExpandedImage

private nextapp.echo.ImageReference leftExpandedImage

---

model

private echopoint.model.ExpandableModel model

---

rightCollapsedImage

private nextapp.echo.ImageReference rightCollapsedImage

---

rightExpandedImage

private nextapp.echo.ImageReference rightExpandedImage

---

title

private java.lang.String title

---

type

private int type

---

verticalAlignment

private int verticalAlignment

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.

---

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 echopoint.positionable.Borderable

Overrides:

applyStyle in class EchoPointComponent

---

fireActionPerformed

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

Notifies all listeners that have registered for this event type.

---

getApplicationImage

public nextapp.echo.ImageReference getApplicationImage()

Returns the image used for the application icon.

---

getBorderColor

public nextapp.echo.Color getBorderColor()

Specified by:

getBorderColor in interface echopoint.positionable.Borderable

---

getBorderSize

public int getBorderSize()

Specified by:

getBorderSize in interface echopoint.positionable.Borderable

---

getCloseImage

public nextapp.echo.ImageReference getCloseImage()

Returns the image used for the close icon.

---

getCornerImages

public CornerImages getCornerImages()

---

getHelpImage

public nextapp.echo.ImageReference getHelpImage()

Returns the image used for the help icon.

---

getHorizontalAlignment

public int getHorizontalAlignment()

Returns the horizontal alignment of the title text

---

getLeftCollapsedImage

public nextapp.echo.ImageReference getLeftCollapsedImage()

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

---

getLeftExpandedImage

public nextapp.echo.ImageReference getLeftExpandedImage()

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

---

getModel

public echopoint.model.ExpandableModel getModel()

---

getRightCollapsedImage

public nextapp.echo.ImageReference getRightCollapsedImage()

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

---

getRightExpandedImage

public nextapp.echo.ImageReference getRightExpandedImage()

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

---

getText

public java.lang.String getText()

---

getType

public int getType()

---

getVerticalAlignment

public int getVerticalAlignment()

Returns the vertical alignment of the title text.

---

isExpanded

public boolean isExpanded()

---

isFullHeight

public boolean isFullHeight()

Returns TRUE if the TitleBar will fill its parents full height

---

isFullWidth

public boolean isFullWidth()

Returns TRUE if the TitleBar will fill its parents full width

---

removeActionListener

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

Removes an ActionListener from the titlebar.

---

setApplicationImage

public void setApplicationImage(nextapp.echo.ImageReference newImage)

Sets the image used for the application icon.

---

setBorderColor

public void setBorderColor(nextapp.echo.Color newBorderColor)

Sets the border Color of the TitleBar.
This methods fires a PropertyChangeEvent with a getPropertyName() value of TitleBar.BORDER_COLOR_CHANGED_PROPERTY
Note that the border will only be drawn if the corner images are not present (ie null). They are null by default.

Specified by:

setBorderColor in interface echopoint.positionable.Borderable

---

setBorderSize

public void setBorderSize(int newBorderSize)

Sets the border size of the TitleBar.
This methods fires a PropertyChangeEvent with a getPropertyName() value of TitleBar.BORDER_SIZE_CHANGED_PROPERTY
Note that the border will only be drawn if the corner images are not present (ie null). They are null by default.

Specified by:

setBorderSize in interface echopoint.positionable.Borderable

---

setCloseImage

public void setCloseImage(nextapp.echo.ImageReference newCloseImage)

Sets the image used for the close icon.

---

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

---

setFullWidth

public void setFullWidth(boolean newFullWidth)

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

---

setHelpImage

public void setHelpImage(nextapp.echo.ImageReference newImage)

Sets the image used for the help icon.

---

setHorizontalAlignment

public void setHorizontalAlignment(int newValue)

Sets the horizontal alignment of the title text

---

setLeftCollapsedImage

public void setLeftCollapsedImage(nextapp.echo.ImageReference newLeftCollapsedImage)

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

---

setLeftExpandedImage

public void setLeftExpandedImage(nextapp.echo.ImageReference newLeftExpandedImage)

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

---

setModel

public void setModel(echopoint.model.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.

---

setRightExpandedImage

public void setRightExpandedImage(nextapp.echo.ImageReference newRightExpandedImage)

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

---

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

---

isTextClickable

public boolean isTextClickable()

---

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.

---

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

---

getBorderStyle

public int getBorderStyle()

Returns the border style of the TitleBar. 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 echopoint.positionable.Borderable

---

setBorderStyle

public void setBorderStyle(int borderStyle)

Sets the border style of the TitleBar. 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

Specified by:

setBorderStyle in interface echopoint.positionable.Borderable

---

set

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

Description copied from interface: echopoint.util.reflect.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 echopoint.util.reflect.ReflectionSetter

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> [ echopoint overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---