RebarBand Class

RebarBand Class

This Package | All Packages

Component
  |
  +--RebarBand
public class RebarBand
extends Component

This class encapsulates a RebarBand, a child control in a Rebar object.

Constructors
Name Description
RebarBand() Creates a RebarBand.

Methods
Name Description
equals(Object obj) Retrieves a boolean value that indicates whether the specified object is equal to this one.
getAllowVariableHeight() Retrieves a boolean value that indicates whether this RebarBand can have variable height.
getAllowVertical() Retrieves a boolean value that indicates whether this RebarBand can be drawn vertically.
getBackColor() Retrieve the current BackColor for this RebarBand.
getBackgroundImage() Retrieves the background image associated with this RebarBand.
getBandBreak() Retrieves the BandBreak value.
getBounds() Retrieves a rectangle that defines the bounds of the RebarBand.
getChildControl() Retrieves the child window for this RebarBand.
getChildEdge() Retrieves the current state of the ChildEdge style for this RebarBand.
getFixedBitmap() Retrieves the current state of the FixedBitmap style for this RebarBand.
getForeColor() Retrieves the current ForeColor of this RebarBand.
getGrowBy() Retrieves the current value that a variable height RebarBand can grow or shrink by during resizing.
getHeaderWidth() Retrieves the current value for the width of the RebarBand's header.
getIdealWidth() Retrieves the RebarBand's ideal width setting.
getImageIndex() Retrieves the RebarBand's image index in the rebar's imagelist.
getIndex() Retrieves the RebarBand's current index within the rebar control.
getInitialHeight() Retrieves the RebarBand's initial display height.
getMaxInitialHeight() Retrieves the RebarBand's maximum initial display height.
getMinChildHeight() Retrieves the RebarBand's minimum height for its child window.
getMinChildWidth() Retrieves the minimum width of the RebarBand's child window.
getText() Retrieves the RebarBand's header text.
getVisible() Retrieves a boolean value that indicates whether the RebarBand is visible.
getVisibleGripper() Retrieves a boolean value that indicates whether the RebarBand's gripper is visible.
getWidth() Retrieves the RebarBand's current width.
maximize() Maximizes the current RebarBand within the Rebar control.
minimize() Minimizes the current RebarBand within the Rebar control.
setAllowVariableHeight(boolean flag) Sets the RebarBand's VariableHeight style.
setAllowVertical(boolean flag) Sets the RebarBand's Vertical property.
setBackColor(Color backColor) Sets the RebarBand's current backcolor.
setBackgroundImage(Bitmap backgroundImage) Sets the background image of the RebarBand.
setBandBreak(boolean value) Sets the BandBreak property.
setChildControl(Control childControl) Sets the child window for this RebarBand.
setChildEdge(boolean flag) Sets the RebarBand's ChildEdge property.
setFixedBitmap(boolean flag) Sets the RebarBand's FixedBitmap property.
setForeColor(Color foreColor) Sets the ForeColor for this RebarBand.
setGrowBy(int growby) Sets the number of pixels this RebarBand can grow by when being resized.
setHeaderWidth(int headerWidth) Sets the pixel width for the RebarBand's header.
setIdealWidth(int idealWidth) Sets the ideal width for a RebarBand in the Rebar control.
setImageIndex(int imageIndex) Sets the index of the image in the Rebar control's image list.
setIndex(int index) Sets the index for this RebarBand.
setInitialHeight(int initHeight) Sets the initial height of a variable-height RebarBand in the Rebar control.
setMaxInitialHeight(int maxInitHeight) Sets the maximum initial height of a non-variable height RebarBand in the Rebar control.
setMinChildHeight(int minChildHeight) Sets the minimum initial height of this RebarBand's child window.
setMinChildWidth(int minChildWidth) Sets the minimum initial width of this RebarBand's child window.
setText(String text) Sets the header text for this RebarBand.
setVisible(boolean flag) Sets the RebarBand's Visible property.
setVisibleGripper(boolean flag) Sets the RebarBand's VisibleGripper property.
setWidth(int width) Sets the pixel width of the RebarBand.
toString() Returns a string representation of this object.

Constructors

RebarBand.RebarBand

Syntax
public RebarBand();
Description

Creates a RebarBand.

Methods

RebarBand.equals

Syntax
public boolean equals( Object obj );
Parameters
obj
The object to compare to this one.
Return Value

Returns true, if the objects are equal; otherwise, returns false.

Description

Retrieves a boolean value that indicates whether the specified object is equal to this one.

RebarBand.getAllowVariableHeight

Syntax
public boolean getAllowVariableHeight();
Return Value

Returns true if this RebarBand's height can vary; otherwise, returns false.

Description

Retrieves a boolean value that indicates whether this RebarBand can have variable height.

RebarBand.getAllowVertical

Syntax
public boolean getAllowVertical();
Return Value

Returns true if the RebarBand can be displayed vertically; otherwise, returns false.

Description

Retrieves a boolean value that indicates whether this RebarBand can be drawn vertically.

RebarBand.getBackColor

Syntax
public Color getBackColor();
Return Value

Returns the current BackColor setting.

Description

Retrieve the current BackColor for this RebarBand.

RebarBand.getBackgroundImage

Syntax
public Bitmap getBackgroundImage();
Return Value

Returns the current background image.

Description

Retrieves the background image associated with this RebarBand.

RebarBand.getBandBreak

Syntax
public boolean getBandBreak();
Return Value

Returns the BandBreak value.

Description

Retrieves the BandBreak value.

See Also
setBandBreak

RebarBand.getBounds

Syntax
public Rectangle getBounds();
Return Value

Returns a Rectangle object that contains the bounds of the RebarBand.

Description

Retrieves a rectangle that defines the bounds of the RebarBand.

RebarBand.getChildControl

Syntax
public Control getChildControl();
Return Value

Returns the current child control.

Description

Retrieves the child window for this RebarBand.

RebarBand.getChildEdge

Syntax
public boolean getChildEdge();
Return Value

Returns the current state for the ChildEdge style.

Description

Retrieves the current state of the ChildEdge style for this RebarBand.

RebarBand.getFixedBitmap

Syntax
public boolean getFixedBitmap();
Return Value

Returns the current state for the FixedBitmap style.

Description

Retrieves the current state of the FixedBitmap style for this RebarBand.

RebarBand.getForeColor

Syntax
public Color getForeColor();
Return Value

Returns the current ForeColor color setting.

Description

Retrieves the current ForeColor of this RebarBand.

RebarBand.getGrowBy

Syntax
public int getGrowBy();
Return Value

Returns the current grow or shrink value for a variable height RebarBand.

Description

Retrieves the current value that a variable height RebarBand can grow or shrink by during resizing.

RebarBand.getHeaderWidth

Syntax
public int getHeaderWidth();
Return Value

Returns the current header width for this RebarBand.

Description

Retrieves the current value for the width of the RebarBand's header.

RebarBand.getIdealWidth

Syntax
public int getIdealWidth();
Return Value

Returns the current RebarBand's ideal width.

Description

Retrieves the RebarBand's ideal width setting.

RebarBand.getImageIndex

Syntax
public int getImageIndex();
Return Value

Returns the current RebarBand's ImageList image index.

Description

Retrieves the RebarBand's image index in the rebar's imagelist.

RebarBand.getIndex

Syntax
public int getIndex();
Return Value

Returns the current RebarBand's index in the parent rebar control.

Description

Retrieves the RebarBand's current index within the rebar control.

RebarBand.getInitialHeight

Syntax
public int getInitialHeight();
Return Value

Returns the current RebarBand's initial display height

Description

Retrieves the RebarBand's initial display height. This value is used for variable height bands.

RebarBand.getMaxInitialHeight

Syntax
public int getMaxInitialHeight();
Return Value

Returns the current RebarBand's maximum initial display height.

Description

Retrieves the RebarBand's maximum initial display height. Used for non-variable height bands.

RebarBand.getMinChildHeight

Syntax
public int getMinChildHeight();
Return Value

Returns the current RebarBand's minimum height for the child window.

Description

Retrieves the RebarBand's minimum height for its child window.

RebarBand.getMinChildWidth

Syntax
public int getMinChildWidth();
Return Value

Returns the minimum width of the RebarBand's child window.

Description

Retrieves the minimum width of the RebarBand's child window.

RebarBand.getText

Syntax
public String getText();
Return Value

Returns the RebarBand's header text.

Description

Retrieves the RebarBand's header text.

RebarBand.getVisible

Syntax
public boolean getVisible();
Return Value

Returns true if the RebarBand is visible; otherwise, returns false.

Description

Retrieves a boolean value that indicates whether the RebarBand is visible.

RebarBand.getVisibleGripper

Syntax
public boolean getVisibleGripper();
Return Value

Returns true if the gripper is visible; otherwise, returns false.

Description

Retrieves a boolean value that indicates whether the RebarBand's gripper is visible.

RebarBand.getWidth

Syntax
public int getWidth();
Return Value

Returns the current RebarBand's width.

Description

Retrieves the RebarBand's current width.

RebarBand.maximize

Syntax
public void maximize();
Description

Maximizes the current RebarBand within the Rebar control.

RebarBand.minimize

Syntax
public void minimize();
Description

Minimizes the current RebarBand within the Rebar control.

RebarBand.setAllowVariableHeight

Syntax
public void setAllowVariableHeight( boolean flag );
Parameters
flag
The VariableHeight style.
Description

Sets the RebarBand's VariableHeight style.

RebarBand.setAllowVertical

Syntax
public void setAllowVertical( boolean flag );
Parameters
flag
The Vertical property setting.
Description

Sets the RebarBand's Vertical property.

RebarBand.setBackColor

Syntax
public void setBackColor( Color backColor );
Parameters
backColor
The RebarBand's new current backcolor.
Description

Sets the RebarBand's current backcolor.

RebarBand.setBackgroundImage

Syntax
public void setBackgroundImage( Bitmap backgroundImage );
Parameters
backgroundImage
The RebarBand's new background bitmap.
Description

Sets the background image of the RebarBand.

RebarBand.setBandBreak

Syntax
public void setBandBreak( boolean value );
Parameters
value
The new value for the BandBreak property.
Description

Sets the BandBreak property. If BandBreak is set to true, this RebarBand will start on a new row.

See Also
getBandBreak

RebarBand.setChildControl

Syntax
public void setChildControl( Control childControl );
Parameters
childControl
The child control.
Description

Sets the child window for this RebarBand.

RebarBand.setChildEdge

Syntax
public void setChildEdge( boolean flag );
Parameters
flag
The new state of the ChildEdge property.
Description

Sets the RebarBand's ChildEdge property.

RebarBand.setFixedBitmap

Syntax
public void setFixedBitmap( boolean flag );
Parameters
flag
The state of the FixedBitmap property.
Description

Sets the RebarBand's FixedBitmap property.

RebarBand.setForeColor

Syntax
public void setForeColor( Color foreColor );
Parameters
foreColor
The ForeColor for this RebarBand.
Description

Sets the ForeColor for this RebarBand.

RebarBand.setGrowBy

Syntax
public void setGrowBy( int growby );
Parameters
growby
Pixels to grow by in variable-height mode.
Description

Sets the number of pixels this RebarBand can grow by when being resized. If this RebarBand is not a variable-height band, calls to this method are ignored.

RebarBand.setHeaderWidth

Syntax
public void setHeaderWidth( int headerWidth );
Parameters
headerWidth
Pixel width for the RebarBand's header text.
Description

Sets the pixel width for the RebarBand's header.

RebarBand.setIdealWidth

Syntax
public void setIdealWidth( int idealWidth );
Parameters
idealWidth
The ideal width.
Description

Sets the ideal width for a RebarBand in the Rebar control.

RebarBand.setImageIndex

Syntax
public void setImageIndex( int imageIndex );
Parameters
imageIndex
The index of this Rebar control's image.
Description

Sets the index of the image in the Rebar control's image list.

RebarBand.setIndex

Syntax
public void setIndex( int index );
Parameters
index
The index for this RebarBand.
Description

Sets the index for this RebarBand.

See Also
getIndex

RebarBand.setInitialHeight

Syntax
public void setInitialHeight( int initHeight );
Parameters
initHeight
Initial height of RebarBand in the Rebar control.
Description

Sets the initial height of a variable-height RebarBand in the Rebar control.

RebarBand.setMaxInitialHeight

Syntax
public void setMaxInitialHeight( int maxInitHeight );
Parameters
maxInitHeight
The maximum initial height of this RebarBand in the Rebar control.
Description

Sets the maximum initial height of a non-variable height RebarBand in the Rebar control.

RebarBand.setMinChildHeight

Syntax
public void setMinChildHeight( int minChildHeight );
Parameters
minChildHeight
The minimum initial height of this RebarBand's child window.
Description

Sets the minimum initial height of this RebarBand's child window.

RebarBand.setMinChildWidth

Syntax
public void setMinChildWidth( int minChildWidth );
Parameters
minChildWidth
The minimum initial width of this RebarBand's child window
Description

Sets the minimum initial width of this RebarBand's child window.

RebarBand.setText

Syntax
public void setText( String text );
Parameters
text
Text to be displayed in the header of this RebarBand.
Description

Sets the header text for this RebarBand.

RebarBand.setVisible

Syntax
public void setVisible( boolean flag );
Parameters
flag
The new state of the Visible property.
Description

Sets the RebarBand's Visible property.

RebarBand.setVisibleGripper

Syntax
public void setVisibleGripper( boolean flag );
Parameters
flag
The new state of the VisibleGripper property.
Description

Sets the RebarBand's VisibleGripper property.

RebarBand.setWidth

Syntax
public void setWidth( int width );
Parameters
width
The pixel width for this RebarBand.
Description

Sets the pixel width of the RebarBand.

RebarBand.toString

Syntax
public String toString();
Return Value

Returns a String representation of this RebarBand object.

Description

Returns a string representation of this object.