com.alee.managers.icon.data

Class AbstractIconSource<I extends Icon>

java.lang.Object

com.alee.managers.icon.data.AbstractIconSource<I>

Type Parameters:

I - Icon type

All Implemented Interfaces:

Identifiable, Mergeable, Overwriting, IconSource<I>, Serializable, Cloneable

Direct Known Subclasses:

ImageIconSource, SvgIconSource

public abstract class AbstractIconSource<I extends Icon>
extends Object
implements IconSource<I>

Abstract IconSource implementation containing basic Icon information. Implements Overwriting instead of Mergeable to avoid merging any IconSources ever.

Author:

Mikle Garin

See Also:

How to use IconManager, IconManager, ImageIconSource, SvgIconSource, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected List<IconAdjustment<I>>	adjustments IconAdjustment to be applied on loaded Icon for the final result.
protected String	id Unique Icon identifier.
protected Resource	resource Resource containing Icon.

Fields inherited from interface com.alee.managers.icon.data.IconSource

ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
AbstractIconSource(String id, Resource resource) Constructs new AbstractIconSource.
AbstractIconSource(String id, Resource resource, IconAdjustment<I>... adjustments) Constructs new AbstractIconSource.
AbstractIconSource(String id, Resource resource, List<IconAdjustment<I>> adjustments) Constructs new AbstractIconSource.

Method Summary

Modifier and Type	Method and Description
String	getId()
Resource	getResource() Returns Resource containing Icon.
boolean	isOverwrite()
I	loadIcon() Returns Icon described by this IconSource.
protected abstract I	loadIcon(Resource resource) Returns raw Icon loaded from Resource.

Methods inherited from class java.lang.Object

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

Field Detail

id

@NotNull
 @XStreamAsAttribute
protected final String id

Unique Icon identifier. Used to access icon through IconManager.

resource

@NotNull
 @XStreamAsAttribute
protected final Resource resource

Resource containing Icon.

adjustments

@Nullable
protected List<IconAdjustment<I extends Icon>> adjustments

IconAdjustment to be applied on loaded Icon for the final result.

Constructor Detail

AbstractIconSource

public AbstractIconSource(@NotNull
                          String id,
                          @NotNull
                          Resource resource)

Constructs new AbstractIconSource.

Parameters:

id - unique Icon identifier

resource - Resource containing Icon

AbstractIconSource

public AbstractIconSource(@NotNull
                          String id,
                          @NotNull
                          Resource resource,
                          @NotNull
                          IconAdjustment<I>... adjustments)

Constructs new AbstractIconSource.

Parameters:

id - unique Icon identifier

resource - Resource containing Icon

adjustments - IconAdjustments

AbstractIconSource

public AbstractIconSource(@NotNull
                          String id,
                          @NotNull
                          Resource resource,
                          @Nullable
                          List<IconAdjustment<I>> adjustments)

Constructs new AbstractIconSource.

Parameters:

id - unique Icon identifier

resource - Resource containing Icon

adjustments - List of IconAdjustments

Method Detail

getId

@NotNull
public String getId()

Specified by:

getId in interface Identifiable

isOverwrite

public boolean isOverwrite()

Specified by:

isOverwrite in interface Overwriting

getResource

@NotNull
public Resource getResource()

Description copied from interface: IconSource

Returns Resource containing Icon.

Specified by:

getResource in interface IconSource<I extends Icon>

Returns:

Resource containing Icon

loadIcon

@NotNull
public I loadIcon()

Description copied from interface: IconSource

Returns Icon described by this IconSource.

Specified by:

loadIcon in interface IconSource<I extends Icon>

Returns:

Icon described by this IconSource

loadIcon

@NotNull
protected abstract I loadIcon(@NotNull
                                       Resource resource)

Returns raw Icon loaded from Resource.

Parameters:

resource - Resource containing Icon

Returns:

raw Icon loaded from Resource