Rebar Class

Rebar Class

This Package | All Packages

Component
  |
  +--Control
    |
    +--Rebar
public class Rebar
extends Control

Encapsulates a Rebar control. A Rebar control is a toolbar control that hosts other controls inside moveable bands. You can use these bands to resize, reposition, or hide the control.

Constructors
Name Description
Rebar() Creates a Rebar control.

Methods
Name Description
add(Control control) Adds a control to the Rebar control.
addBand(RebarBand band) Adds a RebarBand to the Rebar control.
addOnAutoSize(AutoSizeEventHandler handler) Adds an onAutoSize event listener.
addOnHeightChange(EventHandler handler) Adds an onHeightChange event listener.
addOnLayoutChange(EventHandler handler) Adds an onLayoutChange event listener.
getAutoSize() Retrieves a boolean value that indicates whether autosizing is set for the Rebar control.
getBandBorders() Retrieves a boolean value that indicates whether the current control has BandBorders.
getBands() Retrieves the current bands and returns them in an array of RebarBand objects.
getBorder() Retrieves a boolean value that indicates whether the current control has a border.
getDoubleClickToggle() Topic under construction.
getFixedOrder() Topic under construction.
getImageList() Retrieves the current ImageList.
getOrientation() Retrieves the current orientation of the control.
onAutoSize(AutoSizeEvent event) The event handler for the autoSize event, which occurs when autosizing is applied to the bands in the Rebar control.
onHeightChange(Event event) The heightChange event handler, which occurs whenever bands are repositioned to require the height of the control to change.
onLayoutChange(Event event) The layoutChange event handler, which occurs whenever the bands position changes.
onResize(Event event) The event handler for the onResize event, which is fired whenever the control's dimensions change.
remove(Control ctl) Removes a control from the Rebar control.
removeAllBands() Removes all bands from the Rebar.
removeBand(RebarBand band) Removes a specified band from the Rebar.
removeOnAutoSize(AutoSizeEventHandler handler) Removes an onAutoSize event listener.
removeOnHeightChange(EventHandler handler) Removes an onHeightChange event listener.
removeOnLayoutChange(EventHandler handler) Removes an onLayoutChange event listener.
setAutoSize(boolean value) Sets the AutoSize property.
setBandBorders(boolean value) Sets the BandBorders.
setBands(RebarBand[] bands) Sets the bands.
setBorder(boolean value) Sets the Border property.
setDock(int dock) Topic under construction.
setDoubleClickToggle(boolean value) Sets the DoubleClickToggle property.
setFixedOrder(boolean value) Sets the FixedOrder property.
setImageList(ImageList value) Sets the ImageList to be used with the Rebar.
setNewControls(Control[] ctls) Sets the controls that will appear in the Rebar.
setOrientation(int value) Sets the Orientation property.
setSite(ISite site) Topic under construction.

Constructors

Rebar.Rebar

Syntax
public Rebar();
Description

Creates a Rebar control.

Methods

Rebar.add

Syntax
public void add( Control control );
Parameters
control
The control to add.
Description

Adds a control to the Rebar control.

Overrides

add(Control) in Control.

See Also
wfc.ui.Control.add

Rebar.addBand

Syntax
public void addBand( RebarBand band );
Parameters
band
The RebarBand to add to the Rebar control.
Description

Adds a RebarBand to the Rebar control.

Rebar.addOnAutoSize

Syntax
public void addOnAutoSize( AutoSizeEventHandler handler );
Parameters
handler
The delegate to add to the event.
Description

Adds an onAutoSize event listener.

See Also
removeOnAutoSize, onAutoSize

Rebar.addOnHeightChange

Syntax
public void addOnHeightChange( EventHandler handler );
Parameters
handler
The delegate to add to the event.
Description

Adds an onHeightChange event listener.

See Also
removeOnHeightChange, onHeightChange

Rebar.addOnLayoutChange

Syntax
public void addOnLayoutChange( EventHandler handler );
Parameters
handler
The delegate to add to the event.
Description

Adds an onLayoutChange event listener.

See Also
removeOnLayoutChange, onLayoutChange

Rebar.getAutoSize

Syntax
public boolean getAutoSize();
Return Value

Returns current AutoSize value.

Description

Retrieves a boolean value that indicates whether autosizing is set for the Rebar control.

See Also
setAutoSize

Rebar.getBandBorders

Syntax
public boolean getBandBorders();
Return Value

Returns true if the control has BandBorders; otherwise, returns false.

Description

Retrieves a boolean value that indicates whether the current control has BandBorders.

See Also
setBandBorders

Rebar.getBands

Syntax
public RebarBand[] getBands();
Return Value

Returns an array of RebarBand objects that contains the current bands for this control.

Description

Retrieves the current bands and returns them in an array of RebarBand objects.

See Also
setBands

Rebar.getBorder

Syntax
public boolean getBorder();
Return Value

Returns true if the control has a border; otherwise, returns false.

Description

Retrieves a boolean value that indicates whether the current control has a border.

See Also
setBorder

Rebar.getDoubleClickToggle

Syntax
public boolean getDoubleClickToggle();
Description

Topic under construction.

Rebar.getFixedOrder

Syntax
public boolean getFixedOrder();
Description

Topic under construction.

Rebar.getImageList

Syntax
public ImageList getImageList();
Return Value

Returns the current ImageList.

Description

Retrieves the current ImageList.

See Also
setImageList

Rebar.getOrientation

Syntax
public int getOrientation();
Return Value

Returns one of the enumeration constants defined in Orientation.HORIZONTAL.

Description

Retrieves the current orientation of the control.

See Also
setOrientation

Rebar.onAutoSize

Syntax
protected void onAutoSize( AutoSizeEvent event );
Parameters
event
The event data.
Description

The event handler for the autoSize event, which occurs when autosizing is applied to the bands in the Rebar control.

Rebar.onHeightChange

Syntax
protected void onHeightChange( Event event );
Parameters
event
The event data.
Description

The heightChange event handler, which occurs whenever bands are repositioned to require the height of the control to change.

Rebar.onLayoutChange

Syntax
protected void onLayoutChange( Event event );
Parameters
event
The event data.
Description

The layoutChange event handler, which occurs whenever the bands position changes.

Rebar.onResize

Syntax
protected void onResize( Event event );
Parameters
event
The event data.
Description

The event handler for the onResize event, which is fired whenever the control's dimensions change.

Overrides

onResize(Event) in Control.

See Also
wfc.ui.Control.onResize(Event)

Rebar.remove

Syntax
public void remove( Control ctl );
Parameters
ctl
The control to remove.
Description

Removes a control from the Rebar control.

Overrides

remove(Control) in Control.

See Also
wfc.ui.Control.remove(com.ms.wfc.ui.Control)

Rebar.removeAllBands

Syntax
public void removeAllBands();
Description

Removes all bands from the Rebar.

Rebar.removeBand

Syntax
public void removeBand( RebarBand band );
Parameters
band
The band to remove.
Description

Removes a specified band from the Rebar.

Rebar.removeOnAutoSize

Syntax
public void removeOnAutoSize( AutoSizeEventHandler handler );
Parameters
handler
The delegate to remove.
Description

Removes an onAutoSize event listener.

See Also
addOnAutoSize, onAutoSize

Rebar.removeOnHeightChange

Syntax
public void removeOnHeightChange( EventHandler handler );
Parameters
handler
The delegate to remove.
Description

Removes an onHeightChange event listener.

See Also
addOnHeightChange, onHeightChange

Rebar.removeOnLayoutChange

Syntax
public void removeOnLayoutChange( EventHandler handler );
Parameters
handler
The delegate to remove.
Description

Removes an onLayoutChange event listener.

See Also
addOnLayoutChange, onLayoutChange

Rebar.setAutoSize

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

Sets the AutoSize property. When AutoSize is set to true, the Rebar automatically sizes itself to fit the contained bands.

See Also
getAutoSize

Rebar.setBandBorders

Syntax
public void setBandBorders( boolean value );
Parameters
value
The new value for BandBorders.
Description

Sets the BandBorders. When BandBorders is set to true, a small border is drawn around each band.

See Also
getBandBorders

Rebar.setBands

Syntax
public void setBands( RebarBand[] bands );
Parameters
bands
The list of bands that the Rebar will contain.
Description

Sets the bands. Each band in the Rebar contains a child control.

See Also
getBands

Rebar.setBorder

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

Sets the Border property. When Border is set to true, a small border is drawn around the Rebar.

See Also
getBorder

Rebar.setDock

Syntax
public void setDock( int dock );
Description

Topic under construction.

Overrides

setDock(int) in Control.

Rebar.setDoubleClickToggle

Syntax
public void setDoubleClickToggle( boolean value );
Parameters
value
The new DoubleClickToggle value.
Description

Sets the DoubleClickToggle property. When DoubleClickToggle is set to true, users can enlarge and shrink bands by double-clicking the band header.

See Also
getDoubleClickToggle

Rebar.setFixedOrder

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

Sets the FixedOrder property. When FixedOrder is set to true, the contained bands can be sized, but the order of the bands cannot be changed.

See Also
getFixedOrder

Rebar.setImageList

Syntax
public void setImageList( ImageList value );
Parameters
value
The ImageList to be used.
Description

Sets the ImageList to be used with the Rebar.

See Also
getImageList

Rebar.setNewControls

Syntax
public void setNewControls( Control[] ctls );
Parameters
ctls
The controls to put in the Rebar.
Description

Sets the controls that will appear in the Rebar.

Overrides

setNewControls(Control[]) in Control.

See Also
wfc.ui.Control.setNewControls

Rebar.setOrientation

Syntax
public void setOrientation( int value );
Parameters
value
The new orientation value.
Description

Sets the Orientation property. This controls the direction in which the bands are drawn.

See Also
getOrientation

Rebar.setSite

Syntax
public void setSite( ISite site );
Description

Topic under construction.

Overrides

setSite(ISite) in Control.

See Also
wfc.core.Component.setSite