javax.swing.text.StyleContext — clojure-interop/javax.swing 1.0.5

A pool of styles and their associated resources. This class determines the lifetime of a group of resources by being a container that holds caches for various resources such as font and color that get reused by the various style definitions. This can be shared by multiple documents if desired to maximize the sharing of related resources.

This class also provides efficient support for small sets of attributes and compresses them by sharing across uses and taking advantage of their immutable nature. Since many styles are replicated, the potential for sharing is significant, and copies can be extremely cheap. Larger sets reduce the possibility of sharing, and therefore revert automatically to a less space-efficient implementation.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans™ has been added to the java.beans package. Please see XMLEncoder.

*-default-style clj

Static Constant.

The name given to the default logical style attached to paragraphs.

type: java.lang.String

*get-default-style-context clj

(*get-default-style-context)

Returns default AttributeContext shared by all documents that don't bother to define/supply their own context.

returns: the context - javax.swing.text.StyleContext

*get-static-attribute clj

(*get-static-attribute key)

Returns the object previously registered with registerStaticAttributeKey.

key - java.lang.Object

returns: java.lang.Object

*get-static-attribute-key clj

(*get-static-attribute-key key)

Returns the String that key will be registered with

key - java.lang.Object

returns: java.lang.Object

*read-attribute-set clj

(*read-attribute-set in a)

Reads a set of attributes from the given object input stream that have been previously written out with writeAttributeSet. This will try to restore keys that were static objects to the static objects in the current virtual machine considering only those keys that have been registered with the registerStaticAttributeKey method. The attributes retrieved from the stream will be placed into the given mutable set.

in - the object stream to read the attribute data from. - java.io.ObjectInputStream a - the attribute set to place the attribute definitions in. - javax.swing.text.MutableAttributeSet

throws: java.lang.ClassNotFoundException - passed upward if encountered when reading the object stream.

*register-static-attribute-key clj

(*register-static-attribute-key key)

Registers an object as a static object that is being used as a key in attribute sets. This allows the key to be treated specially for serialization.

For operation under a 1.1 virtual machine, this uses the value returned by toString concatenated to the classname. The value returned by toString should not have the class reference in it (ie it should be reimplemented from the definition in Object) in order to be the same when recomputed later.

key - the non-null object key - java.lang.Object

*write-attribute-set clj

(*write-attribute-set out a)

Writes a set of attributes to the given object stream for the purpose of serialization. This will take special care to deal with static attribute keys that have been registered wit the registerStaticAttributeKey method. Any attribute key not registered as a static key will be serialized directly. All values are expected to be serializable.

out - the output stream - java.io.ObjectOutputStream a - the attribute set - javax.swing.text.AttributeSet

throws: java.io.IOException - on any I/O error

->style-context clj

(->style-context)

Constructor.

Creates a new StyleContext object.

add-attribute clj

(add-attribute this old name value)

Adds an attribute to the given set, and returns the new representative set.

This method is thread safe, although most Swing methods are not. Please see Concurrency in Swing for more information.

old - the old attribute set - javax.swing.text.AttributeSet name - the non-null attribute name - java.lang.Object value - the attribute value - java.lang.Object

returns: the updated attribute set - javax.swing.text.AttributeSet

add-attributes clj

(add-attributes this old attr)

Adds a set of attributes to the element.

This method is thread safe, although most Swing methods are not. Please see Concurrency in Swing for more information.

old - the old attribute set - javax.swing.text.AttributeSet attr - the attributes to add - javax.swing.text.AttributeSet

returns: the updated attribute set - javax.swing.text.AttributeSet

add-change-listener clj

(add-change-listener this l)

Adds a listener to track when styles are added or removed.

l - the change listener - javax.swing.event.ChangeListener

add-style clj

(add-style this nm parent)

Adds a new style into the style hierarchy. Style attributes resolve from bottom up so an attribute specified in a child will override an attribute specified in the parent.

nm - the name of the style (must be unique within the collection of named styles in the document). The name may be null if the style is unnamed, but the caller is responsible for managing the reference returned as an unnamed style can't be fetched by name. An unnamed style may be useful for things like character attribute overrides such as found in a style run. - java.lang.String parent - the parent style. This may be null if unspecified attributes need not be resolved in some other style. - javax.swing.text.Style

returns: the created style - javax.swing.text.Style

get-background clj

(get-background this attr)

Takes a set of attributes and turn it into a background color specification. This might be used to specify things like brighter, more hue, etc. By default it simply returns the value specified by the StyleConstants.Background attribute.

attr - the set of attributes - javax.swing.text.AttributeSet

returns: the color - java.awt.Color

get-change-listeners clj

(get-change-listeners this)

Returns an array of all the ChangeListeners added to this StyleContext with addChangeListener().

returns: all of the ChangeListeners added or an empty array if no listeners have been added - javax.swing.event.ChangeListener[]

get-empty-set clj

(get-empty-set this)

Fetches an empty AttributeSet.

returns: the set - javax.swing.text.AttributeSet

get-font clj

(get-font this attr)

(get-font this family style size)

Gets a new font. This returns a Font from a cache if a cached font exists. If not, a Font is added to the cache. This is basically a low-level cache for 1.1 font features.

family - the font family (such as "Monospaced") - java.lang.String style - the style of the font (such as Font.PLAIN) - int size - the point size >= 1 - int

returns: the new font - java.awt.Font

get-font-metrics clj

(get-font-metrics this f)

Returns font metrics for a font.

f - the font - java.awt.Font

returns: the metrics - java.awt.FontMetrics

get-foreground clj

(get-foreground this attr)

Takes a set of attributes and turn it into a foreground color specification. This might be used to specify things like brighter, more hue, etc. By default it simply returns the value specified by the StyleConstants.Foreground attribute.

attr - the set of attributes - javax.swing.text.AttributeSet

returns: the color - java.awt.Color

get-style clj

(get-style this nm)

Fetches a named style previously added to the document

nm - the name of the style - java.lang.String

returns: the style - javax.swing.text.Style

get-style-names clj

(get-style-names this)

Fetches the names of the styles defined.

returns: the list of names as an enumeration - java.util.Enumeration<?>

read-attributes clj

(read-attributes this in a)

Context-specific handling of reading in attributes

in - java.io.ObjectInputStream a - javax.swing.text.MutableAttributeSet

throws: java.lang.ClassNotFoundException

reclaim clj

(reclaim this a)

Returns a set no longer needed by the MutableAttributeSet implementation. This is useful for operation under 1.1 where there are no weak references. This would typically be called by the finalize method of the MutableAttributeSet implementation.

This method is thread safe, although most Swing methods are not. Please see Concurrency in Swing for more information.

a - the set to reclaim - javax.swing.text.AttributeSet

remove-attribute clj

(remove-attribute this old name)

Removes an attribute from the set.

This method is thread safe, although most Swing methods are not. Please see Concurrency in Swing for more information.

old - the old set of attributes - javax.swing.text.AttributeSet name - the non-null attribute name - java.lang.Object

returns: the updated attribute set - javax.swing.text.AttributeSet

remove-attributes clj

(remove-attributes this old names)

Removes a set of attributes for the element.

This method is thread safe, although most Swing methods are not. Please see Concurrency in Swing for more information.

old - the old attribute set - javax.swing.text.AttributeSet names - the attribute names - java.util.Enumeration

returns: the updated attribute set - javax.swing.text.AttributeSet

remove-change-listener clj

(remove-change-listener this l)

Removes a listener that was tracking styles being added or removed.

l - the change listener - javax.swing.event.ChangeListener

remove-style clj

(remove-style this nm)

Removes a named style previously added to the document.

nm - the name of the style to remove - java.lang.String

to-string clj

(to-string this)

Converts a StyleContext to a String.

returns: the string - java.lang.String

write-attributes clj

(write-attributes this out a)

Context-specific handling of writing out attributes

out - java.io.ObjectOutputStream a - javax.swing.text.AttributeSet

throws: java.io.IOException