|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.Widget
com.google.gwt.user.client.ui.Composite
com.google.gwt.user.client.ui.TabBar
public class TabBar
A horizontal bar of folder-style tabs, most commonly used as part of a
TabPanel
.
public class TabBarExample implements EntryPoint { public void onModuleLoad() { // Create a tab bar with three items. TabBar bar = new TabBar(); bar.addTab("foo"); bar.addTab("bar"); bar.addTab("baz"); // Hook up a tab listener to do something when the user selects a tab. bar.addTabListener(new TabListener() { public void onTabSelected(SourcesTabEvents sender, int tabIndex) { // Let the user know what they just did. Window.alert("You clicked tab " + tabIndex); } public boolean onBeforeTabSelected(SourcesTabEvents sender, int tabIndex) { // Just for fun, let's disallow selection of 'bar'. if (tabIndex == 1) return false; return true; } }); // Add it to the root panel. RootPanel.get().add(bar); } }
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject |
---|
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled |
Field Summary |
---|
Fields inherited from class com.google.gwt.user.client.ui.UIObject |
---|
DEBUG_ID_PREFIX |
Fields inherited from interface com.google.gwt.user.client.ui.KeyboardListener |
---|
KEY_ALT, KEY_BACKSPACE, KEY_CTRL, KEY_DELETE, KEY_DOWN, KEY_END, KEY_ENTER, KEY_ESCAPE, KEY_HOME, KEY_LEFT, KEY_PAGEDOWN, KEY_PAGEUP, KEY_RIGHT, KEY_SHIFT, KEY_TAB, KEY_UP, MODIFIER_ALT, MODIFIER_CTRL, MODIFIER_META, MODIFIER_SHIFT |
Constructor Summary | |
---|---|
TabBar()
Creates an empty tab bar. |
Method Summary | |
---|---|
void |
addTab(java.lang.String text)
Adds a new tab with the specified text. |
void |
addTab(java.lang.String text,
boolean asHTML)
Adds a new tab with the specified text. |
void |
addTab(Widget widget)
Adds a new tab with the specified widget. |
void |
addTabListener(TabListener listener)
Adds a listener interface to receive click events. |
protected SimplePanel |
createTabTextWrapper()
Create a SimplePanel that will wrap the contents in a tab. |
int |
getSelectedTab()
Gets the tab that is currently selected. |
int |
getTabCount()
Gets the number of tabs present. |
java.lang.String |
getTabHTML(int index)
Gets the specified tab's HTML. |
void |
insertTab(java.lang.String text,
boolean asHTML,
int beforeIndex)
Inserts a new tab at the specified index. |
void |
insertTab(java.lang.String text,
int beforeIndex)
Inserts a new tab at the specified index. |
void |
insertTab(Widget widget,
int beforeIndex)
Inserts a new tab at the specified index. |
protected void |
insertTabWidget(Widget widget,
int beforeIndex)
Inserts a new tab at the specified index. |
void |
onClick(Widget sender)
Fired when the user clicks on a widget. |
protected void |
onEnsureDebugId(java.lang.String baseID)
Affected Elements: -tab# = The element containing the contents of the tab. -tab-wrapper# = The cell containing the tab at the index. |
void |
onKeyDown(Widget sender,
char keyCode,
int modifiers)
Fired when the user depresses a physical key. |
void |
onKeyPress(Widget sender,
char keyCode,
int modifiers)
Fired when a keyboard action generates a character. |
void |
onKeyUp(Widget sender,
char keyCode,
int modifiers)
Fired when the user releases a physical key. |
void |
removeTab(int index)
Removes the tab at the specified index. |
void |
removeTabListener(TabListener listener)
Removes a previously added listener interface. |
boolean |
selectTab(int index)
Programmatically selects the specified tab. |
Methods inherited from class com.google.gwt.user.client.ui.Composite |
---|
getWidget, initWidget, isAttached, onAttach, onBrowserEvent, onDetach, setWidget |
Methods inherited from class com.google.gwt.user.client.ui.Widget |
---|
doAttachChildren, doDetachChildren, getParent, onLoad, onUnload, removeFromParent |
Methods inherited from class com.google.gwt.user.client.ui.UIObject |
---|
addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkEvents, toString, unsinkEvents |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public TabBar()
Method Detail |
---|
public void addTab(java.lang.String text)
text
- the new tab's textpublic void addTab(java.lang.String text, boolean asHTML)
text
- the new tab's textasHTML
- true
to treat the specified text as htmlpublic void addTab(Widget widget)
widget
- the new tab's widget.public void addTabListener(TabListener listener)
SourcesTabEvents
addTabListener
in interface SourcesTabEvents
listener
- the listener interface to addpublic int getSelectedTab()
public int getTabCount()
public java.lang.String getTabHTML(int index)
index
- the index of the tab whose HTML is to be retrieved
public void insertTab(java.lang.String text, boolean asHTML, int beforeIndex)
text
- the new tab's textasHTML
- true
to treat the specified text as HTMLbeforeIndex
- the index before which this tab will be insertedpublic void insertTab(java.lang.String text, int beforeIndex)
text
- the new tab's textbeforeIndex
- the index before which this tab will be insertedpublic void insertTab(Widget widget, int beforeIndex)
widget
- widget to be used in the new tab.beforeIndex
- the index before which this tab will be inserted.public void onClick(Widget sender)
ClickListener
onClick
in interface ClickListener
sender
- the widget sending the event.public void onKeyDown(Widget sender, char keyCode, int modifiers)
KeyboardListener
onKeyDown
in interface KeyboardListener
sender
- the widget that was focused when the event occurred.keyCode
- the physical key that was depressed. Constants for this
value are defined in this interface with the KEY prefix.modifiers
- the modifier keys pressed at when the event occurred. This
value is a combination of the bits defined by
KeyboardListener.MODIFIER_SHIFT
,
KeyboardListener.MODIFIER_CTRL
, and
KeyboardListener.MODIFIER_ALT
.public void onKeyPress(Widget sender, char keyCode, int modifiers)
KeyboardListener
It should be noted that many browsers do not generate keypress events for
non-printing keyCode values, such as KeyboardListener.KEY_ENTER
or
arrow keys. These keyCodes can be reliably captured either with
KeyboardListener.onKeyDown(Widget, char, int)
or
KeyboardListener.onKeyUp(Widget, char, int)
.
onKeyPress
in interface KeyboardListener
sender
- the widget that was focused when the event occurred.keyCode
- the Unicode character that was generated by the keyboard
action.modifiers
- the modifier keys pressed at when the event occurred. This
value is a combination of the bits defined by
KeyboardListener.MODIFIER_SHIFT
,
KeyboardListener.MODIFIER_CTRL
, and
KeyboardListener.MODIFIER_ALT
.public void onKeyUp(Widget sender, char keyCode, int modifiers)
KeyboardListener
onKeyUp
in interface KeyboardListener
sender
- the widget that was focused when the event occurred.keyCode
- the physical key that was released. Constants for this value
are defined in this interface with the KEY prefix.modifiers
- the modifier keys pressed at when the event occurred. This
value is a combination of the bits defined by
KeyboardListener.MODIFIER_SHIFT
,
KeyboardListener.MODIFIER_CTRL
, and
KeyboardListener.MODIFIER_ALT
.public void removeTab(int index)
index
- the index of the tab to be removedpublic void removeTabListener(TabListener listener)
SourcesTabEvents
removeTabListener
in interface SourcesTabEvents
listener
- the listener interface to removepublic boolean selectTab(int index)
index
- the index of the tab to be selected.
true
if successful, false
if the
change is denied by the TabListener
.protected SimplePanel createTabTextWrapper()
SimplePanel
that will wrap the contents in a tab.
Subclasses can use this method to wrap tabs in decorator panels.
SimplePanel
to wrap the tab contents, or null to leave
tabs unwrappedprotected void insertTabWidget(Widget widget, int beforeIndex)
widget
- widget to be used in the new tab.beforeIndex
- the index before which this tab will be inserted.protected void onEnsureDebugId(java.lang.String baseID)
onEnsureDebugId
in class UIObject
baseID
- the base ID used by the main elementUIObject.onEnsureDebugId(String)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |