Spiffy UI Framework

org.spiffyui.client.widgets
Class SlideDownPrefsPanel

java.lang.Object
  extended by HTMLPanel
      extended by org.spiffyui.client.widgets.SlideDownPrefsPanel

public class SlideDownPrefsPanel
extends HTMLPanel

The SlideDownPrefsPanel shows a tab that sticks to the bottom of the header of the page. It slides down when clicked to reveal a preferences panel for the current page. It will also fire event and notify SlideDownPrefsPanelToggleListeners when the panel is toggled (expanded or collapsed)


Constructor Summary
SlideDownPrefsPanel()
          Creates a new panel with a randomly generated ID
SlideDownPrefsPanel(java.lang.String id)
          Creates a new panel
SlideDownPrefsPanel(java.lang.String id, java.lang.String headerText)
          Create a new panel
 
Method Summary
 void addListener(SlideDownPrefsPanelToggleListener listener)
          Adds a SlideDownPrefsPanelToggleListener to the list of listeners
 void fireSlideDownPrefsPanelToggleEvent(boolean expand)
          Fires SlideDownPrefsPanelToggle event, and invokes onSlideDownPrefsPanelToggle on all listeners
 Panel getPanel()
          get the panel displayed when this panel is expanded
 java.lang.String getTitle()
           
 void removeListener(SlideDownPrefsPanelToggleListener listener)
          Removes a SlideDownPrefsPanelToggleListener from the list of listeners
 void setPanel(Panel panel)
          Set the panel displayed when this panel is expanded
 void setTitle(java.lang.String title)
           
 void togglePanel()
          Toggle the panel visible or Invisible
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SlideDownPrefsPanel

public SlideDownPrefsPanel()
Creates a new panel with a randomly generated ID


SlideDownPrefsPanel

public SlideDownPrefsPanel(java.lang.String id)
Creates a new panel

Parameters:
id - - String the id of the panel

SlideDownPrefsPanel

public SlideDownPrefsPanel(java.lang.String id,
                           java.lang.String headerText)
Create a new panel

Parameters:
id - - String the id of the panel
headerText - - String the title of the panel and the label on the pull down tab, if null will use the default.
Method Detail

setTitle

public void setTitle(java.lang.String title)

getTitle

public java.lang.String getTitle()

setPanel

public void setPanel(Panel panel)
Set the panel displayed when this panel is expanded

Parameters:
panel - the panel to display

getPanel

public Panel getPanel()
get the panel displayed when this panel is expanded

Returns:
the panel

togglePanel

public void togglePanel()
Toggle the panel visible or Invisible


addListener

public void addListener(SlideDownPrefsPanelToggleListener listener)
Adds a SlideDownPrefsPanelToggleListener to the list of listeners

Parameters:
listener - - the listener to add

removeListener

public void removeListener(SlideDownPrefsPanelToggleListener listener)
Removes a SlideDownPrefsPanelToggleListener from the list of listeners

Parameters:
listener - the listener to remove

fireSlideDownPrefsPanelToggleEvent

public void fireSlideDownPrefsPanelToggleEvent(boolean expand)
Fires SlideDownPrefsPanelToggle event, and invokes onSlideDownPrefsPanelToggle on all listeners

Parameters:
expand - - boolean flag indicating whether the panel is being expanded or collapsed

Spiffy UI Framework