com.offsetnull.bt.service.WindowToken Class Reference

Inheritance diagram for com.offsetnull.bt.service.WindowToken:

Collaboration diagram for com.offsetnull.bt.service.WindowToken:

Classes
enum	OPTION_KEY

Public Member Functions
	WindowToken ()
	WindowToken (final String name, final String scriptName, final String pluginName, final String displayHost)
	WindowToken (final Parcel p)
final WindowToken	copy ()
final void	setName (final String name)
final String	getName ()
final String	getDisplayHost ()
final void	setDisplayHost (final String str)
final int	describeContents ()
final void	writeToParcel (final Parcel p, final int arg1)
final void	setBuffer (final TextTree buffer)
final TextTree	getBuffer ()
final void	setBufferText (final boolean bufferText)
final boolean	isBufferText ()
final void	setScriptName (final String scriptName)
final String	getScriptName ()
final void	setPluginName (final String pluginName)
final String	getPluginName ()
final void	setId (final int id)
final int	getId ()
final HashMap < LayoutGroup.LAYOUT_TYPE, LayoutGroup >	getLayouts ()
final void	resetToDefaults ()
final LayoutParams	getLayout (final int size, final boolean landscape)
final SettingsGroup	getSettings ()
final void	setSettings (final SettingsGroup settings)
final void	setBufferSize (final int amount)
final void	importV1Settings (final HyperSettings s)

Static Public Attributes
static final int	DEFAULT_HYPERLINK_COLOR = 0xFF0000FF
static final int	DEFAULT_HYPERLINK_MODE = 3
static final int	DEFAULT_COLOR_MODE = 0
static final int	DEFAULT_FONT_SIZE = 18
static final int	DEFAULT_LINE_EXTRA = 3
static final int	DEFAULT_BUFFER_SIZE = 300
static final String	DEFAULT_FONT_PATH = "monospace"
static final Parcelable.Creator < WindowToken >	CREATOR

Detailed Description

The serializable data that constitutes a foreground miniwindow.

Constructor & Destructor Documentation

com.offsetnull.bt.service.WindowToken.WindowToken

(

)

Generic constructor.

Here is the caller graph for this function:

com.offsetnull.bt.service.WindowToken.WindowToken	(	final String	name,
		final String	scriptName,
		final String	pluginName,
		final String	displayHost
	)

A more functional constructor.

Parameters

name	The name of this window.
scriptName	The script body to execute (can be null).
pluginName	The plugin name that owns this window.
displayHost	The display name of the connection that owns this window.

com.offsetnull.bt.service.WindowToken.WindowToken

(

final Parcel

p

)

Parcellable constructor. Constructs from a parcel.

Parameters

p	The incoming parcel object.

Here is the call graph for this function:

Member Function Documentation

final WindowToken com.offsetnull.bt.service.WindowToken.copy

(

)

Shallow copy function.

Returns

A new WindowToken with the exact settings as this one.

Here is the call graph for this function:

Here is the caller graph for this function:

final int com.offsetnull.bt.service.WindowToken.describeContents

(

)

Required method for the Parcellable interface. I think this needs to return a unique random int.

Returns

The integer description for the contents of this parcel.

final TextTree com.offsetnull.bt.service.WindowToken.getBuffer

(

)

Getter for mBuffer.

Returns

mBuffer

Here is the caller graph for this function:

final String com.offsetnull.bt.service.WindowToken.getDisplayHost

(

)

Getter for mDisplayHost.

Returns

mDisplayHost

Here is the caller graph for this function:

final int com.offsetnull.bt.service.WindowToken.getId

(

)

Getter for mId.

Returns

mId

Here is the caller graph for this function:

final LayoutParams com.offsetnull.bt.service.WindowToken.getLayout	(	final int	size,
		final boolean	landscape
	)

Layout getter routine.

Parameters

size	The size value for the display.
landscape	True for landscape, false for portrait.

Returns

The layout paramter object to be used for the current layout.

final HashMap<LayoutGroup.LAYOUT_TYPE, LayoutGroup> com.offsetnull.bt.service.WindowToken.getLayouts

(

)

Getter for mLayouts.

Returns

mLayouts

Here is the caller graph for this function:

final String com.offsetnull.bt.service.WindowToken.getName

(

)

Getter for mName.

Returns

mName

Here is the caller graph for this function:

final String com.offsetnull.bt.service.WindowToken.getPluginName

(

)

Getter for mPluginName.

Returns

mPluginName

final String com.offsetnull.bt.service.WindowToken.getScriptName

(

)

Getter for mScriptName.

Returns

mScriptName

final SettingsGroup com.offsetnull.bt.service.WindowToken.getSettings

(

)

Getter for mSettings.

Returns

mSettings

Here is the caller graph for this function:

final void com.offsetnull.bt.service.WindowToken.importV1Settings

(

final HyperSettings

s

)

Utility method to absorb v1 window settings into this window.

Parameters

s	The old deprecated HyperSettings object to sniff for settings.

Here is the call graph for this function:

final boolean com.offsetnull.bt.service.WindowToken.isBufferText

(

)

Getter for mBufferText.

Returns

mBufferText

final void com.offsetnull.bt.service.WindowToken.resetToDefaults

(

)

Utility method to reset this window token to the default values.

Here is the caller graph for this function:

final void com.offsetnull.bt.service.WindowToken.setBuffer

(

final TextTree

buffer

)

Setter for mBuffer.

Parameters

buffer

The new buffer to use.

final void com.offsetnull.bt.service.WindowToken.setBufferSize

(

final int

amount

)

Utility method to set a new buffer size, prunes the tree after setting the value.

Parameters

amount

The new buffer size to use.

Here is the call graph for this function:

final void com.offsetnull.bt.service.WindowToken.setBufferText

(

final boolean

bufferText

)

Setter for mBufferText.

Parameters

bufferText

The new bufferText value.

Here is the caller graph for this function:

final void com.offsetnull.bt.service.WindowToken.setDisplayHost

(

final String

str

)

Setter for mDisplayHost.

Parameters

str	The display host name to use.

final void com.offsetnull.bt.service.WindowToken.setId

(

final int

id

)

Setter for mId.

Parameters

id	The new id value to use.

Here is the caller graph for this function:

final void com.offsetnull.bt.service.WindowToken.setName

(

final String

name

)

Setter for mName.

Parameters

name	The name to use.

Here is the caller graph for this function:

final void com.offsetnull.bt.service.WindowToken.setPluginName

(

final String

pluginName

)

Setter for mPluginName.

Parameters

pluginName

The new plugin owner name to use.

final void com.offsetnull.bt.service.WindowToken.setScriptName

(

final String

scriptName

)

Setter for mScriptName.

Parameters

scriptName

The new script name to execute on window initialization.

Here is the caller graph for this function:

final void com.offsetnull.bt.service.WindowToken.setSettings

(

final SettingsGroup

settings

)

Setter for mSettings.

Parameters

settings

The new settings group to use for this window's settings.

Here is the caller graph for this function:

final void com.offsetnull.bt.service.WindowToken.writeToParcel	(	final Parcel	p,
		final int	arg1
	)

Implementation of the Parcelable writeToParcel method.

Parameters

p	The parcel to write to.
arg1	The flags for the operation.

Here is the call graph for this function:

Member Data Documentation

final Parcelable.Creator<WindowToken> com.offsetnull.bt.service.WindowToken.CREATOR

static

Initial value:

= new Parcelable.Creator<WindowToken>() {

      public WindowToken createFromParcel(final Parcel arg0) {
         return new WindowToken(arg0);
      }

      public WindowToken[] newArray(final int arg0) {
         return new WindowToken[arg0];
      }
   }

Required field for the parcelable interface.

final int com.offsetnull.bt.service.WindowToken.DEFAULT_BUFFER_SIZE = 300

static

Default buffer size.

final int com.offsetnull.bt.service.WindowToken.DEFAULT_COLOR_MODE = 0

static

Default colorizing mode.

final String com.offsetnull.bt.service.WindowToken.DEFAULT_FONT_PATH = "monospace"

static

Default font path.

final int com.offsetnull.bt.service.WindowToken.DEFAULT_FONT_SIZE = 18

static

Default font size.

final int com.offsetnull.bt.service.WindowToken.DEFAULT_HYPERLINK_COLOR = 0xFF0000FF

static

Default hyperlink color.

final int com.offsetnull.bt.service.WindowToken.DEFAULT_HYPERLINK_MODE = 3

static

Default hyperlink mode.

final int com.offsetnull.bt.service.WindowToken.DEFAULT_LINE_EXTRA = 3

static

Default line spacing extra size.

---

The documentation for this class was generated from the following file:

• /Users/render/apps/BlowTorch/BTLib/src/com/offsetnull/bt/service/WindowToken.java