public class AdfmfSlidingWindowOptions
extends Object
Modifier and Type | Field and Description |
---|---|
static String |
ANIMATION_STYLE_SLIDE_IN
Sliding windows are initially offscreen and animate into the view
from the direction specified.
|
static String |
DIRECTION_BOTTOM
The window will be anchored to the bottom side of the screen
|
static String |
DIRECTION_END
The window will be anchored to the right side for left to right
languages and the left side for right to left languages
|
static String |
DIRECTION_LEFT
The window will be anchored to the left side of the screen
|
static String |
DIRECTION_RIGHT
The window will be anchored to the right side of the screen
|
static String |
DIRECTION_START
The window will be anchored to the left side for left to
right languages and the right side for right to left languages
|
static String |
DIRECTION_TOP
The window will be anchored to the top side of the screen
|
static String |
LAYOUT_PRIORITY_HORIZONTAL
Sliding windows in the horizontal axis (left, right, start, end) will be assigned the space in the corners
and any adjacent vertical axis windows (top, bottom) will be shrunk accordingly
when two windows would potentially overlap.0
|
static String |
LAYOUT_PRIORITY_VERTICAL
Sliding windows in the vertical axis (top, bottom) will be assigned the space in the
corners and any horizontal axis windows (left, right, start, end) will be shrunk accordingly
when two windows would potentially overlap.0
|
static String |
STYLE_OVERLAID
An overlaid window is one that appears on top of the
main application content.
|
static String |
STYLE_PINNED
A pinned sliding window appears on screen next to the main
application content without overlapping
|
Constructor and Description |
---|
AdfmfSlidingWindowOptions()
Creates a new instance of AdfmfSlidingWindowOptions.
|
Modifier and Type | Method and Description |
---|---|
String |
getAnimationStyle()
Returns the animation style defined within these optoins
|
String |
getDirection()
Returns the direction to which the sliding window will be anchored
|
long |
getDuration()
Returns the duration used to animate sliding windows, in milliseconds.
|
String |
getLayoutPriority()
Obtains the layout priority defined within the options
|
String |
getSize()
Returns the size of the sliding window specified in these options
|
String |
getStyle()
Returns the style defined in the options
|
void |
setAnimationStyle(String animationStyle)
Sets the animation style to be used when showing or hiding
sliding windows
|
void |
setDirection(String direction)
Sets the direction used to display the sliding window.
|
void |
setDuration(long duration)
Specifies the amount of time, in milliseconds, that should be used to
perform any animations when showing the sliding window
|
void |
setLayoutPriority(String layoutPriority)
Sets the layout priority used to determine which directions will take priority
when determining the layout of pinned windows
|
void |
setSize(String size)
Sets the size of the sliding window.
|
void |
setStyle(String style)
Specifies the style of the the sliding window
|
String |
toString() |
public static final String DIRECTION_LEFT
public static final String DIRECTION_RIGHT
public static final String DIRECTION_TOP
public static final String DIRECTION_BOTTOM
public static final String DIRECTION_START
public static final String DIRECTION_END
public static final String STYLE_PINNED
public static final String STYLE_OVERLAID
public static final String LAYOUT_PRIORITY_VERTICAL
public static final String LAYOUT_PRIORITY_HORIZONTAL
public static final String ANIMATION_STYLE_SLIDE_IN
public AdfmfSlidingWindowOptions()
Use these options configure how a sliding window will be shown
The options object returned do not have any initial or default values configured. Any default values for options not specified are determined by the actual show implementation as outlined for each property in this document.
public void setDirection(String direction)
The window will be anchored to the direction specified. The allowed values may be one of
If not specified the default value AdfmfSlidingWindowOptions.DIRECTION_START will be used.
direction
- The direction to which the sliding window will be anchoredpublic String getDirection()
public void setDuration(long duration)
duration
- public long getDuration()
public void setSize(String size)
Use the size value to customize the amount of screen space the sliding window will utilize. The size is always computed in the same axis as the direction value specified. If the direction is specified as DIRECTION_TOP then the size value will specify the height of the sliding window. The width of the window would then be the entire available width in the other axis.
Size can be specified as positive integer value or a precentage. A positive integer, for example "100", specifies the dimension in pixels. If the value specified is a percentage, for example "50%", the actual width will be calculated as a percentage of the total screen size at the time the window is displayed.
Percentages must be specified as whole numbers with a minimum of 1 and a maximum of 100.
The default size, if not specified, is 100%
size
- the size of the sliding window in pixels or as a percentagepublic String getSize()
public void setStyle(String style)
Sliding windows can be created using on of the following styles
The style used for a sliding window cannot be changed on subsequent calls to show
If not specified the default style utilized is STYLE_OVERLAID
style
- The style to usepublic String getStyle()
public void setLayoutPriority(String layoutPriority)
Adjacement pinned windows can potentially overlap in the corners. Layout priority will determine which windows will use the space where windows would overlap. The other windows will be shrunk accordingly.
Layout priority applies only to pinned windows. Overlaid windows may potentially overlap. Layout priority is set with the first call to show and may not be changed once established.
The default priority if not specified is LAYOUT_PRIORITY_VERTICAL.
layoutPriority
- the layout priority to usepublic String getLayoutPriority()
public void setAnimationStyle(String animationStyle)
Only one style of animation is currently supported
animationStyle
- the animation style to usepublic String getAnimationStyle()
public String toString()
toString
in class Object