ro.sync.exml.workspace.api.standalone
Interface InputURLChooser

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public interface InputURLChooser

Interface through which the CMS can set a custom URL to any Input URL Panel from Oxygen.

Since:

12.1

Field Summary

static int	OPEN_RESOURCE Open resource chooser
static int	OPEN_RESOURCE_DIRECTORY Resource directory chooser
static int	SAVE_RESOURCE Save resource chooser

Method Summary

int	getBrowseMode() Get the mode for which the Input URL chooser will be used (for opening or for saving resources).
ResourceFilter[]	getResourceFilters() Get the list of resource filters used for the local file chooser.
void	urlChosen(java.net.URL selectedURL) Set in the Input URL panel combo box the new URL which was chosen from the CMS handler.

Field Detail

SAVE_RESOURCE

static final int SAVE_RESOURCE

Save resource chooser

See Also:

Constant Field Values

OPEN_RESOURCE

static final int OPEN_RESOURCE

Open resource chooser

See Also:

Constant Field Values

OPEN_RESOURCE_DIRECTORY

static final int OPEN_RESOURCE_DIRECTORY

Resource directory chooser

See Also:

Constant Field Values

Method Detail

urlChosen

void urlChosen(java.net.URL selectedURL)

Set in the Input URL panel combo box the new URL which was chosen from the CMS handler. When the customizer is used in places where a combo box for the URL is not present (like in the DITA Maps Manager view) this method performs the operation on the given URL.

Parameters:

selectedURL - The URL which was probably selected by the user in a custom CMS chooser.

getBrowseMode

int getBrowseMode()

Get the mode for which the Input URL chooser will be used (for opening or for saving resources).

Returns:

One of the constants in this class: OPEN_RESOURCE, SAVE_RESOURCE or OPEN_RESOURCE_DIRECTORY

Since:

12.2

getResourceFilters

ResourceFilter[] getResourceFilters()

Get the list of resource filters used for the local file chooser. This method is useful to decide the type of files the chooser dialog wants to browse. For example if the dialog wants to select an image to add to the Author page then the resource filters will contain image extensions.

Returns:

The list of resource filters used for the local file chooser. Can be null.

Since:

13.1

*********************************
EXPERIMENTAL - Subject to change
********************************

Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.