Class MetadataSummary

Object

Widget

MetadataSummary

All Implemented Interfaces:

Localized

@DefaultProperty("metadata")
public class MetadataSummary
extends Widget

A panel showing a summary of metadata.

Since:

1.1

Field Summary

Fields

Modifier and Type	Field	Description
final Object­Property<Metadata>	metadata­Property	The metadata shown in this pane.

Constructor Summary

Constructors

Constructor	Description
Metadata­Summary()	Creates an initially empty metadata overview.

Method Summary

Modifier and Type	Method	Description
final Locale	get­Locale()	Returns the locale used by this widget for controls and messages.
final Metadata	get­Metadata()	Returns the metadata currently shown, or null if none.
Region	get­View()	Returns the encapsulated JavaFX component to add in a scene graph for making the metadata visible.
final void	set­Error(Throwable exception)	Clears the metadata panel and write instead an exception report.
void	set­Metadata(Resource resource)	Fetches the metadata in a background thread and delegates to set­Metadata(Metadata) when ready.
final void	set­Metadata(Metadata metadata)	Sets the content of this pane to the given metadata.

Methods inherited from class Object

clone, equals, finalize, get­Class, hash­Code, notify, notify­All, to­String, wait, wait, wait

Field Details

metadataProperty

public final ObjectProperty<Metadata> metadataProperty

The metadata shown in this pane.

See Also:

• get­Metadata()
• set­Metadata(Metadata)
• set­Metadata(Resource)

Constructor Details

MetadataSummary

public MetadataSummary()

Creates an initially empty metadata overview.

Method Details

getView

public Region getView()

Returns the encapsulated JavaFX component to add in a scene graph for making the metadata visible. The Region subclass is implementation dependent and may change in any future SIS version.

Specified by:

get­View in class Widget

Returns:

the JavaFX component to insert in a scene graph.

setMetadata

public void setMetadata(Resource resource)

Fetches the metadata in a background thread and delegates to set­Metadata(Metadata) when ready.

Parameters:

resource - the resource for which to show metadata, or null.

setMetadata

public final void setMetadata(Metadata metadata)

Sets the content of this pane to the given metadata. This is a convenience method for setting metadata­Property value.

Parameters:

metadata - the metadata to show, or null.

See Also:

• metadata­Property
• set­Metadata(Resource)

getMetadata

public final Metadata getMetadata()

Returns the metadata currently shown, or null if none. This is a convenience method for fetching metadata­Property value.

Returns:

the metadata currently shown, or null if none.

See Also:

• metadata­Property
• set­Metadata(Metadata)

setError

public final void setError(Throwable exception)

Clears the metadata panel and write instead an exception report.

Parameters:

exception - the exception that occurred.

getLocale

public final Locale getLocale()

Returns the locale used by this widget for controls and messages.

Specified by:

get­Locale in interface Localized

Overrides:

get­Locale in class Widget

Returns:

the locale for controls in this widget.