PopoverOptions

public class PopoverOptions

Options for creating a popover.

Summary

Public fields
`int`	`@AltitudeMode altitudeMode`
`@Nullable Point`	`anchorOffset`
`boolean`	`autoCloseEnabled`
`boolean`	`autoPanEnabled`
`@Nullable View`	`content`
`PopoverStyle`	`popoverStyle`
`Anchorable`	`positionAnchor`

Public constructors
`PopoverOptions()` Default constructor for PopoverOptions.

Public methods
`int`	`@AltitudeMode getAltitudeMode()` The altitude mode of the popover.
`@Nullable Point`	`getAnchorOffset()` The offset of the anchor object that the popover is anchored to.
`boolean`	`getAutoCloseEnabled()` Whether the popover is auto-closed when the anchor is occluded.
`boolean`	`getAutoPanEnabled()` Whether the popover is auto-pan when the anchor is occluded.
`@Nullable View`	`getContent()` The View object that is used as the content of the popover.
`PopoverStyle`	`getPopoverStyle()` The style of the popover.
`Anchorable`	`getPositionAnchor()` The anchor object that the popover is anchored to.
`PopoverOptions`	`setAltitudeMode(@AltitudeMode int altitudeMode)` The altitude mode of the popover.
`PopoverOptions`	`setAnchorOffset(@Nullable Point anchorOffset)` Sets the offset of the anchor object that the popover is anchored to.
`PopoverOptions`	`setAutoCloseEnabled(boolean autoCloseEnabled)` Sets whether the popover is auto-closed when the anchor is occluded.
`PopoverOptions`	`setAutoPanEnabled(boolean autoPanEnabled)` Sets whether the popover is auto-pan when the anchor is occluded.
`PopoverOptions`	`setContent(@Nullable View content)` Sets the View object that is used as the content of the popover.
`PopoverOptions`	`setPopoverStyle(PopoverStyle popoverStyle)` The style of the popover.
`PopoverOptions`	`setPositionAnchor(Anchorable positionAnchor)` Sets the anchor object that the popover is anchored to.

Extension functions
`final void`	`ValidatorsKt.validate(@NonNull PopoverOptions receiver)` Validates a specified `PopoverOptions` object.

Public fields

altitudeMode

@AltitudeMode
public int altitudeMode

anchorOffset

public @Nullable Point anchorOffset

autoCloseEnabled

public boolean autoCloseEnabled

autoPanEnabled

public boolean autoPanEnabled

content

public @Nullable View content

popoverStyle

public PopoverStyle popoverStyle

positionAnchor

public Anchorable positionAnchor

Public constructors

PopoverOptions

public PopoverOptions()

Default constructor for PopoverOptions.

Public methods

getAltitudeMode

@AltitudeMode
public int getAltitudeMode()

The altitude mode of the popover.

getAnchorOffset

public @Nullable Point getAnchorOffset()

The offset of the anchor object that the popover is anchored to.

getAutoCloseEnabled

public boolean getAutoCloseEnabled()

Whether the popover is auto-closed when the anchor is occluded.

getAutoPanEnabled

public boolean getAutoPanEnabled()

Whether the popover is auto-pan when the anchor is occluded.

getContent

public @Nullable View getContent()

The View object that is used as the content of the popover.

getPopoverStyle

public PopoverStyle getPopoverStyle()

The style of the popover.

getPositionAnchor

public Anchorable getPositionAnchor()

The anchor object that the popover is anchored to.

setAltitudeMode

public PopoverOptions setAltitudeMode(@AltitudeMode int altitudeMode)

The altitude mode of the popover.

setAnchorOffset

public PopoverOptions setAnchorOffset(@Nullable Point anchorOffset)

Sets the offset of the anchor object that the popover is anchored to.

setAutoCloseEnabled

public PopoverOptions setAutoCloseEnabled(boolean autoCloseEnabled)

Sets whether the popover is auto-closed when the anchor is occluded.

setAutoPanEnabled

public PopoverOptions setAutoPanEnabled(boolean autoPanEnabled)

Sets whether the popover is auto-pan when the anchor is occluded.

setContent

public PopoverOptions setContent(@Nullable View content)

Sets the View object that is used as the content of the popover.

setPopoverStyle

public PopoverOptions setPopoverStyle(PopoverStyle popoverStyle)

The style of the popover.

setPositionAnchor

public PopoverOptions setPositionAnchor(Anchorable positionAnchor)

Sets the anchor object that the popover is anchored to.

Extension functions

ValidatorsKt.validate

public final void ValidatorsKt.validate(@NonNull PopoverOptions receiver)

Validates a specified PopoverOptions object.

Throws
`kotlin.IllegalArgumentException`	if the `PopoverOptions` is not valid.