public abstract class

SlideScreen

extends Screen

java.lang.Object
↳	com.neomades.app.Screen
	↳	com.neomades.app.SlideScreen

Class Overview

The SlideScreen is a screen that manages the presentation of three side-by-side Screen. The left screen and the right screen are slideable and are hidden at the presentation of the slide screen.

You use this class to implement a Screen with sliding menu user interface.

A typical implementation of SlideScreen could be:

 public class MySLideScreen extends SlideScreen {
 
 	public void onCreate() {
 		// content
 		setMiddleScreen(MyContentScreen.class);
 
 		// A sliding menu will be displayed on the left part
 		setLeftScreen(MySlidingMenuScreen.class);
 	}
 
 }

SlideScreen Life cycle

As SlideScreen is a Screen, the same lifecyle applies. Some rules exist for the SlideScreen's sub-screens:

When a SlideScreen is resumed, all the sub-screens are resumed,
When a SlideScreen is paused, all the sub-screens are paused,
When a SlideScreen is destroyed, all the sub-screens are destroyed.

Opening or closing a panel of the SlideScreen does not have any effect on sub-screens lifecycle.

Summary

[Expand]

Inherited Constants

From class com.neomades.app.Screen

From interface com.neomades.app.Keys

From interface com.neomades.app.Orientation

From interface com.neomades.ui.Alignment

From interface com.neomades.ui.StretchMode

[Expand]

Inherited Fields

From class com.neomades.app.Screen

Public Constructors
	SlideScreen()

Public Methods
boolean	isLeftScreenOpened() Checks if the left sliding pane is opened or not.
boolean	isRightScreenOpened() Checks if the right sliding pane is opened or not.
void	setLeftScreenOpened(boolean opened) Programmatically opens or closes the left pane.
void	setLeftScreenWidth(int width) Forces a width for the left pane.
void	setLeftSlidingTouchEnabled(boolean enabled) Activates or deactivates the opening of the left panel by dragging the screen.
void	setRightScreenOpened(boolean opened) Programmatically opens or closes the right pane.
void	setRightScreenWidth(int width) Forces a width for the right pane.

Protected Methods
void	onLeftScreenClosed() Called when the left screen is closed.
void	onLeftScreenOpened() Called when the left screen is opened.
void	onRightScreenClosed() Called when the right screen is closed.
void	onRightScreenOpened() Called when the right screen is opened.
void	setContent(View content) Do not use this method: to set the middle content of a `SlideScreen`, use `setMiddleScreen(Class)`.
void	setContent(int layoutResId) Do not use this method: to set the middle content of a `SlideScreen`, use `setMiddleScreen(Class)`.
void	setLeftScreen(Class screen) Sets the left sliding pane screen.
void	setLeftScreen(Class screen, ScreenParams params) Sets the left sliding pane screen with screen parameters.
void	setLeftShadowEnabled(boolean enabled) Enables or not the shadow over the middle screen when the left screen is opened.
void	setLeftSlidingTouchAreaWidth(int width) Sets the area width where the SlideScreen's left screen can be dragged.
void	setMiddleScreen(Class screen, ScreenParams params) Sets the middle screen (main screen) of this `SlideScreen` with screen parameters.
void	setMiddleScreen(Class screen) Sets the middle screen (main screen) of this `SlideScreen`.
void	setRightContentSlidingEnabled(boolean enabled) Enables or disables the middle content sliding effect when the right panel is sliding.
void	setRightScreen(Class screen) Sets the right sliding pane screen.
void	setRightScreen(Class screen, ScreenParams params) Sets the right sliding pane screen with screen parameters.
void	setRightShadowEnabled(boolean enabled) Enables or not the shadow over the middle screen when the right screen is opened.

[Expand]

Inherited Methods

From class com.neomades.app.Screen

final void	applyTitleBackgroundColorToStatusBar() Configure the color of the status bar to be the same as the title bar.
View	findView(int viewId)
EventBus	getApplicationEventBus() Gets the application's eventBus if exist.
View	getContent() Gets the content of this screen.
final Controller	getController() Gets the navigation Controller instance.
Keyboard	getKeyboard() Returns a `Keyboard` instance for the current `Screen`.
final int	getOrientation() Returns the current device orientation.
ScreenParams	getScreenParams() Return the parameters.
final void	hideTitleBarLeftMenuItem() Hide the default "Home" button item that appears in the left menu of the Title Bar of the first screen in the Android version of the application.
void	onContentError(ContentError error) Called when an error has been broadcasting to this screen.
void	onContentResponse(ContentResponse response) Called when a content response has been broadcasting to this screen.
abstract void	onCreate() This method has to be overridden to initialize the screen : creation and layout of UI elements, initializations, ...
void	onDestroy() This method can be overridden to provide a specific behavior when the screen is destroyed.
void	onKeyEvent(KeyEvent keyEvent) Called when a key is dispatched to a screen.
void	onMenuAction(MenuItem item) This method can be overridden to provide a specific behavior when a item of the Menu is chosen.
void	onMenuCreate(Menu menu) This method can be overridden to retrieve the menu corresponding to this screen.
void	onOrientationChanged(int orientation) Called when the screen orientation has changed.
void	onPause() This method can be overridden to provide a specific behavior when the screen is paused.
void	onReceiveEvent(Event event) Called when this screen has received an event (inside UI-Thread).
void	onResume() This method can be overridden to provide a specific behavior when the screen is resumed, after it has been paused.
void	onTouchEvent(TouchEvent touchEvent) Called when a touch is dispatched to a screen.
void	postQuery(Query query) Posts a query to a `ContentManager`.
void	registerContentError() Registers this screen to receive all `ContentError` event's type.
void	registerEvent(String type) Registers this screen to receive the given `ContentResponse` event's type.
void	registerEvents() This method is deprecated. Use `registerContentError()` instead.
void	send(Event event) Sends an event into Application's event bus.
void	setActivityIndicatorVisible(boolean visible) Shows or hides the activity indicator.
final void	setBackButtonText(String backButtonText) Replaces the "Back" button text for the current screen.
final void	setBackButtonTextColor(Color backButtonTextColor) Changes the "Back" button text color for the current screen.
final void	setBackground(Background background) Set the background for this screen.
final void	setBackgroundColor(Color color) Sets the background color of the screen.
final void	setBackgroundImage(int imageID) Set the background image for this screen.
final void	setBackgroundImage(Image image) Set the background image for this screen.
void	setContent(int layoutResId) Sets the content of this screen, with the root view of the layout.
void	setContent(View content) Sets the content of this screen, with the view passed in parameter.
final void	setFullscreenMode(boolean fullscreen) Hides title bar and bottom toolbar.
final void	setResult(ScreenParams result) Close the screen and send result to the `ScreenResultListener`.
final void	setSupportedOrientation(int orientation) Forces the screen to be in portrait and/or landscape mode.
final void	setTitle(int resId) Sets the title of the screen, which will be displayed at the top of the screen
final void	setTitle(String title) Sets the title of the screen, which will be displayed at the top of the screen.
final void	setTitleBackground(Background background) Sets the title bar background
final void	setTitleBackgroundColor(Color bgColor) Sets the title bar background color
final void	setTitleBackgroundImage(Image image) Sets the title bar background image
final void	setTitleBackgroundImage(int resImage) Sets the title bar background image
final void	setTitleBarStyle(int style) Sets the iOS title bar style
final void	setTitleBarTranslucent(boolean translucent) Sets the title bar translucent or not
final void	setTitleBarVisible(boolean visible) Set the navigation bar (iOS), action bar (Android) or title bar visible or not without animation.
final void	setTitleBarVisibleAnimated(boolean visible) Set the navigation bar (iOS), action bar (Android) or title bar visible or not with animation.
final void	setTitleColor(Color titleColor) Sets the title text color
final void	setTitleFont(Font font) Sets the title font
void	setTitleKeepNativeCase(boolean enabled) Enables or disables the title native case.
final void	setTitleView(View view) Replaces the title view (inside the title bar) with a custom View.
void	unregisterEvent(String type) Unregisters this screen to receive the given event's type.
void	unregisterEvents() Unregisters this screen to receive all event's type.

From class java.lang.Object

boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
final Class<?>	getClass() Returns the runtime class of an object.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait(long timeout, int nanos) Causes current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
final void	wait() Causes current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Public Constructors

public SlideScreen ()

Public Methods

public boolean isLeftScreenOpened ()

Checks if the left sliding pane is opened or not.

Returns

true if the left sliding pane is opened

public boolean isRightScreenOpened ()

Checks if the right sliding pane is opened or not.

Returns

true if the right sliding pane is opened

public void setLeftScreenOpened (boolean opened)

Programmatically opens or closes the left pane.

Parameters

opened	`true` to open the sliding left pane

public void setLeftScreenWidth (int width)

Forces a width for the left pane. Negative values are ignored (default width is used).

Parameters

width	`width` in DP units

public void setLeftSlidingTouchEnabled (boolean enabled)

Activates or deactivates the opening of the left panel by dragging the screen. By default it is activated.

Parameters

enabled	true to enable (default value)

public void setRightScreenOpened (boolean opened)

Programmatically opens or closes the right pane.

Parameters

opened	`true` to open the sliding right pane

public void setRightScreenWidth (int width)

Forces a width for the right pane. Negative values are ignored (default width is used).

Parameters

width	`width` in DP units

Protected Methods

protected void onLeftScreenClosed ()

Called when the left screen is closed. Override this method to add custom actions when the left screen has just closed.

protected void onLeftScreenOpened ()

Called when the left screen is opened. Override this method to add custom actions when the left screen has just opened.

protected void onRightScreenClosed ()

Called when the right screen is closed. Override this method to add custom actions when the right screen has just closed.

protected void onRightScreenOpened ()

Called when the right screen is opened. Override this method to add custom actions when the right screen has just opened.

protected void setContent (View content)

Do not use this method: to set the middle content of a SlideScreen, use setMiddleScreen(Class).

An IllegalStateException will be thrown if this method is called for a SlideScreen.

Parameters

content	the content of this screen

protected void setContent (int layoutResId)

Do not use this method: to set the middle content of a SlideScreen, use setMiddleScreen(Class).

An IllegalStateException will be thrown if this method is called for a SlideScreen.

Parameters

layoutResId	Resources ID of the XML layout

Throws

ResourceNotFoundException

protected void setLeftScreen (Class screen)

Sets the left sliding pane screen.

Parameters

screen	the left screen

protected void setLeftScreen (Class screen, ScreenParams params)

Sets the left sliding pane screen with screen parameters.

Parameters

screen	the left screen
params	screen parameters for the left screen

protected void setLeftShadowEnabled (boolean enabled)

Enables or not the shadow over the middle screen when the left screen is opened. By default the shadow is enabled in Android.

Cross Platform Considerations

In iOS, this method does nothing.

Parameters

enabled	true to enable (default value)

protected void setLeftSlidingTouchAreaWidth (int width)

Sets the area width where the SlideScreen's left screen can be dragged.

Cross Platform Considerations

In iOS, there is a minimal width of 50 dp. Inputs below this value are ignored. If the input width is lower, the hardware may not detect the user finger.

In Android, there is a minimal width of 50 dp. Inputs below this value are ignored. If the input width is lower, the hardware may not detect the user finger.

Parameters

width	the area width in dp, 0 or negative to use all the available width

protected void setMiddleScreen (Class screen, ScreenParams params)

Sets the middle screen (main screen) of this SlideScreen with screen parameters.

Parameters

screen	the middle screen
params	screen parameters for the middle screen

protected void setMiddleScreen (Class screen)

Sets the middle screen (main screen) of this SlideScreen.

Parameters

screen	the middle screen

protected void setRightContentSlidingEnabled (boolean enabled)

Enables or disables the middle content sliding effect when the right panel is sliding.

If true the middle content will be pushed from right to left by the right panel. Otherwise, the right panel will slide over the middle content.

Cross Platform Considerations

In iOS, this method has no effect. The middle content sliding effect is always enabled.

Parameters

enabled	`true` to enable middle content sliding effect

protected void setRightScreen (Class screen)

Sets the right sliding pane screen.

Parameters

screen	the right screen

protected void setRightScreen (Class screen, ScreenParams params)

Sets the right sliding pane screen with screen parameters.

Parameters

screen	the right screen
params	screen parameters for the right screen

protected void setRightShadowEnabled (boolean enabled)

Enables or not the shadow over the middle screen when the right screen is opened. By default the shadow is enabled in Android.

Cross Platform Considerations

In iOS, this method does nothing.

Parameters

enabled	true to enable (default value)

Interfaces

Classes

Exceptions

SlideScreen

Class Overview

SlideScreen Life cycle

Summary

Public Constructors

public SlideScreen ()

Public Methods

public boolean isLeftScreenOpened ()

Returns

public boolean isRightScreenOpened ()

Returns

public void setLeftScreenOpened (boolean opened)

Parameters

public void setLeftScreenWidth (int width)

Parameters

public void setLeftSlidingTouchEnabled (boolean enabled)

Parameters

public void setRightScreenOpened (boolean opened)

Parameters

public void setRightScreenWidth (int width)

Parameters

Protected Methods

protected void onLeftScreenClosed ()

protected void onLeftScreenOpened ()

protected void onRightScreenClosed ()

protected void onRightScreenOpened ()

protected void setContent (View content)

Parameters

See Also

protected void setContent (int layoutResId)

Parameters

Throws

See Also

protected void setLeftScreen (Class screen)

Parameters

protected void setLeftScreen (Class screen, ScreenParams params)

Parameters

protected void setLeftShadowEnabled (boolean enabled)

Cross Platform Considerations

Parameters

protected void setLeftSlidingTouchAreaWidth (int width)

Cross Platform Considerations

Parameters

protected void setMiddleScreen (Class screen, ScreenParams params)

Parameters

protected void setMiddleScreen (Class screen)

Parameters

protected void setRightContentSlidingEnabled (boolean enabled)

Cross Platform Considerations

Parameters

protected void setRightScreen (Class screen)

Parameters

protected void setRightScreen (Class screen, ScreenParams params)

Parameters

protected void setRightShadowEnabled (boolean enabled)

Cross Platform Considerations

Parameters