com.google.gwt.widgetideas.client
Class PinnedPanel

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.google.gwt.user.client.ui.Composite
              extended by com.google.gwt.widgetideas.client.PinnedPanel
All Implemented Interfaces:
com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.SourcesChangeEvents

public class PinnedPanel
extends com.google.gwt.user.client.ui.Composite
implements com.google.gwt.user.client.ui.SourcesChangeEvents

PinnedPanel creates a panel that is, by default, pinned in place. When the pinned state it toggled, the contents of the panel will display only when the users mouse hovers over it, otherwise is will collapse to the left. A ChangeEvent is fired whenever the PinnedPanel changes it pinned state.

The default style name is gwt-PinnedPanel.

Planned enhancements: Allow panel to be collapsed in arbitrary direction.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled
 
Field Summary
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
PinnedPanel(int width, com.google.gwt.user.client.ui.ToggleButton pinnedToggle, com.google.gwt.user.client.ui.Widget contents)
          Constructor.
PinnedPanel(int width, com.google.gwt.user.client.ui.ToggleButton pinnedToggle, com.google.gwt.user.client.ui.Widget contents, com.google.gwt.user.client.ui.Widget hoverBar)
          Constructor.
 
Method Summary
 void addChangeListener(com.google.gwt.user.client.ui.ChangeListener listener)
           
 com.google.gwt.user.client.ui.ToggleButton getSwitchButton()
           
 boolean isPinned()
          Is the panel pinned?
 void removeChangeListener(com.google.gwt.user.client.ui.ChangeListener listener)
           
 
Methods inherited from class com.google.gwt.user.client.ui.Composite
getElement, isAttached
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
getParent, onBrowserEvent, removeFromParent
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, addStyleName, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, isVisible, removeStyleDependentName, removeStyleName, setHeight, setPixelSize, setSize, setStyleName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkEvents, toString, unsinkEvents
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PinnedPanel

public PinnedPanel(int width,
                   com.google.gwt.user.client.ui.ToggleButton pinnedToggle,
                   com.google.gwt.user.client.ui.Widget contents)
Constructor.

Parameters:
width - width of panel
pinnedToggle - toggle for pinned state
contents - contents to be displayed

PinnedPanel

public PinnedPanel(int width,
                   com.google.gwt.user.client.ui.ToggleButton pinnedToggle,
                   com.google.gwt.user.client.ui.Widget contents,
                   com.google.gwt.user.client.ui.Widget hoverBar)
Constructor.

Parameters:
width - width of panel
pinnedToggle - toggle for pinned state
contents - contents to be displayed
hoverBar - hover bar
Method Detail

addChangeListener

public void addChangeListener(com.google.gwt.user.client.ui.ChangeListener listener)
Specified by:
addChangeListener in interface com.google.gwt.user.client.ui.SourcesChangeEvents

getSwitchButton

public com.google.gwt.user.client.ui.ToggleButton getSwitchButton()

isPinned

public boolean isPinned()
Is the panel pinned?


removeChangeListener

public void removeChangeListener(com.google.gwt.user.client.ui.ChangeListener listener)
Specified by:
removeChangeListener in interface com.google.gwt.user.client.ui.SourcesChangeEvents