Class FileChooser

java.lang.Object

com.badlogic.gdx.scenes.scene2d.Actor

com.badlogic.gdx.scenes.scene2d.Group

com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup

com.badlogic.gdx.scenes.scene2d.ui.Table

gaiasky.util.scene2d.OwnWindow

gaiasky.util.scene2d.CollapsibleWindow

gaiasky.gui.window.GenericDialog

gaiasky.util.scene2d.FileChooser

All Implemented Interfaces:

com.badlogic.gdx.scenes.scene2d.utils.Cullable, com.badlogic.gdx.scenes.scene2d.utils.Layout, IScreen

public class FileChooser
extends GenericDialog

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FileChooser.FileChooserTarget	The type of files that can be chosen with this file chooser
static class	FileChooser.FileListItem
static interface	FileChooser.PathnameFilter
static interface	FileChooser.ResultListener

Nested classes/interfaces inherited from class com.badlogic.gdx.scenes.scene2d.ui.Table

com.badlogic.gdx.scenes.scene2d.ui.Table.Debug, com.badlogic.gdx.scenes.scene2d.ui.Table.DebugRect

Field Summary

Fields

Modifier and Type	Field	Description
protected String	result
protected FileChooser.ResultListener	resultListener
protected com.badlogic.gdx.scenes.scene2d.EventListener	selectionListener

Fields inherited from class GenericDialog

acceptButton, acceptListener, backupGamepadListeners, backupMouseKbdListeners, bottom, buttonGroup, cancelButton, cancelListener, closeListener, content, defaultGamepadListener, defaultMouseKbdListener, enterExit, escExit, gamepadListener, ignoreTouchDown, keysListener, lastPosX, lastPosY, me, modal, mouseKbdListener, scrolls, selectedTab, skin, stage, tabButtons, tabContents, tabStack

Modifier and Type	Field	Description
protected com.badlogic.gdx.scenes.scene2d.ui.TextButton	acceptButton
protected Runnable	acceptListener
protected Set<com.badlogic.gdx.controllers.ControllerListener>	backupGamepadListeners
protected Set<AbstractMouseKbdListener>	backupMouseKbdListeners
protected com.badlogic.gdx.scenes.scene2d.ui.Table	bottom
protected com.badlogic.gdx.scenes.scene2d.ui.HorizontalGroup	buttonGroup
protected com.badlogic.gdx.scenes.scene2d.ui.TextButton	cancelButton
protected Runnable	cancelListener
protected Runnable	closeListener
protected com.badlogic.gdx.scenes.scene2d.ui.Table	content
protected boolean	defaultGamepadListener
protected boolean	defaultMouseKbdListener
protected boolean	enterExit
protected boolean	escExit
protected AbstractGamepadListener	gamepadListener
protected com.badlogic.gdx.scenes.scene2d.InputListener	ignoreTouchDown
protected boolean	keysListener
protected float	lastPosX
protected float	lastPosY
protected GenericDialog	me
protected boolean	modal
protected AbstractMouseKbdListener	mouseKbdListener
protected com.badlogic.gdx.utils.Array<OwnScrollPane>	scrolls
protected int	selectedTab	Currently selected tab
protected final com.badlogic.gdx.scenes.scene2d.ui.Skin	skin
protected final com.badlogic.gdx.scenes.scene2d.Stage	stage
protected com.badlogic.gdx.utils.Array<com.badlogic.gdx.scenes.scene2d.ui.TextButton>	tabButtons	If this dialog has tabs, this list holds them.
protected com.badlogic.gdx.utils.Array<com.badlogic.gdx.scenes.scene2d.Group>	tabContents	Actual actor for each tab.
protected com.badlogic.gdx.scenes.scene2d.ui.Stack	tabStack	Tab contents stack.

Fields inherited from class CollapsibleWindow

collapseSpeed

Modifier and Type	Field	Description
protected float	collapseSpeed	Collapse speed in pixels per second.

Fields inherited from class OwnWindow

dragging, edge, pad10, pad18, pad20, pad34

Modifier and Type	Field	Description
protected boolean	dragging
protected int	edge
protected static final float	pad10
protected static final float	pad18
protected static final float	pad20
protected static final float	pad34

Fields inherited from class com.badlogic.gdx.scenes.scene2d.ui.Table

backgroundBottom, backgroundLeft, backgroundRight, backgroundTop, debugActorColor, debugCellColor, debugTableColor

Fields inherited from class com.badlogic.gdx.scenes.scene2d.Actor

POOLS

Constructor Summary

Constructors

Constructor	Description
FileChooser(String title, com.badlogic.gdx.scenes.scene2d.ui.Skin skin, com.badlogic.gdx.scenes.scene2d.Stage stage, Path baseDir, FileChooser.FileChooserTarget target)
FileChooser(String title, com.badlogic.gdx.scenes.scene2d.ui.Skin skin, com.badlogic.gdx.scenes.scene2d.Stage stage, Path baseDir, FileChooser.FileChooserTarget target, com.badlogic.gdx.scenes.scene2d.EventListener selectionListener)
FileChooser(String title, com.badlogic.gdx.scenes.scene2d.ui.Skin skin, com.badlogic.gdx.scenes.scene2d.Stage stage, Path baseDir, FileChooser.FileChooserTarget target, com.badlogic.gdx.scenes.scene2d.EventListener selectionListener, boolean directoryBrowsingEnabled)

Method Summary

Modifier and Type	Method	Description
boolean	accept()	The accept function, if any.
void	build()	Build the content here.
void	cancel()	The cancel function, if any.
void	dispose()
Path	getResult()
void	setAcceptedFiles(String accepted)
FileChooser	setFileFilter(FileChooser.PathnameFilter f)	Sets the file filter.
FileChooser	setFileNameEnabled(boolean fileNameEnabled)
FileChooser	setFilter(DirectoryStream.Filter<Path> filter)	Overrides the default filter.
void	setResultListener(FileChooser.ResultListener result)
void	setShowHidden(boolean showHidden)
void	setShowHiddenConsumer(Consumer<Boolean> r)	Sets a consumer that is run when the property 'showHidden' changes, whit its value.

Methods inherited from class GenericDialog

acceptButton, act, addSeparator, addSeparator, addTabContent, buildSuper, cancelButton, closeAccept, closeCancel, enableComponents, focusFirstInputWidget, getBottom, getBottomGroup, getButtonsGroup, getContent, getCurrentContentContainer, getStage, getTabButtons, hasAcceptRunnable, hasCancelRunnable, hasCloseRunnable, hide, hide, recalculateButtonSize, setAcceptButtonColor, setAcceptButtonStyle, setAcceptListener, setAcceptText, setCancelButtonColors, setCancelButtonStyle, setCancelListener, setCancelText, setCloseListener, setKeyboardFocus, setModal, setUpTabListeners, show, show, show, showDialogHook, tabLeft, tabRight, touch

Modifier and Type	Method	Description
com.badlogic.gdx.scenes.scene2d.ui.Button	acceptButton()
void	act(float delta)
void	addSeparator()	Adds a horizontal separator to the main content table with the default colspan of 1.
void	addSeparator(int colSpan)	Adds a horizontal separator to the main content table with the given colspan.
protected void	addTabContent(com.badlogic.gdx.scenes.scene2d.Group tabContent)	Add tab contents to the list of tabs.
void	buildSuper()
com.badlogic.gdx.scenes.scene2d.ui.Button	cancelButton()
boolean	closeAccept()	Closes the window with the accept action.
boolean	closeCancel()	Closes the window with the cancel action.
protected void	enableComponents(boolean enabled, com.badlogic.gdx.scenes.scene2d.utils.Disableable... components)	Sets the enabled property on the given components.
void	focusFirstInputWidget()
com.badlogic.gdx.scenes.scene2d.ui.Table	getBottom()
com.badlogic.gdx.scenes.scene2d.Group	getBottomGroup()
com.badlogic.gdx.scenes.scene2d.Group	getButtonsGroup()
com.badlogic.gdx.scenes.scene2d.ui.Table	getContent()
com.badlogic.gdx.scenes.scene2d.Group	getCurrentContentContainer()
com.badlogic.gdx.scenes.scene2d.Stage	getStage()
com.badlogic.gdx.utils.Array<com.badlogic.gdx.scenes.scene2d.ui.TextButton>	getTabButtons()
boolean	hasAcceptRunnable()
boolean	hasCancelRunnable()
boolean	hasCloseRunnable()
void	hide()	Hides the dialog.
void	hide(com.badlogic.gdx.scenes.scene2d.Action action)	Hides the dialog with the given action and then removes it from the stage.
protected void	recalculateButtonSize()
void	setAcceptButtonColor(com.badlogic.gdx.graphics.Color col)
void	setAcceptButtonStyle(String style)
void	setAcceptListener(Runnable r)	Sets a listener that runs when accept is clicked.
void	setAcceptText(String acceptText)
void	setCancelButtonColors(com.badlogic.gdx.graphics.Color textColor, com.badlogic.gdx.graphics.Color buttonColor)
void	setCancelButtonStyle(String style)
void	setCancelListener(Runnable r)	Sets a listener that runs when cancel is clicked.
void	setCancelText(String cancelText)
void	setCloseListener(Runnable r)	Sets a listener that runs when the dialog is closed.
void	setKeyboardFocus()	Sets the keyboard focus, override in case you want to set the focus to a specific item.
void	setModal(boolean modal)
protected void	setUpTabListeners()	Prepares the tab button listeners that make tab buttons actually change the content.
GenericDialog	show(com.badlogic.gdx.scenes.scene2d.Stage stage)	Packs the dialog and adds it to the stage, centered with default fadeIn action.
GenericDialog	show(com.badlogic.gdx.scenes.scene2d.Stage stage, float x, float y)	Packs the dialog and adds it to the stage at the specified position.
GenericDialog	show(com.badlogic.gdx.scenes.scene2d.Stage stage, com.badlogic.gdx.scenes.scene2d.Action action)	Packs the dialog and adds it to the stage with custom action which can be null for instant show.
protected void	showDialogHook(com.badlogic.gdx.scenes.scene2d.Stage stage)
boolean	tabLeft()
boolean	tabRight()
void	touch()	Override this method to update the contents of this dialog before displaying it.

Methods inherited from class CollapsibleWindow

collapse, collapseInstant, drawBackground, expand, expandInstant, getHeight, getMaxHeight, getMaxWidth, getPrefHeight, getPrefWidth, getWidth, isCollapsed, isCollapsible, pack, setCollapsible, setResizable, toggleCollapsed

Modifier and Type	Method	Description
void	collapse()
void	collapseInstant()
protected void	drawBackground(com.badlogic.gdx.graphics.g2d.Batch batch, float parentAlpha, float x, float y)
void	expand()
void	expandInstant()
float	getHeight()
float	getMaxHeight()
float	getMaxWidth()
float	getPrefHeight()
float	getPrefWidth()
float	getWidth()
boolean	isCollapsed()
boolean	isCollapsible()
void	pack()
void	setCollapsible(boolean collapsible)
void	setResizable(boolean w, boolean h)
void	toggleCollapsed()

Methods inherited from class OwnWindow

draw, drawStageBackground, getStyle, getTitleLabel, getTitleTable, hg, hit, isModal, isResizable, keepWithinStage, setMovable, setResizable, setStyle

Modifier and Type	Method	Description
void	draw(com.badlogic.gdx.graphics.g2d.Batch batch, float parentAlpha)
protected void	drawStageBackground(com.badlogic.gdx.graphics.g2d.Batch batch, float parentAlpha, float x, float y, float width, float height)
com.badlogic.gdx.scenes.scene2d.ui.Window.WindowStyle	getStyle()	Returns the window's style.
com.badlogic.gdx.scenes.scene2d.ui.Label	getTitleLabel()
com.badlogic.gdx.scenes.scene2d.ui.Table	getTitleTable()
protected com.badlogic.gdx.scenes.scene2d.ui.HorizontalGroup	hg(com.badlogic.gdx.scenes.scene2d.Actor... actors)
com.badlogic.gdx.scenes.scene2d.Actor	hit(float x, float y, boolean touchable)
boolean	isModal()
boolean	isResizable()
void	keepWithinStage()
void	setMovable(boolean isMovable)
void	setResizable(boolean isResizable)
void	setStyle(com.badlogic.gdx.scenes.scene2d.ui.Window.WindowStyle style)

Methods inherited from class com.badlogic.gdx.scenes.scene2d.ui.Table

add, add, add, add, add, add, add, align, background, background, bottom, center, clearChildren, clip, clip, columnDefaults, debug, debug, debugActor, debugAll, debugCell, debugTable, defaults, drawDebug, drawDebugBounds, getAlign, getBackground, getCell, getCells, getClip, getColumnMinWidth, getColumnPrefWidth, getColumns, getColumnWidth, getMinHeight, getMinWidth, getPadBottom, getPadBottomValue, getPadLeft, getPadLeftValue, getPadRight, getPadRightValue, getPadTop, getPadTopValue, getPadX, getPadY, getRow, getRowHeight, getRowMinHeight, getRowPrefHeight, getRows, getSkin, getTableDebug, invalidate, layout, left, pad, pad, pad, pad, padBottom, padBottom, padLeft, padLeft, padRight, padRight, padTop, padTop, removeActor, removeActor, removeActorAt, reset, right, row, setBackground, setBackground, setClip, setDebug, setRound, setSkin, stack, top

Methods inherited from class com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup

childrenChanged, invalidateHierarchy, needsLayout, setFillParent, setLayoutEnabled, sizeChanged, validate

Methods inherited from class com.badlogic.gdx.scenes.scene2d.Group

addActor, addActorAfter, addActorAt, addActorBefore, applyTransform, applyTransform, clear, clear, clearChildren, computeTransform, drawChildren, drawDebugChildren, findActor, getChild, getChildren, getCullingArea, hasChildren, isTransform, localToDescendantCoordinates, resetTransform, resetTransform, setCullingArea, setDebug, setStage, setTransform, swapActor, swapActor, toString

Methods inherited from class com.badlogic.gdx.scenes.scene2d.Actor

addAction, addCaptureListener, addListener, ancestorsVisible, ascendantsVisible, clearActions, clearListeners, clipBegin, clipBegin, clipEnd, fire, firstAscendant, getActions, getCaptureListeners, getColor, getDebug, getListeners, getName, getOriginX, getOriginY, getParent, getRight, getRotation, getScaleX, getScaleY, getTop, getTouchable, getUserObject, getX, getX, getY, getY, getZIndex, hasActions, hasKeyboardFocus, hasParent, hasScrollFocus, isAscendantOf, isDescendantOf, isTouchable, isTouchFocusListener, isTouchFocusTarget, isVisible, localToActorCoordinates, localToAscendantCoordinates, localToParentCoordinates, localToScreenCoordinates, localToStageCoordinates, moveBy, notify, parentToLocalCoordinates, positionChanged, remove, removeAction, removeCaptureListener, removeListener, rotateBy, rotationChanged, scaleBy, scaleBy, scaleChanged, screenToLocalCoordinates, setBounds, setColor, setColor, setHeight, setName, setOrigin, setOrigin, setOriginX, setOriginY, setParent, setPosition, setPosition, setRotation, setScale, setScale, setScaleX, setScaleY, setSize, setTouchable, setUserObject, setVisible, setWidth, setX, setX, setY, setY, setZIndex, sizeBy, sizeBy, stageToLocalCoordinates, toBack, toFront

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

result

protected String result

resultListener

protected FileChooser.ResultListener resultListener

selectionListener

protected com.badlogic.gdx.scenes.scene2d.EventListener selectionListener

Constructor Details

FileChooser

public FileChooser(String title,
 com.badlogic.gdx.scenes.scene2d.ui.Skin skin,
 com.badlogic.gdx.scenes.scene2d.Stage stage,
 Path baseDir,
 FileChooser.FileChooserTarget target)

FileChooser

public FileChooser(String title,
 com.badlogic.gdx.scenes.scene2d.ui.Skin skin,
 com.badlogic.gdx.scenes.scene2d.Stage stage,
 Path baseDir,
 FileChooser.FileChooserTarget target,
 com.badlogic.gdx.scenes.scene2d.EventListener selectionListener)

FileChooser

public FileChooser(String title,
 com.badlogic.gdx.scenes.scene2d.ui.Skin skin,
 com.badlogic.gdx.scenes.scene2d.Stage stage,
 Path baseDir,
 FileChooser.FileChooserTarget target,
 com.badlogic.gdx.scenes.scene2d.EventListener selectionListener,
 boolean directoryBrowsingEnabled)

Method Details

build

public void build()

Description copied from class: GenericDialog

Build the content here.

Specified by:

build in class GenericDialog

setShowHidden

public void setShowHidden(boolean showHidden)

setShowHiddenConsumer

public void setShowHiddenConsumer(Consumer<Boolean> r)

Sets a consumer that is run when the property 'showHidden' changes, whit its value.

Parameters:

r - The consumer

setAcceptedFiles

public void setAcceptedFiles(String accepted)

getResult

public Path getResult()

setFilter

public FileChooser setFilter(DirectoryStream.Filter<Path> filter)

Overrides the default filter. If you use this, the attributes directoryBrowsingEnabled and fileBrowsingEnabled won't have effect anymore. To set additional filters on the path names, use setFileFilter(PathnameFilter) instead.

Parameters:

filter - The new file filter

Returns:

This file chooser

setFileFilter

public FileChooser setFileFilter(FileChooser.PathnameFilter f)

Sets the file filter. This filter will be used to check whether file path names are accepted or not. It works in conjunction with fileBrowsingEnabled, so you do not need to check whether the pathname is a file.

Parameters:

f - The file filter.

Returns:

This file chooser.

setFileNameEnabled

public FileChooser setFileNameEnabled(boolean fileNameEnabled)

setResultListener

public void setResultListener(FileChooser.ResultListener result)

accept

public boolean accept()

Description copied from class: GenericDialog

The accept function, if any.

Specified by:

accept in class GenericDialog

Returns:

True if the dialog must close after the call, false otherwise.

cancel

public void cancel()

Description copied from class: GenericDialog

The cancel function, if any.

Specified by:

cancel in class GenericDialog

dispose

public void dispose()

Specified by:

dispose in class GenericDialog