com.smartgwt.client.widgets.layout

Class NavigationBarViewState

java.lang.Object

com.smartgwt.client.core.JsObject

com.smartgwt.client.core.DataClass

com.smartgwt.client.widgets.layout.NavigationBarViewState

All Implemented Interfaces:

com.google.gwt.event.shared.HasHandlers

public class NavigationBarViewState
extends DataClass

Encapsulates state of a NavigationBar's view. A NavigationBarViewState object is created to pass to NavigationBar.setViewState() so that multiple properties of the NavigationBar can be changed at once.

Field Summary

Fields inherited from class com.smartgwt.client.core.DataClass

factoryCreated, factoryProperties, readOnly

Fields inherited from class com.smartgwt.client.core.JsObject

jsObj

Constructor Summary

Constructors

Constructor and Description
NavigationBarViewState()
NavigationBarViewState(com.google.gwt.core.client.JavaScriptObject jsObj)

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getAlwaysShowLeftButtonTitle() The new NavigationBar.alwaysShowLeftButtonTitle setting.
java.lang.String[]	getControls() The new NavigationBar.controls setting.
Canvas	getControlsAsCanvas() The new NavigationBar.controls setting.
java.lang.String	getLeftButtonTitle() The new NavigationBar.leftButtonTitle setting.
static NavigationBarViewState	getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
java.lang.String	getShortLeftButtonTitle() The new NavigationBar.shortLeftButtonTitle setting.
java.lang.Boolean	getShowLeftButton() The new NavigationBar.showLeftButton setting.
java.lang.String	getTitle() The new NavigationBar.title setting.
void	setAlwaysShowLeftButtonTitle(java.lang.Boolean alwaysShowLeftButtonTitle) The new NavigationBar.alwaysShowLeftButtonTitle setting.
void	setControls(Canvas controls) The new NavigationBar.controls setting.
void	setControls(java.lang.String... controls) The new NavigationBar.controls setting.
void	setLeftButtonTitle(java.lang.String leftButtonTitle) The new NavigationBar.leftButtonTitle setting.
void	setShortLeftButtonTitle(java.lang.String shortLeftButtonTitle) The new NavigationBar.shortLeftButtonTitle setting.
void	setShowLeftButton(java.lang.Boolean showLeftButton) The new NavigationBar.showLeftButton setting.
void	setTitle(java.lang.String title) The new NavigationBar.title setting.
void	unsetAlwaysShowLeftButtonTitle()
void	unsetControls()
void	unsetLeftButtonTitle()
void	unsetShortLeftButtonTitle()
void	unsetShowLeftButton()
void	unsetTitle()

Methods inherited from class com.smartgwt.client.core.DataClass

applyFactoryProperties, doAddHandler, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsDoubleArray, getAttributeAsFloat, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getAttributes, getHandlerCount, getReadOnly, isFactoryCreated, logConfiguration, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreated, setReadOnly

Methods inherited from class com.smartgwt.client.core.JsObject

equals, getJsObj, hashCode, isCreated, setJavaScriptObject, setJsObj

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NavigationBarViewState

public NavigationBarViewState()

NavigationBarViewState

public NavigationBarViewState(com.google.gwt.core.client.JavaScriptObject jsObj)

Method Detail

getOrCreateRef

public static NavigationBarViewState getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)

setAlwaysShowLeftButtonTitle

public void setAlwaysShowLeftButtonTitle(java.lang.Boolean alwaysShowLeftButtonTitle)

The new NavigationBar.alwaysShowLeftButtonTitle setting. If unset, the alwaysShowLeftButtonTitle setting is not changed.

Parameters:

alwaysShowLeftButtonTitle - Default value is null

getAlwaysShowLeftButtonTitle

public java.lang.Boolean getAlwaysShowLeftButtonTitle()

The new NavigationBar.alwaysShowLeftButtonTitle setting. If unset, the alwaysShowLeftButtonTitle setting is not changed.

Returns:

Boolean

setControls

public void setControls(java.lang.String... controls)

The new NavigationBar.controls setting. If unset, the controls array is not changed.

Parameters:

controls - Default value is null

getControls

public java.lang.String[] getControls()

The new NavigationBar.controls setting. If unset, the controls array is not changed.

Returns:

String...

setControls

public void setControls(Canvas controls)

The new NavigationBar.controls setting. If unset, the controls array is not changed.

Parameters:

controls - Default value is null

getControlsAsCanvas

public Canvas getControlsAsCanvas()

The new NavigationBar.controls setting. If unset, the controls array is not changed.

Returns:

Canvas

setLeftButtonTitle

public void setLeftButtonTitle(java.lang.String leftButtonTitle)

The new NavigationBar.leftButtonTitle setting. If unset, the leftButtonTitle is not changed.

Parameters:

leftButtonTitle - See HTMLString . Default value is null

getLeftButtonTitle

public java.lang.String getLeftButtonTitle()

The new NavigationBar.leftButtonTitle setting. If unset, the leftButtonTitle is not changed.

Returns:

See HTMLString

setShortLeftButtonTitle

public void setShortLeftButtonTitle(java.lang.String shortLeftButtonTitle)

The new NavigationBar.shortLeftButtonTitle setting. If unset, the shortLeftButtonTitle is not changed.

Parameters:

shortLeftButtonTitle - See HTMLString . Default value is null

getShortLeftButtonTitle

public java.lang.String getShortLeftButtonTitle()

The new NavigationBar.shortLeftButtonTitle setting. If unset, the shortLeftButtonTitle is not changed.

Returns:

See HTMLString

setShowLeftButton

public void setShowLeftButton(java.lang.Boolean showLeftButton)

The new NavigationBar.showLeftButton setting. If unset, the showLeftButton setting is not changed.

Parameters:

showLeftButton - Default value is null

getShowLeftButton

public java.lang.Boolean getShowLeftButton()

The new NavigationBar.showLeftButton setting. If unset, the showLeftButton setting is not changed.

Returns:

Boolean

setTitle

public void setTitle(java.lang.String title)

The new NavigationBar.title setting. If unset, the title is not changed.

Parameters:

title - See HTMLString . Default value is null

getTitle

public java.lang.String getTitle()

The new NavigationBar.title setting. If unset, the title is not changed.

Returns:

See HTMLString

unsetShowLeftButton

public void unsetShowLeftButton()

unsetLeftButtonTitle

public void unsetLeftButtonTitle()

unsetShortLeftButtonTitle

public void unsetShortLeftButtonTitle()

unsetAlwaysShowLeftButtonTitle

public void unsetAlwaysShowLeftButtonTitle()

unsetTitle

public void unsetTitle()

unsetControls

public void unsetControls()