abstract class flux::SideBar

sys::Obj
  fwt::Widget
    fwt::Pane
      fwt::ContentPane
        flux::SideBar

Source

SideBar is a plugin used along side the main views. SideBars are registered using the indexed prop "flux.sideBar={qname}".

frame

Frame? frame { internal set }

Source

Get the top level flux window.

hide

This hide()

Source

Hide this sidebar in the frame.

onActive

virtual Void onActive(View view)

Source

Callback when specified view is selected as the active tab. This callback is invoked only if showing.

onGotoMark

virtual Void onGotoMark(Mark mark)

Source

Callback before the current view is jumped to the specified mark.

onHide

virtual Void onHide()

Source

Callback when sidebar is hidden in the frame.

onInactive

virtual Void onInactive(View view)

Source

Callback when specified view is unselected as the active tab. This callback is invoked only if showing.

onLoad

virtual Void onLoad()

Source

Callback when sidebar is first loaded into memory. This is the time to load persistent state.

onMarks

virtual Void onMarks(Mark[] marks)

Source

Callback when the frame's list of marks is updated.

onShow

virtual Void onShow()

Source

Callback when sidebar is shown in the frame.

onUnload

virtual Void onUnload()

Source

Callback when sidebar is being unloaded from memory. This is the time to save persistent state. This is called no matter whether the sidebar is shown or hidden.

prefAlign

virtual Obj prefAlign()

Source

Get this sidebar's preferred alignment which is used to determine its default position. Valid values are:

  • Halign.left (default)
  • Halign.right
  • Valign.bottom
show

This show()

Source

Show this sidebar in the frame.

showing

Bool showing := false { internal set }

Source

Is the sidebar currently shown in the frame?